Menu
▾
▴
gtk2hs-commit — Mailing list for Darcs commit messages.
You can subscribe to this list here.
| 2003 |
Jan
|
Feb
|
Mar
|
Apr
|
May
(4) |
Jun
|
Jul
(68) |
Aug
(4) |
Sep
|
Oct
(23) |
Nov
(95) |
Dec
(9) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2004 |
Jan
(3) |
Feb
|
Mar
|
Apr
(51) |
May
(81) |
Jun
(2) |
Jul
(86) |
Aug
(143) |
Sep
(3) |
Oct
(31) |
Nov
(63) |
Dec
(90) |
| 2005 |
Jan
(277) |
Feb
(157) |
Mar
(99) |
Apr
(195) |
May
(151) |
Jun
(148) |
Jul
(98) |
Aug
(123) |
Sep
(20) |
Oct
(174) |
Nov
(155) |
Dec
(26) |
| 2006 |
Jan
(51) |
Feb
(19) |
Mar
(16) |
Apr
(12) |
May
(5) |
Jun
|
Jul
(11) |
Aug
(7) |
Sep
(10) |
Oct
(31) |
Nov
(174) |
Dec
(56) |
| 2007 |
Jan
(45) |
Feb
(52) |
Mar
(10) |
Apr
(5) |
May
(47) |
Jun
(16) |
Jul
(80) |
Aug
(29) |
Sep
(14) |
Oct
(59) |
Nov
(46) |
Dec
(16) |
| 2008 |
Jan
(10) |
Feb
(1) |
Mar
|
Apr
|
May
(49) |
Jun
(26) |
Jul
(8) |
Aug
(4) |
Sep
(25) |
Oct
(53) |
Nov
(9) |
Dec
(1) |
| 2009 |
Jan
(66) |
Feb
(11) |
Mar
(1) |
Apr
(14) |
May
(8) |
Jun
(1) |
Jul
(2) |
Aug
(2) |
Sep
(9) |
Oct
(23) |
Nov
(35) |
Dec
|
| 2010 |
Jan
(7) |
Feb
(2) |
Mar
(39) |
Apr
(19) |
May
(161) |
Jun
(19) |
Jul
(32) |
Aug
(65) |
Sep
(113) |
Oct
(120) |
Nov
(2) |
Dec
|
| 2012 |
Jan
|
Feb
(5) |
Mar
(4) |
Apr
(7) |
May
(9) |
Jun
(14) |
Jul
(1) |
Aug
|
Sep
(1) |
Oct
(1) |
Nov
(12) |
Dec
(2) |
| 2013 |
Jan
(1) |
Feb
(17) |
Mar
(4) |
Apr
(4) |
May
(9) |
Jun
|
Jul
(8) |
Aug
|
Sep
(2) |
Oct
|
Nov
|
Dec
|
|
From: Duncan C. <dun...@us...> - 2005-02-26 02:03:18
|
Update of /cvsroot/gtk2hs/gtk2hs/mk In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1449/mk Modified Files: chsDepend.in Log Message: Signal.chs-boot1: add #hide Haddock annotation so the Signal module will not appear in the generated docs. Makefile.am: It is useful to have a seperate variable holding the files that are generated from nothing using code generators so define a GENERATEDSOURCES variable for each package and re-define some other variables in terms of that. We use it to define nodist_*_SOURCES and html_HSFILES_HIDDEN for each package (since all the generated files are hidden). Instead of having each packages .dep files depending on all of the packages .chs file (which causes lots of unnecessary invocations of chsDepend) make them just depend on the .chs files that might not exist which are the ones produced by code generators. So make them depend on the GENERATEDSOURCES files. chsDepend.in: since we no longer make the .dep files depend on every .chs file in sight, the .chs file (produced from the .chs.pp file) might not exist when the .dep file is generated so look for .chs.pp files as well as .chs file when calculating the deps. This is possibly a bit of a hack. Index: chsDepend.in =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/mk/chsDepend.in,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- chsDepend.in 16 Jan 2005 21:25:57 -0000 1.13 +++ chsDepend.in 26 Feb 2005 02:03:04 -0000 1.14 @@ -33,7 +33,7 @@ for DEPDIR in $SEARCHPATH; do DEPNAME=`echo "$DEPDIR/$DEP" | $SED 's%\.//*%%'`; #echo Looking for $DEP in $DEPDIR , i.e.: $DEPNAME - if test -f "$DEPNAME.chs"; then + if test -f "$DEPNAME.chs" -o -f "$DEPNAME.chs.pp"; then #echo Found $DEP in $DEPDIR DEPNAMES="$DEPNAMES $DEPNAME.chi"; FOUND=yes; |
|
From: Duncan C. <dun...@us...> - 2005-02-26 02:03:18
|
Update of /cvsroot/gtk2hs/gtk2hs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1449 Modified Files: ChangeLog Makefile.am Log Message: Signal.chs-boot1: add #hide Haddock annotation so the Signal module will not appear in the generated docs. Makefile.am: It is useful to have a seperate variable holding the files that are generated from nothing using code generators so define a GENERATEDSOURCES variable for each package and re-define some other variables in terms of that. We use it to define nodist_*_SOURCES and html_HSFILES_HIDDEN for each package (since all the generated files are hidden). Instead of having each packages .dep files depending on all of the packages .chs file (which causes lots of unnecessary invocations of chsDepend) make them just depend on the .chs files that might not exist which are the ones produced by code generators. So make them depend on the GENERATEDSOURCES files. chsDepend.in: since we no longer make the .dep files depend on every .chs file in sight, the .chs file (produced from the .chs.pp file) might not exist when the .dep file is generated so look for .chs.pp files as well as .chs file when calculating the deps. This is possibly a bit of a hack. Index: Makefile.am =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/Makefile.am,v retrieving revision 1.52 retrieving revision 1.53 diff -u -d -r1.52 -r1.53 --- Makefile.am 25 Feb 2005 01:20:17 -0000 1.52 +++ Makefile.am 26 Feb 2005 02:03:03 -0000 1.53 @@ -271,7 +271,6 @@ DISTCLEANFILES+= glib/libHSglib_a.deps $(libHSglib_a_CHSFILES_HS:.hs=.dep) -$(libHSglib_a_CHSFILES:.chs=.dep) : $(libHSglib_a_CHSFILES) -include $(libHSglib_a_CHSFILES:.chs=.dep) glib/libHSglib_a.deps # @@ -293,10 +292,12 @@ libHSgtk_a_SOURCESDIRS = $(libHSglib_a_SOURCESDIRS) gtk gtk/libHSgtk_a.deps : glib/libHSglib_a.deps -nodist_libHSgtk_a_SOURCES = \ +libHSgtk_a_GENERATEDSOURCES = \ gtk/Graphics/UI/Gtk/Types.chs \ gtk/Graphics/UI/Gtk/Signals.chs +nodist_libHSgtk_a_SOURCES = $(libHSgtk_a_GENERATEDSOURCES) + libHSgtk_a_SOURCES = \ gtk/Graphics/UI/Gtk.hs \ gtk/Graphics/UI/Gtk/Pango/Types.chs.pp \ @@ -430,7 +431,7 @@ gtk/Graphics/UI/Gtk/Embedding/Embedding.hsc html_HSFILES_PREPROC = gtk/Graphics/UI/Gtk.hs -html_HSFILES_HIDDEN = gtk/Graphics/UI/Gtk/Types.hs +html_HSFILES_HIDDEN = $(libHSgtk_a_GENERATEDSOURCES:.chs=.hs) gtk_Graphics_UI_Gtk_hs_HCFLAGS = -fno-warn-duplicate-exports #FIXME gtk_Graphics_UI_Gtk_Gdk_Enums_hs_HCFLAGS = -fglasgow-exts @@ -488,8 +489,7 @@ $(libHSgtk_a_CHSPPFILES:.chs.pp=.chs) \ $(libHSgtk_a_CHSFILES_HS) \ $(libHSgtk_a_HSCFILES_HS) \ - gtk/Graphics/UI/Gtk/Types.chs \ - gtk/Graphics/UI/Gtk/Signals.chs + $(libHSgtk_a_GENERATEDSOURCES) libHSgtk_a_HSFILES = \ $(filter %.hs,$(libHSgtk_a_BUILDSOURCES)) \ $(filter %.hs,$(libHSgtk_a_ALLSOURCES)) @@ -507,7 +507,7 @@ DISTCLEANFILES+= gtk/libHSgtk_a.deps $(libHSgtk_a_CHSFILES_HS:.hs=.dep) -$(libHSgtk_a_CHSFILES:.chs=.dep) : $(libHSglib_a_CHSFILES) $(libHSgtk_a_CHSFILES) +$(libHSgtk_a_CHSFILES:.chs=.dep) : $(libHSgtk_a_GENERATEDSOURCES) -include $(libHSgtk_a_CHSFILES_HS:.hs=.dep) gtk/libHSgtk_a.deps # @@ -575,13 +575,15 @@ libHSglade_a_SOURCESDIRS = $(libHSgtk_a_SOURCESDIRS) glade glade/libHSglade_a.deps : gtk/libHSgtk_a.deps -nodist_libHSglade_a_SOURCES = \ +libHSglade_a_GENERATEDSOURCES = \ glade/Graphics/UI/Gtk/Glade/Types.chs +nodist_libHSglade_a_SOURCES = $(libHSglade_a_GENERATEDSOURCES) + libHSglade_a_SOURCES = \ glade/Graphics/UI/Gtk/Glade.chs -html_HSFILES_HIDDEN += glade/Graphics/UI/Gtk/Glade/Types.hs +html_HSFILES_HIDDEN += $(libHSglade_a_GENERATEDSOURCES:.chs=.hs) glade_Graphics_UI_Gtk_Glade_Types_hs_HCFLAGS = -fglasgow-exts @@ -610,7 +612,7 @@ $(libHSglade_a_CHSPPFILES:.chs.pp=.chs) \ $(libHSglade_a_CHSFILES_HS) \ $(libHSglade_a_HSCFILES_HS) \ - glade/Graphics/UI/Gtk/Glade/Types.chs + $(libHSglade_a_GENERATEDSOURCES) libHSglade_a_HSFILES = \ $(filter %.hs,$(libHSglade_a_BUILDSOURCES)) \ $(filter %.hs,$(libHSglade_a_ALLSOURCES)) @@ -624,7 +626,9 @@ DISTCLEANFILES+= glade/libHSglade_a.deps $(libHSglade_a_CHSFILES_HS:.hs=.dep) -$(libHSglade_a_CHSFILES:.chs=.dep) : $(libHSglib_a_CHSFILES) $(libHSgtk_a_CHSFILES) $(libHSglade_a_CHSFILES) +$(libHSglade_a_CHSFILES:.chs=.dep) : \ + $(libHSgtk_a_GENERATEDSOURCES) \ + $(libHSglade_a_GENERATEDSOURCES) -include $(libHSglade_a_CHSFILES:.chs=.dep) glade/libHSglade_a.deps endif #ENABLE_LIBGLADE @@ -650,15 +654,17 @@ libHSgconf_a_SOURCESDIRS = $(libHSgtk_a_SOURCESDIRS) gconf gconf/libHSgconf_a.deps : gtk/libHSgtk_a.deps -nodist_libHSgconf_a_SOURCES = \ +libHSgconf_a_GENERATEDSOURCES = \ gconf/System/Gnome/GConf/Types.chs +nodist_libHSgconf_a_SOURCES = $(libHSgconf_a_GENERATEDSOURCES) + libHSgconf_a_SOURCES = \ gconf/System/Gnome/GConf/GConfValue.chs \ gconf/System/Gnome/GConf/GConfClient.chs \ gconf/System/Gnome/GConf.hs -html_HSFILES_HIDDEN += gconf/System/Gnome/GConf/Types.hs +html_HSFILES_HIDDEN += $(libHSgconf_a_GENERATEDSOURCES:.chs=.hs) libHSgconf_a_LIBADD = \ gconf/System/Gnome/GConf/GConfClient_stub.o @@ -688,7 +694,7 @@ $(libHSgconf_a_CHSPPFILES:.chs.pp=.chs) \ $(libHSgconf_a_CHSFILES_HS) \ $(libHSgconf_a_HSCFILES_HS) \ - gconf/System/Gnome/GConf/Types.chs + $(libHSgconf_a_GENERATEDSOURCES) libHSgconf_a_HSFILES = \ $(filter %.hs,$(libHSgconf_a_BUILDSOURCES)) \ $(filter %.hs,$(libHSgconf_a_ALLSOURCES)) @@ -706,7 +712,9 @@ DISTCLEANFILES+= gconf/libHSgconf_a.deps $(libHSgconf_a_CHSFILES_HS:.hs=.dep) -$(libHSgconf_a_CHSFILES:.chs=.dep) : $(libHSglib_a_CHSFILES) $(libHSgtk_a_CHSFILES) $(libHSgconf_a_CHSFILES) +$(libHSgconf_a_CHSFILES:.chs=.dep) : \ + $(libHSgtk_a_GENERATEDSOURCES) \ + $(libHSgconf_a_GENERATEDSOURCES) -include $(libHSgconf_a_CHSFILES:.chs=.dep) gconf/libHSgconf_a.deps endif #ENABLE_GNOME @@ -732,9 +740,11 @@ libHSsourceview_a_SOURCESDIRS = $(libHSgtk_a_SOURCESDIRS) sourceview sourceview/libHSsourceview_a.deps : gtk/libHSgtk_a.deps -nodist_libHSsourceview_a_SOURCES = \ +libHSsourceview_a_GENERATEDSOURCES = \ sourceview/Graphics/UI/Gtk/SourceView/Types.chs +nodist_libHSsourceview_a_SOURCES = $(libHSsourceview_a_GENERATEDSOURCES) + libHSsourceview_a_SOURCES = \ sourceview/Graphics/UI/Gtk/SourceView.hs \ sourceview/Graphics/UI/Gtk/SourceView/SourceBuffer.chs \ @@ -748,7 +758,7 @@ sourceview/Graphics/UI/Gtk/SourceView/SourceTagTable.chs \ sourceview/Graphics/UI/Gtk/SourceView/SourceView.chs -html_HSFILES_HIDDEN += sourceview/Graphics/UI/Gtk/SourceView/Types.hs +html_HSFILES_HIDDEN += $(libHSsourceview_a_GENERATEDSOURCES:.chs=.hs) sourceview_Graphics_UI_Gtk_SourceView_Types_hs_HCFLAGS = -fglasgow-exts sourceview_Graphics_UI_Gtk_SourceView_SourceTagStyle_hs_HCFLAGS = -fglasgow-exts @@ -778,7 +788,7 @@ $(libHSsourceview_a_CHSPPFILES:.chs.pp=.chs) \ $(libHSsourceview_a_CHSFILES_HS) \ $(libHSsourceview_a_HSCFILES_HS) \ - sourceview/Graphics/UI/Gtk/SourceView/Types.chs + $(libHSsourceview_a_GENERATEDSOURCES) libHSsourceview_a_HSFILES = \ $(filter %.hs,$(libHSsourceview_a_BUILDSOURCES)) \ $(filter %.hs,$(libHSsourceview_a_ALLSOURCES)) @@ -792,7 +802,9 @@ DISTCLEANFILES+= sourceview/libHSsourceview_a.deps $(libHSsourceview_a_CHSFILES_HS:.hs=.dep) -$(libHSsourceview_a_CHSFILES:.chs=.dep) : $(libHSglib_a_CHSFILES) $(libHSgtk_a_CHSFILES) $(libHSsourceview_a_CHSFILES) +$(libHSsourceview_a_CHSFILES:.chs=.dep) : \ + $(libHSgtk_a_GENERATEDSOURCES) \ + $(libHSsourceview_a_GENERATEDSOURCES) -include $(libHSsourceview_a_CHSFILES:.chs=.dep) sourceview/libHSsourceview_a.deps endif #ENABLE_GNOME @@ -818,13 +830,15 @@ libHSmozembed_a_SOURCESDIRS = $(libHSgtk_a_SOURCESDIRS) mozembed mozembed/libHSmozembed_a.deps : gtk/libHSgtk_a.deps -nodist_libHSmozembed_a_SOURCES = \ +libHSmozembed_a_GENERATEDSOURCES = \ mozembed/Graphics/UI/Gtk/MozEmbed/Types.chs +nodist_libHSmozembed_a_SOURCES = $(libHSmozembed_a_GENERATEDSOURCES) + libHSmozembed_a_SOURCES = \ mozembed/Graphics/UI/Gtk/MozEmbed.chs -html_HSFILES_HIDDEN += mozembed/Graphics/UI/Gtk/MozEmbed/Types.hs +html_HSFILES_HIDDEN += $(libHSmozembed_a_GENERATEDSOURCES:.chs=.hs) mozembed_Graphics_UI_Gtk_MozEmbed_Types_hs_HCFLAGS = -fglasgow-exts @@ -852,7 +866,7 @@ $(libHSmozembed_a_CHSPPFILES:.chs.pp=.chs) \ $(libHSmozembed_a_CHSFILES_HS) \ $(libHSmozembed_a_HSCFILES_HS) \ - mozembed/Graphics/UI/Gtk/MozEmbed/Types.chs + $(libHSmozembed_a_GENERATEDSOURCES) libHSmozembed_a_HSFILES = \ $(filter %.hs,$(libHSmozembed_a_BUILDSOURCES)) \ $(filter %.hs,$(libHSmozembed_a_ALLSOURCES)) @@ -866,7 +880,9 @@ DISTCLEANFILES+= mozembed/libHSmozembed_a.deps $(libHSmozembed_a_CHSFILES_HS:.hs=.dep) -$(libHSmozembed_a_CHSFILES:.chs=.dep) : $(libHSglib_a_CHSFILES) $(libHSgtk_a_CHSFILES) $(libHSmozembed_a_CHSFILES) +$(libHSmozembed_a_CHSFILES:.chs=.dep) : \ + $(libHSgtk_a_GENERATEDSOURCES) \ + $(libHSmozembed_a_GENERATEDSOURCES) -include $(libHSmozembed_a_CHSFILES:.chs=.dep) mozembed/libHSmozembed_a.deps endif #ENABLE_MOZEMBED Index: ChangeLog =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v retrieving revision 1.369 retrieving revision 1.370 diff -u -d -r1.369 -r1.370 --- ChangeLog 25 Feb 2005 22:53:40 -0000 1.369 +++ ChangeLog 26 Feb 2005 02:02:54 -0000 1.370 @@ -1,3 +1,26 @@ +2005-02-26 Duncan Coutts <du...@co...> + + * tools/callbackGen/Signal.chs-boot1: add #hide Haddock annotation so + the Signal module will not appear in the generated docs. + + * Makefile.am: It is useful to have a seperate variable holding the + files that are generated from nothing using code generators so define + a GENERATEDSOURCES variable for each package and re-define some other + variables in terms of that. We use it to define + nodist_*_SOURCES and html_HSFILES_HIDDEN for each package (since all + the generated files are hidden). + Instead of having each packages .dep files depending on all of the + packages .chs file (which causes lots of unnecessary invocations of + chsDepend) make them just depend on the .chs files that might not + exist which are the ones produced by code generators. So make them + depend on the GENERATEDSOURCES files. + + * mk/chsDepend.in: since we no longer make the .dep files depend on + every .chs file in sight, the .chs file (produced from the .chs.pp + file) might not exist when the .dep file is generated so look for + .chs.pp files as well as .chs file when calculating the deps. This is + possibly a bit of a hack. + 2005-02-25 Duncan Coutts <du...@co...> * gtk/Graphics/UI/Gtk/Abstract/Bin.chs, |
|
From: Duncan C. <dun...@us...> - 2005-02-26 02:03:18
|
Update of /cvsroot/gtk2hs/gtk2hs/tools/callbackGen In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1449/tools/callbackGen Modified Files: Signal.chs-boot1 Log Message: Signal.chs-boot1: add #hide Haddock annotation so the Signal module will not appear in the generated docs. Makefile.am: It is useful to have a seperate variable holding the files that are generated from nothing using code generators so define a GENERATEDSOURCES variable for each package and re-define some other variables in terms of that. We use it to define nodist_*_SOURCES and html_HSFILES_HIDDEN for each package (since all the generated files are hidden). Instead of having each packages .dep files depending on all of the packages .chs file (which causes lots of unnecessary invocations of chsDepend) make them just depend on the .chs files that might not exist which are the ones produced by code generators. So make them depend on the GENERATEDSOURCES files. chsDepend.in: since we no longer make the .dep files depend on every .chs file in sight, the .chs file (produced from the .chs.pp file) might not exist when the .dep file is generated so look for .chs.pp files as well as .chs file when calculating the deps. This is possibly a bit of a hack. Index: Signal.chs-boot1 =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/tools/callbackGen/Signal.chs-boot1,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Signal.chs-boot1 8 Jan 2005 17:27:26 -0000 1.3 +++ Signal.chs-boot1 26 Feb 2005 02:03:04 -0000 1.4 @@ -21,6 +21,8 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -- GNU General Public License for more details. -- +-- #hide + -- | -- These functions are used to connect signals to widgets. They are auto- -- matically created through HookGenerator.hs which takes a list of possible |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:54:26
|
Update of /cvsroot/gtk2hs/gtk2hs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239 Modified Files: ChangeLog Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: ChangeLog =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v retrieving revision 1.368 retrieving revision 1.369 diff -u -d -r1.368 -r1.369 --- ChangeLog 25 Feb 2005 01:32:10 -0000 1.368 +++ ChangeLog 25 Feb 2005 22:53:40 -0000 1.369 @@ -145,6 +145,57 @@ * tools/apiGen/Makefile: add MarshalFixup.hs dep. + * gtk/Graphics/UI/Gtk/Abstract/Bin.chs, + gtk/Graphics/UI/Gtk/Abstract/Box.chs, + gtk/Graphics/UI/Gtk/Abstract/ButtonBox.chs.pp, + gtk/Graphics/UI/Gtk/Abstract/Misc.chs, + gtk/Graphics/UI/Gtk/Display/Label.chs, + gtk/Graphics/UI/Gtk/General/Style.chs, + gtk/Graphics/UI/Gtk/Layout/Expander.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/CheckMenuItem.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/ComboBox.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/ComboBoxEntry.chs.pp, + gtk/Graphics/UI/Gtk/Misc/DrawingArea.chs, + gtk/Graphics/UI/Gtk/Misc/SizeGroup.chs, + gtk/Graphics/UI/Gtk/Multiline/TextView.chs, + gtk/Graphics/UI/Gtk/TreeList/TreeStore.chs.pp: trivial white space + changes to better match the generated code. + + * gtk/Graphics/UI/Gtk/Abstract/Container.chs, + gtk/Graphics/UI/Gtk/Abstract/Paned.chs.pp, + gtk/Graphics/UI/Gtk/Abstract/Range.chs, + gtk/Graphics/UI/Gtk/Abstract/Scale.chs, + gtk/Graphics/UI/Gtk/Abstract/Widget.chs, + gtk/Graphics/UI/Gtk/Display/ProgressBar.chs, + gtk/Graphics/UI/Gtk/Entry/Editable.chs.pp, + gtk/Graphics/UI/Gtk/Entry/EntryCompletion.chs.pp, + gtk/Graphics/UI/Gtk/Layout/Fixed.chs, + gtk/Graphics/UI/Gtk/MenuComboToolbar/Combo.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/MenuItem.chs, + gtk/Graphics/UI/Gtk/Multiline/TextBuffer.chs, + gtk/Graphics/UI/Gtk/Multiline/TextTag.chs.pp, + gtk/Graphics/UI/Gtk/Selectors/ColorSelection.chs, + gtk/Graphics/UI/Gtk/Selectors/FileChooser.chs.pp, + gtk/Graphics/UI/Gtk/Selectors/FileChooserDialog.chs.pp, + gtk/Graphics/UI/Gtk/Selectors/FileChooserWidget.chs.pp, + gtk/Graphics/UI/Gtk/TreeList/CellRendererText.chs, + gtk/Graphics/UI/Gtk/TreeList/TreeModel.chs.pp, + gtk/Graphics/UI/Gtk/TreeList/TreeView.chs.pp, + gtk/Graphics/UI/Gtk/TreeList/TreeViewColumn.chs.pp: minor + documentation changes + + * gtk/Graphics/UI/Gtk/Entry/Entry.chs.pp, + gtk/Graphics/UI/Gtk/Entry/SpinButton.chs, + gtk/Graphics/UI/Gtk/Scrolling/ScrolledWindow.chs: other trivial + changes to better match the generated code. + + * gtk/Graphics/UI/Gtk/TreeList/TreeModelSort.chs.pp: since + GtkTreeModelSort implementes the GtkTreeModel interface, make + TreeModelSort an instance of TreeModelClass. + + * gtk/Graphics/UI/Gtk/MenuComboToolbar/ImageMenuItem.chs: relicense to + LGPL with permission of Jonas Svensson. + 2005-02-24 Duncan Coutts <du...@co...> * configure.ac: Bump version to 0.9.7.1 |
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/TreeList Modified Files: TreeStore.chs.pp CellRendererText.chs TreeModel.chs.pp TreeView.chs.pp TreeViewColumn.chs.pp TreeModelSort.chs.pp Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: TreeStore.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeStore.chs.pp,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- TreeStore.chs.pp 25 Feb 2005 01:11:37 -0000 1.4 +++ TreeStore.chs.pp 25 Feb 2005 22:53:42 -0000 1.5 @@ -25,7 +25,7 @@ -- Portability : portable (depends on GHC) -- -- A tree-like data structure that can be used with the 'TreeView' --- +-- module Graphics.UI.Gtk.TreeList.TreeStore ( -- * Description -- Index: CellRendererText.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/CellRendererText.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- CellRendererText.chs 25 Feb 2005 01:11:37 -0000 1.3 +++ CellRendererText.chs 25 Feb 2005 22:53:42 -0000 1.4 @@ -26,12 +26,13 @@ -- -- A 'CellRenderer' which displays a single-line text. -- --- * This widget derives from 'CellRenderer'. It provides the --- possibility to display some text by setting the 'Attribute' --- 'cellText' to the column of a 'TreeModel' by means of --- 'treeViewAddAttribute' from 'TreeModelColumn'. --- module Graphics.UI.Gtk.TreeList.CellRendererText ( +-- * Description +-- +-- | This widget derives from 'CellRenderer'. It provides the +-- possibility to display some text by setting the 'Attribute' +-- 'cellText' to the column of a 'TreeModel' by means of +-- 'treeViewAddAttribute' from 'TreeModelColumn'. -- * Class Hierarchy -- | Index: TreeViewColumn.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeViewColumn.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- TreeViewColumn.chs.pp 25 Feb 2005 01:11:37 -0000 1.2 +++ TreeViewColumn.chs.pp 25 Feb 2005 22:53:42 -0000 1.3 @@ -19,26 +19,30 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- --- | --- Maintainer : gtk...@li... --- Stability : provisional --- Portability : portable (depends on GHC) +-- NOTES -- --- * tree_view_column_new_with_attributes and tree_view_column_set_attributes +-- tree_view_column_new_with_attributes and tree_view_column_set_attributes -- are variadic and the funcitonality can be achieved through other -- functions. -- --- * tree_view_column_set_cell_data and tree_view_column_cell_get_size are not +-- tree_view_column_set_cell_data and tree_view_column_cell_get_size are not -- bound because I am not sure what they do and when they are useful -- -- TODO -- --- * treeViewColumnSetCellData is not bound. With this function the user has +-- treeViewColumnSetCellData is not bound. With this function the user has -- control over how data in the store is mapped to the attributes of a -- cell renderer. This functin should be bound in the future to allow the -- user to insert Haskell data types into the store and convert these -- values to attributes of cell renderers. -- +-- | +-- Maintainer : gtk...@li... +-- Stability : provisional +-- Portability : portable (depends on GHC) +-- +-- A visible column in a 'TreeView' widget +-- module Graphics.UI.Gtk.TreeList.TreeViewColumn ( -- * Description -- @@ -124,8 +128,6 @@ {# context lib="gtk" prefix="gtk" #} --- TreeViewColumn type declaration - -------------------- -- Constructors Index: TreeModelSort.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeModelSort.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- TreeModelSort.chs.pp 25 Feb 2005 01:11:37 -0000 1.2 +++ TreeModelSort.chs.pp 25 Feb 2005 22:53:42 -0000 1.3 @@ -75,6 +75,11 @@ {# context lib="gtk" prefix="gtk" #} -------------------- +-- Interfaces + +instance TreeModelClass TreeModelSort + +-------------------- -- Constructors -- | Creates a new 'TreeModelSort', that will be a sorted view of the given Index: TreeView.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeView.chs.pp,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- TreeView.chs.pp 25 Feb 2005 01:11:37 -0000 1.5 +++ TreeView.chs.pp 25 Feb 2005 22:53:42 -0000 1.6 @@ -54,16 +54,17 @@ -- -- A widget for displaying both trees and lists. -- --- Widget that displays any object that implements the GtkTreeModel +module Graphics.UI.Gtk.TreeList.TreeView ( +-- * Description +-- +-- | Widget that displays any object that implements the 'TreeModel' -- interface. -- --- * The widget supports scrolling natively. This implies that pixel --- coordinates can be given in two formats: relative to the current view's --- upper left corner or relative to the whole list's coordinates. The former --- are called widget coordinates while the letter are called tree --- coordinates. --- -module Graphics.UI.Gtk.TreeList.TreeView ( +-- The widget supports scrolling natively. This implies that pixel +-- coordinates can be given in two formats: relative to the current view's +-- upper left corner or relative to the whole list's coordinates. The former +-- are called widget coordinates while the letter are called tree +-- coordinates. -- * Class Hierarchy -- | Index: TreeModel.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/TreeList/TreeModel.chs.pp,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- TreeModel.chs.pp 25 Feb 2005 01:11:37 -0000 1.5 +++ TreeModel.chs.pp 25 Feb 2005 22:53:42 -0000 1.6 @@ -24,14 +24,14 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- The tree interface used by "TreeView" +-- The tree interface used by 'TreeView' -- module Graphics.UI.Gtk.TreeList.TreeModel ( -- * Description -- --- | The "TreeModel" interface defines a generic storage object for use by the --- "TreeView" widget. It is purely abstract, concrete implementations that --- store data for a list or tree widget are e.g. "ListStore" and "TreeStore". +-- | The 'TreeModel' interface defines a generic storage object for use by the +-- 'TreeView' widget. It is purely abstract, concrete implementations that +-- store data for a list or tree widget are e.g. 'ListStore' and 'TreeStore'. -- -- 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 @@ -43,44 +43,44 @@ -- The implementation of each individual model decides how and if changes are -- made. -- --- Two generic models are provided that implement the "TreeModel" interface: +-- Two generic models are provided that implement the 'TreeModel' interface: -- the --- "TreeStore" and the "ListStore". To use these, the developer simply pushes +-- 'TreeStore' and the 'ListStore'. To use these, the developer simply pushes -- data into these models as necessary. These models provide the data --- structure as well as the "TreeModel" interface. In fact, they implement +-- structure as well as the 'TreeModel' interface. In fact, they implement -- other interfaces making drag --- and drop, sorting, and storing data trivial. +-- and drop, sorting, and storing data trivial. -- -- 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. There are two structures used to reference a particular node in a --- model. They are the "TreePath" and the "TreeIter" Most of the interface --- consists of operations on a "TreeIter". +-- model. They are the 'TreePath' and the 'TreeIter' Most of the interface +-- consists of operations on a 'TreeIter'. -- -- 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 --- "TreePath" is in fact just a list of "Int"s and hence are easy to +-- 'TreePath' is in fact just a list of 'Int's and hence are easy to -- manipulate. 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. -- --- By contrast, a "TreeIter" is a reference to a specific node on a specific +-- By contrast, a 'TreeIter' is a reference to a specific node on a specific -- model. It is an abstract data type filled in by the model. One can convert a -- path to an iterator by calling 'treeModelGetIter'. These iterators are the -- primary way of accessing a model and are similar to the iterators used by --- "TextBuffer". The model interface defines a set of operations using +-- 'TextBuffer'. The model interface defines a set of operations using -- them for navigating the model. -- -- The lifecycle of an iterator can be a little confusing at first. -- Iterators are expected to always be valid for as long as the model is -- unchanged (and doesn't emit a signal). --- Additionally, the "TreeStore" and "ListStore" models guarantee that +-- Additionally, the 'TreeStore' and 'ListStore' models guarantee that -- an iterator is valid for as long as the node it refers to is valid. -- Although generally uninteresting, as one -- always has to allow for the case where iterators do not persist beyond a -- signal, some very important performance enhancements were made in the sort --- model. As a result, the \"TreeModelItersPersist\" flag was added to --- indicate this behavior. +-- model. As a result, the 'TreeModelItersPersist' flag was added to indicate +-- this behavior. -- -- * Class Hierarchy |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:53:54
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Selectors In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/Selectors Modified Files: ColorSelection.chs FileChooser.chs.pp FileChooserDialog.chs.pp FileChooserWidget.chs.pp Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: ColorSelection.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Selectors/ColorSelection.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- ColorSelection.chs 25 Feb 2005 01:11:37 -0000 1.3 +++ ColorSelection.chs 25 Feb 2005 22:53:42 -0000 1.4 @@ -24,10 +24,7 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- The ColorSelection is a widget that is used to select a color. It consists of --- a color wheel and number of sliders and entry boxes for color parameters such --- as hue, saturation, value, red, green, blue, and opacity. It is found on the --- standard color selection dialog box "ColorSelectionDialog". +-- A widget used to select a color. -- module Graphics.UI.Gtk.Selectors.ColorSelection ( -- * Description Index: FileChooserDialog.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Selectors/FileChooserDialog.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- FileChooserDialog.chs.pp 25 Feb 2005 01:11:37 -0000 1.3 +++ FileChooserDialog.chs.pp 25 Feb 2005 22:53:42 -0000 1.4 @@ -28,7 +28,7 @@ -- for the old "FileSel"ection dialog. It provides a better user -- interface and an improved API. -- --- * This is the dialog variant of the "FileChooser" +-- * This is the dialog variant of the 'FileChooser' -- -- * Added in GTK+ 2.4 -- @@ -93,12 +93,16 @@ import System.Glib.GValue import System.Glib.StoreValue -{# context lib="gtk" prefix ="gtk" #} +{# context lib="gtk" prefix="gtk" #} + +-------------------- +-- Interfaces --- The FileChooserDialog implements the FileChooser interface --- which we model in Haskell as another instance decleration instance FileChooserClass FileChooserDialog +-------------------- +-- Constructors + fileChooserDialogNew :: Maybe String -- ^ Title of the dialog (or default) -> Maybe Window -- ^ Transient parent of the dialog (or none) @@ -108,7 +112,6 @@ fileChooserDialogNew title parent action buttons = internalFileChooserDialogNew title parent action buttons Nothing - fileChooserDialogNewWithBackend :: Maybe String -- ^ Title of the dialog (or default) -> Maybe Window -- ^ Transient parent of the dialog (or none) Index: FileChooser.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Selectors/FileChooser.chs.pp,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- FileChooser.chs.pp 25 Feb 2005 01:11:37 -0000 1.4 +++ FileChooser.chs.pp 25 Feb 2005 22:53:42 -0000 1.5 @@ -25,11 +25,11 @@ -- Portability : portable (depends on GHC) -- -- The file chooser dialog and widget is a replacement --- for the old "FileSel"ection dialog. It provides a better user +-- for the old 'FileSel'ection dialog. It provides a better user -- interface and an improved API. -- -- The FileChooser (as opposed to the dialog or widget) is the interface that --- the "FileChooserDialog" and "FileChooserWidget" implement, all the operations +-- the 'FileChooserDialog' and 'FileChooserWidget' implement, all the operations -- except construction are on this interface. -- -- * Added in GTK+ 2.4 @@ -200,7 +200,7 @@ {#import System.Glib.GList#} import System.Glib.GError (propagateGError, GErrorDomain, GErrorClass(..)) -{# context lib="gtk" prefix ="gtk" #} +{# context lib="gtk" prefix="gtk" #} {# enum FileChooserAction {underscoreToCase} #} {# enum FileChooserError {underscoreToCase} #} Index: FileChooserWidget.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Selectors/FileChooserWidget.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- FileChooserWidget.chs.pp 25 Feb 2005 01:11:37 -0000 1.3 +++ FileChooserWidget.chs.pp 25 Feb 2005 22:53:43 -0000 1.4 @@ -25,10 +25,10 @@ -- Portability : portable (depends on GHC) -- -- The file chooser dialog and widget is a replacement --- for the old "FileSel"ection dialog. It provides a better user +-- for the old 'FileSel'ection dialog. It provides a better user -- interface and an improved API. -- --- * This is the widget variant of the "FileChooser" +-- * This is the widget variant of the 'FileChooser' -- -- * Added in GTK+ 2.4 -- @@ -80,10 +80,11 @@ {#import Graphics.UI.Gtk.Types#} {#import Graphics.UI.Gtk.Selectors.FileChooser#} (FileChooserAction) -{# context lib="gtk" prefix ="gtk" #} +{# context lib="gtk" prefix="gtk" #} + +-------------------- +-- Interfaces --- The FileChooserWidget implements the FileChooser interface --- which we model in Haskell as another instance decleration instance FileChooserClass FileChooserWidget -------------------- |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:53:54
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Scrolling In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/Scrolling Modified Files: ScrolledWindow.chs Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: ScrolledWindow.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Scrolling/ScrolledWindow.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- ScrolledWindow.chs 25 Feb 2005 01:11:36 -0000 1.3 +++ ScrolledWindow.chs 25 Feb 2005 22:53:43 -0000 1.4 @@ -99,13 +99,13 @@ ) where import Monad (liftM) +import Maybe (fromMaybe) import System.Glib.FFI import Graphics.UI.Gtk.Abstract.Object (makeNewObject) {#import Graphics.UI.Gtk.Types#} {#import Graphics.UI.Gtk.Signals#} import Graphics.UI.Gtk.General.Enums (PolicyType(..), CornerType(..), ShadowType(..)) -import Maybe (fromMaybe) {# context lib="gtk" prefix="gtk" #} |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:53:53
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/MenuComboToolbar Modified Files: CheckMenuItem.chs.pp ComboBox.chs.pp ComboBoxEntry.chs.pp Combo.chs.pp MenuItem.chs ImageMenuItem.chs Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: ComboBoxEntry.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/ComboBoxEntry.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- ComboBoxEntry.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 +++ ComboBoxEntry.chs.pp 25 Feb 2005 22:53:41 -0000 1.4 @@ -71,7 +71,7 @@ {#import Graphics.UI.Gtk.Types#} {#import Graphics.UI.Gtk.Signals#} -{# context lib="gtk" prefix ="gtk" #} +{# context lib="gtk" prefix="gtk" #} -------------------- -- Constructors Index: ComboBox.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/ComboBox.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- ComboBox.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 +++ ComboBox.chs.pp 25 Feb 2005 22:53:41 -0000 1.4 @@ -87,7 +87,7 @@ {#import Graphics.UI.Gtk.Signals#} {#import Graphics.UI.Gtk.TreeList.TreeModel#} (TreeIter(..), createTreeIter) -{# context lib="gtk" prefix ="gtk" #} +{# context lib="gtk" prefix="gtk" #} -------------------- -- Constructors Index: MenuItem.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/MenuItem.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- MenuItem.chs 25 Feb 2005 01:11:35 -0000 1.3 +++ MenuItem.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -19,6 +19,12 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- +-- NOTES +-- +-- This widget derives from 'Item'. Since CList and CTree are deprecated, it +-- is the only child of that widget. The three signals defined by Item are +-- therefore bound in this module. +-- -- TODO -- -- figure out what the signals \"toggle-size-allocate\" and @@ -33,10 +39,6 @@ -- -- This widget represents a singe menu item. -- --- * The widget derives from Item. Since CList and CTree are deprecated, it --- is the only child of that widget. The three signals defined by Item are --- therefore bound in this module. --- module Graphics.UI.Gtk.MenuComboToolbar.MenuItem ( -- * Description -- Index: ImageMenuItem.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/ImageMenuItem.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- ImageMenuItem.chs 25 Feb 2005 01:11:34 -0000 1.3 +++ ImageMenuItem.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -7,17 +7,21 @@ -- -- Version $Revision$ from $Date$ -- --- Copyright (c) 2002 Jonas Svensson +-- Copyright (C) 2002 Jonas Svensson -- --- This file 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 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 file is distributed in the hope that it will be useful, +-- 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 General Public License for more details. +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +-- Lesser General Public License for more details. +-- +-- TODO +-- +-- imageMenuItemNewFromSock should also have a AccelGroup argument -- -- | -- Maintainer : gtk...@li... @@ -26,10 +30,6 @@ -- -- This widget implements a 'MenuItem' with an image next to it -- --- TODO --- --- * imageMenuItemNewFromSock should also have a AccelGroup argument --- module Graphics.UI.Gtk.MenuComboToolbar.ImageMenuItem ( -- * Description -- @@ -76,7 +76,7 @@ {#import Graphics.UI.Gtk.Types#} {#import Graphics.UI.Gtk.Signals#} -{#context lib="gtk" prefix="gtk" #} +{# context lib="gtk" prefix="gtk" #} -------------------- -- Constructors Index: Combo.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/Combo.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Combo.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 +++ Combo.chs.pp 25 Feb 2005 22:53:41 -0000 1.4 @@ -29,8 +29,7 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- A Combo box is a text entry field with a drop down list of predefined --- alternatives. +-- A Combo is a text entry field with a dropdown list. -- module Graphics.UI.Gtk.MenuComboToolbar.Combo ( -- * Description Index: CheckMenuItem.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/CheckMenuItem.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- CheckMenuItem.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 +++ CheckMenuItem.chs.pp 25 Feb 2005 22:53:41 -0000 1.4 @@ -80,7 +80,7 @@ {#import Graphics.UI.Gtk.Types#} {#import Graphics.UI.Gtk.Signals#} -{#context lib="gtk" prefix="gtk" #} +{# context lib="gtk" prefix="gtk" #} -------------------- -- Constructors |
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/Abstract Modified Files: Bin.chs Box.chs ButtonBox.chs.pp Misc.chs Container.chs Paned.chs.pp Range.chs Scale.chs Widget.chs Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: Range.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract/Range.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Range.chs 25 Feb 2005 01:11:31 -0000 1.3 +++ Range.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -24,12 +24,14 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- An abstract base class to handle widgets that represent some value range. --- --- * For signals regarding a change in the range or increments, refer to --- 'Adjustment' which is contained in the 'Range' object. +-- Base class for widgets which visualize an 'Adjustment' -- module Graphics.UI.Gtk.Abstract.Range ( +-- * Description +-- +-- | For signals regarding a change in the range or increments, refer to +-- 'Adjustment' which is contained in the 'Range' object. + -- * Class Hierarchy -- | -- @ @@ -63,6 +65,8 @@ rangeSetRange, rangeSetValue, rangeGetValue, + +-- * Signals onMoveSlider, afterMoveSlider ) where Index: Bin.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract/Bin.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Bin.chs 25 Feb 2005 01:11:31 -0000 1.3 +++ Bin.chs 25 Feb 2005 22:53:40 -0000 1.4 @@ -68,7 +68,6 @@ ) where import System.Glib.FFI - import Graphics.UI.Gtk.Abstract.Object (makeNewObject) {#import Graphics.UI.Gtk.Types#} Index: Box.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract/Box.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Box.chs 25 Feb 2005 01:11:31 -0000 1.3 +++ Box.chs 25 Feb 2005 22:53:40 -0000 1.4 @@ -108,9 +108,8 @@ ) where import Monad (liftM) -import System.Glib.FFI - +import System.Glib.FFI import Graphics.UI.Gtk.Abstract.Object (makeNewObject) {#import Graphics.UI.Gtk.Types#} {#import Graphics.UI.Gtk.Signals#} Index: ButtonBox.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract/ButtonBox.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- ButtonBox.chs.pp 25 Feb 2005 01:11:31 -0000 1.2 +++ ButtonBox.chs.pp 25 Feb 2005 22:53:40 -0000 1.3 @@ -75,13 +75,11 @@ ) where import Monad (liftM) -import System.Glib.FFI - +import System.Glib.FFI import Graphics.UI.Gtk.Abstract.Object (makeNewObject) {#import Graphics.UI.Gtk.Types#} {#import Graphics.UI.Gtk.Signals#} - import Graphics.UI.Gtk.General.Enums (ButtonBoxStyle) {# context lib="gtk" prefix="gtk" #} Index: Misc.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract/Misc.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Misc.chs 25 Feb 2005 01:11:31 -0000 1.3 +++ Misc.chs 25 Feb 2005 22:53:40 -0000 1.4 @@ -66,9 +66,8 @@ ) where import Monad (liftM) -import System.Glib.FFI - +import System.Glib.FFI {#import Graphics.UI.Gtk.Types#} {#import Graphics.UI.Gtk.Signals#} Index: Widget.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract/Widget.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Widget.chs 25 Feb 2005 01:11:31 -0000 1.3 +++ Widget.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -43,7 +43,7 @@ -- Portability : portable (depends on GHC) -- -- Base class for all widgets --- +-- module Graphics.UI.Gtk.Abstract.Widget ( -- * Description -- @@ -81,6 +81,8 @@ Allocation, Requisition(..), Rectangle(..), + +-- * Methods widgetGetState, widgetGetSavedState, widgetShow, -- Showing and hiding a widget. @@ -108,6 +110,8 @@ widgetGetDirection, -- widgetLockAccelerators, -- widgetUnlockAccelerators, + +-- * Signals Event(..), onButtonPress, afterButtonPress, Index: Paned.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract/Paned.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Paned.chs.pp 25 Feb 2005 01:11:31 -0000 1.3 +++ Paned.chs.pp 25 Feb 2005 22:53:41 -0000 1.4 @@ -24,9 +24,7 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- This abstract widget provides a division line with a handle that can be --- used by the user to divide the given space between two widgets. The two --- concrete implementations are HPaned and VPaned. +-- Base class for widgets with two adjustable panes -- module Graphics.UI.Gtk.Abstract.Paned ( -- * Description Index: Container.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract/Container.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Container.chs 25 Feb 2005 01:11:31 -0000 1.3 +++ Container.chs 25 Feb 2005 22:53:40 -0000 1.4 @@ -102,10 +102,8 @@ -- rather to their relation. Typical examples of child properties are the -- position or pack-type of a widget which is contained in a 'Box'. -- --- To set the value of a child property, use 'containerChildSetProperty', --- 'containerChildSet' or 'containerChildSetValist'. To obtain the value of a --- child property, use 'containerChildGetProperty', 'containerChildGet' or --- 'containerChildGetValist'. +-- To set the value of a child property, use 'containerChildSetProperty'. +-- To obtain the value of a child property, use 'containerChildGetProperty'. -- -- * Class Hierarchy @@ -181,7 +179,6 @@ {#import System.Glib.GValue#} (GValue, GenericValue, valueUnset) import Graphics.UI.Gtk.General.Enums (DirectionType(..)) - {# context lib="gtk" prefix="gtk" #} -------------------- Index: Scale.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Abstract/Scale.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Scale.chs 25 Feb 2005 01:11:31 -0000 1.3 +++ Scale.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -24,8 +24,8 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- This is the abstract base class for HScale and VScale. It implements the --- management of an adjustable value. +-- This is the abstract base class for 'HScale' and 'VScale'. It implements +-- the management of an adjustable value. -- module Graphics.UI.Gtk.Abstract.Scale ( -- * Description @@ -34,7 +34,7 @@ -- you'll probably want to investigate the methods on its base class, 'Range', -- in addition to the methods for 'Scale' itself. To set the value of a scale, -- you would normally use 'rangeSetValue'. To detect changes to the value, you --- would normally use the 'onValueVhanged' signal. +-- would normally use the 'onValueChanged' signal. -- -- The 'Scale' widget is an abstract class, used only for deriving the -- subclasses 'HScale' and 'VScale'. To create a scale widget, call |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:53:53
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Entry In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/Entry Modified Files: Editable.chs.pp EntryCompletion.chs.pp Entry.chs.pp SpinButton.chs Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: SpinButton.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Entry/SpinButton.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- SpinButton.chs 25 Feb 2005 01:11:33 -0000 1.3 +++ SpinButton.chs 25 Feb 2005 22:53:42 -0000 1.4 @@ -104,7 +104,9 @@ {# context lib="gtk" prefix="gtk" #} --- GtkSpinbutton implements the GtkEditable interface +-------------------- +-- Interfaces + instance EditableClass SpinButton -------------------- Index: Entry.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Entry/Entry.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Entry.chs.pp 25 Feb 2005 01:11:33 -0000 1.3 +++ Entry.chs.pp 25 Feb 2005 22:53:42 -0000 1.4 @@ -98,6 +98,7 @@ ) where import Monad (liftM) +import Char (ord, chr) import System.Glib.FFI import System.Glib.UTFString @@ -105,11 +106,12 @@ import System.Glib.GObject (makeNewGObject) {#import Graphics.UI.Gtk.Types#} {#import Graphics.UI.Gtk.Signals#} -import Char (ord, chr) {# context lib="gtk" prefix="gtk" #} --- GtkEntry implements the GtkEditable interface +-------------------- +-- Interfaces + instance EditableClass Entry -------------------- Index: Editable.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Entry/Editable.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Editable.chs.pp 25 Feb 2005 01:11:33 -0000 1.3 +++ Editable.chs.pp 25 Feb 2005 22:53:42 -0000 1.4 @@ -30,7 +30,7 @@ -- Portability : portable (depends on GHC) -- -- This is an interface for simple single-line text editing widgets. It is --- implemented by "Entry" and "SpinButton". +-- implemented by 'Entry' and 'SpinButton'. -- module Graphics.UI.Gtk.Entry.Editable ( -- * Description Index: EntryCompletion.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Entry/EntryCompletion.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- EntryCompletion.chs.pp 25 Feb 2005 01:11:33 -0000 1.3 +++ EntryCompletion.chs.pp 25 Feb 2005 22:53:42 -0000 1.4 @@ -24,7 +24,7 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- Completion functionality for the "Entry" widget. +-- Completion functionality for the 'Entry' widget. -- -- * Added in GTK+ 2.4 -- |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:53:53
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/Layout Modified Files: Expander.chs.pp Fixed.chs Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: Expander.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/Expander.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Expander.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 +++ Expander.chs.pp 25 Feb 2005 22:53:41 -0000 1.4 @@ -78,7 +78,7 @@ onActivate, afterActivate #endif -) where + ) where #if GTK_CHECK_VERSION(2,4,0) @@ -90,7 +90,7 @@ {#import Graphics.UI.Gtk.Types#} import Graphics.UI.Gtk.Signals -{# context lib="gtk" prefix ="gtk" #} +{# context lib="gtk" prefix="gtk" #} -------------------- -- Constructors Index: Fixed.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/Fixed.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Fixed.chs 25 Feb 2005 01:11:34 -0000 1.3 +++ Fixed.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -29,8 +29,8 @@ module Graphics.UI.Gtk.Layout.Fixed ( -- * Description -- --- | The "Fixed" widget is a container which can place child widgets at fixed --- positions and with fixed sizes, given in pixels. "Fixed" performs no +-- | The 'Fixed' widget is a container which can place child widgets at fixed +-- positions and with fixed sizes, given in pixels. 'Fixed' performs no -- automatic layout management. -- -- For most applications, you should not use this container! It keeps you @@ -52,7 +52,7 @@ -- In addition, the fixed widget can't properly be mirrored in right-to-left -- languages such as Hebrew and Arabic. i.e. normally Gtk+ will flip the -- interface to put labels to the right of the thing they label, but it can't --- do that with "Fixed". So your application will not be usable in +-- do that with 'Fixed'. So your application will not be usable in -- right-to-left languages. -- -- Finally, fixed positioning makes it kind of annoying to add\/remove GUI @@ -60,7 +60,7 @@ -- 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 "Fixed", by all means use the widget. But you +-- prefer the simplicity of 'Fixed', by all means use the widget. But you -- should be aware of the tradeoffs. -- * Class Hierarchy |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:53:53
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Misc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/Misc Modified Files: DrawingArea.chs SizeGroup.chs Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: DrawingArea.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Misc/DrawingArea.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- DrawingArea.chs 25 Feb 2005 01:11:35 -0000 1.3 +++ DrawingArea.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -83,7 +83,8 @@ -- * Methods drawingAreaGetDrawWindow, - drawingAreaGetSize) where + drawingAreaGetSize + ) where import Monad (liftM) Index: SizeGroup.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Misc/SizeGroup.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- SizeGroup.chs 25 Feb 2005 01:11:35 -0000 1.3 +++ SizeGroup.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -86,7 +86,7 @@ {# context lib="gtk" prefix="gtk" #} -{#enum SizeGroupMode {underscoreToCase}#} +{# enum SizeGroupMode {underscoreToCase} #} -------------------- -- Constructors |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:53:53
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Multiline In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/Multiline Modified Files: TextView.chs TextBuffer.chs TextTag.chs.pp Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: TextView.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Multiline/TextView.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- TextView.chs 25 Feb 2005 01:11:36 -0000 1.3 +++ TextView.chs 25 Feb 2005 22:53:42 -0000 1.4 @@ -152,7 +152,8 @@ onSetScrollAdjustments, afterSetScrollAdjustments, onToggleOverwrite, - afterToggleOverwrite) where + afterToggleOverwrite + ) where import Monad (liftM) Index: TextTag.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Multiline/TextTag.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- TextTag.chs.pp 25 Feb 2005 01:11:36 -0000 1.3 +++ TextTag.chs.pp 25 Feb 2005 22:53:42 -0000 1.4 @@ -19,16 +19,16 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- +-- TODO +-- +-- accessor functions for TextAttributes +-- -- | -- Maintainer : gtk...@li... -- Stability : provisional -- Portability : portable (depends on GHC) -- --- A tag that can be applied to text in a "TextBuffer". --- --- TODO --- --- * accessor functions for TextAttributes +-- A tag that can be applied to text in a 'TextBuffer'. -- module Graphics.UI.Gtk.Multiline.TextTag ( -- * Description Index: TextBuffer.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Multiline/TextBuffer.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- TextBuffer.chs 25 Feb 2005 01:11:36 -0000 1.3 +++ TextBuffer.chs 25 Feb 2005 22:53:42 -0000 1.4 @@ -42,31 +42,35 @@ -- gtk_text_buffer_add_selection_clipboard -- gtk_text_buffer_remove_selection_clipboard -- --- | --- Maintainer : gtk...@li... --- Stability : provisional --- Portability : portable (depends on GHC) --- --- This storage object holds text to be displayed by one or more --- 'TextView' widgets. --- --- * See \"Text Widget Overview\" in the Gtk+ docs. +-- NOTES -- --- * The following convenience functions are omitted: +-- The following convenience functions are omitted: -- gtk_text_buffer_insert_with_tags -- gtk_text_buffer_insert_with_tags_by_name -- gtk_text_buffer_create_tag -- gtk_text_buffer_get_bounds -- gtk_text_buffer_get_selection_bounds -- --- * The following functions do not make sense due to Haskell's wide character +-- The following functions do not make sense due to Haskell's wide character -- representation of Unicode: -- gtk_text_buffer_get_iter_at_line_index -- --- * The function gtk_text_buffer_get_selection_bounds is only used to test +-- The function gtk_text_buffer_get_selection_bounds is only used to test -- if there is a selection (see 'textBufferHasSelection'). -- +-- | +-- Maintainer : gtk...@li... +-- Stability : provisional +-- Portability : portable (depends on GHC) +-- +-- Stores attributed text for display in a 'TextView' +-- module Graphics.UI.Gtk.Multiline.TextBuffer ( +-- * Description +-- +-- | You may wish to begin by reading the text widget conceptual overview +-- which gives an overview of all the objects and data types related to the +-- text widget and how they work together. -- * Class Hierarchy -- | |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:53:50
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/General In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/General Modified Files: Style.chs Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: Style.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/General/Style.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Style.chs 25 Feb 2005 01:11:34 -0000 1.3 +++ Style.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -67,7 +67,6 @@ import Monad (liftM) - {#import System.Glib.GObject#} (makeNewGObject) {#import Graphics.UI.Gtk.Types#} import Graphics.UI.Gtk.General.Enums (StateType) |
|
From: Duncan C. <dun...@us...> - 2005-02-25 22:53:50
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Display In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11239/gtk/Graphics/UI/Gtk/Display Modified Files: Label.chs ProgressBar.chs Log Message: various small changes: Trivial white space changes to better match the generated code. Minor documentation changes. Other trivial changes to better match the generated code. TreeModelSort.chs.pp: since GtkTreeModelSort implementes the GtkTreeModel interface, make TreeModelSort an instance of TreeModelClass. ImageMenuItem.chs: relicense to LGPL with permission of Jonas Svensson. Index: ProgressBar.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Display/ProgressBar.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- ProgressBar.chs 25 Feb 2005 01:11:32 -0000 1.3 +++ ProgressBar.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -24,8 +24,7 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- The ProgressBar provides a means for an application to keep the user --- patient while some time intensive task is going on. +-- A widget which indicates progress visually. -- module Graphics.UI.Gtk.Display.ProgressBar ( -- * Description @@ -98,7 +97,7 @@ -------------------- -- Constructors --- | Create a new ProgreeBar. +-- | Creates a new 'ProgressBar'. -- progressBarNew :: IO ProgressBar progressBarNew = makeNewObject mkProgressBar $ liftM castPtr $ Index: Label.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Display/Label.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Label.chs 25 Feb 2005 01:11:32 -0000 1.3 +++ Label.chs 25 Feb 2005 22:53:41 -0000 1.4 @@ -161,6 +161,7 @@ {#import Graphics.UI.Gtk.Signals#} import Graphics.UI.Gtk.General.Enums (Justification(..)) import Graphics.UI.Gtk.Pango.Markup + {# context lib="gtk" prefix="gtk" #} -------------------- |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:32:38
|
Update of /cvsroot/gtk2hs/gtk2hs/tools/apiGen In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31080/tools/apiGen Modified Files: CodeGen.hs ModuleScan.hs Template.chs FormatDocs.hs MarshalFixup.hs Makefile Log Message: Move TODO messages before Haddock markup section. Move name fixup information to the MarshalFixup module. Use the short {# call foo_bar #} form rather than the full {# call gtk_foo_bar #} when the original module uses this form. Index: Template.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/tools/apiGen/Template.chs,v retrieving revision 1.7 retrieving revision 1.8 diff -u -d -r1.7 -r1.8 --- Template.chs 11 Feb 2005 18:03:14 -0000 1.7 +++ Template.chs 25 Feb 2005 01:32:11 -0000 1.8 @@ -18,13 +18,13 @@ -- 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. --- +--@TODO@ -- | -- Maintainer : gtk2hs-users\@lists.sourceforge.net -- Stability : provisional -- Portability : portable (depends on GHC) -- --- @DESCRIPTION@@TODO@ +-- @DESCRIPTION@ -- module @MODULE_NAME@ ( @DOCUMENTATION@ Index: ModuleScan.hs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/tools/apiGen/ModuleScan.hs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- ModuleScan.hs 17 Feb 2005 13:51:35 -0000 1.3 +++ ModuleScan.hs 25 Feb 2005 01:32:11 -0000 1.4 @@ -32,7 +32,8 @@ } deriving Show data MethodInfo = MethodInfo { - methodinfo_cname :: String, + methodinfo_cname :: String, -- the full gtk_foo_bar + methodinfo_shortcname :: String, -- just foo_bar methodinfo_unsafe :: Bool -- {#call unsafe foo#} rather than {#call foo#} } deriving Show @@ -170,10 +171,13 @@ scanCCall tokens = case takeWhile (\t -> t/="#}" && t/="#}."&& t/="#})") . tail . dropWhile (/="{#") $ tokens of ("call":"unsafe":cname:[]) -> CCall MethodInfo { methodinfo_cname = cname, + methodinfo_shortcname = cname, methodinfo_unsafe = True } ("call": cname:[]) -> CCall MethodInfo { methodinfo_cname = cname, + methodinfo_shortcname = cname, methodinfo_unsafe = False } ("call":"fun":"unsafe":cname:[]) -> CCall MethodInfo { methodinfo_cname = cname, + methodinfo_shortcname = cname, methodinfo_unsafe = True } ("fun":"pure":_) -> None ("type":_) -> None Index: CodeGen.hs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/tools/apiGen/CodeGen.hs,v retrieving revision 1.8 retrieving revision 1.9 diff -u -d -r1.8 -r1.9 --- CodeGen.hs 23 Feb 2005 14:12:35 -0000 1.8 +++ CodeGen.hs 25 Feb 2005 01:32:11 -0000 1.9 @@ -56,7 +56,7 @@ formatParamTypes (paramTypes ++ [returnType]) body = foldl (\body marshaler -> marshaler body) call (paramMarshalers++[returnMarshaler]) - call = ss (genCall (method_cname method) safety) + call = ss (genCall (maybe (method_cname method) methodinfo_shortcname info) safety) safety = case info of Nothing -> False Just info -> methodinfo_unsafe info @@ -369,9 +369,10 @@ , not $ null [ () | VarArgs <- method_parameters method] ] in if null varargsFunctions then id - else nl. comment. nl. comment. + else nl. comment. ss "TODO: the following varargs functions were not bound\n". - lines (map (ss "-- * ".) varargsFunctions) + lines (map (ss "-- ".) varargsFunctions). + ss "\n--" type Deprecated = Bool notDeprecated = False Index: FormatDocs.hs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/tools/apiGen/FormatDocs.hs,v retrieving revision 1.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- FormatDocs.hs 23 Feb 2005 14:12:35 -0000 1.6 +++ FormatDocs.hs 25 Feb 2005 01:32:11 -0000 1.7 @@ -22,6 +22,7 @@ import Api (NameSpace(namespace_name)) import Docs import Marshal (stripKnownPrefixes, knownMiscType, KnownSymbols, CSymbol(..)) +import MarshalFixup (fixCFunctionName) import StringUtils import Maybe (isJust) @@ -172,6 +173,7 @@ case lookupFM knownSymbols text of Nothing -> "@" ++ escapeHaddockSpecialChars text ++ "@" Just SymEnumValue -> "'" ++ cConstNameToHsName text ++ "'" + Just (SymObjectType _) -> "'" ++ stripKnownPrefixes text ++ "'" _ -> "{" ++ text ++ ", FIXME: unknown literal value}" --TODO fill in the other cases haddocFormatSpan _ _ (DocArg text) = "@" ++ cParamNameToHsName text ++ "@" @@ -179,10 +181,7 @@ cFuncNameToHsName = lowerCaseFirstChar . stripKnownPrefixes - . concatMap upperCaseFirstChar - . map fixNames - . filter (not.null) --to ignore tailing underscores - . splitBy '_' + . toStudlyCapsWithFixups . takeWhile ('('/=) cParamNameToHsName :: String -> String @@ -202,23 +201,12 @@ . filter (not.null) --to ignore tailing underscores . splitBy '_' --- some special cases -fixNames :: String -> String -fixNames "hadjustment" = "HAdjustment" -fixNames "vadjustment" = "VAdjustment" -fixNames "hscale" = "HScale" -fixNames "vscale" = "VScale" -fixNames "hbox" = "HBox" -fixNames "vbox" = "VBox" -fixNames "hbutton" = "HButton" -fixNames "vbutton" = "VButton" -fixNames "hpaned" = "HPaned" -fixNames "vpaned" = "VPaned" -fixNames "hseparator" = "HSeparator" -fixNames "vseparator" = "VSeparator" -fixNames "hscrollbar" = "HScrollbar" -fixNames "vscrollbar" = "VScrollbar" -fixNames other = other +toStudlyCapsWithFixups :: String -> String +toStudlyCapsWithFixups = --change "gtk_foo_bar" to "GtkFooBar" + concatMap upperCaseFirstChar + . map fixCFunctionName + . filter (not.null) --to ignore tailing underscores + . splitBy '_' changeIllegalNames :: String -> String changeIllegalNames "type" = "type_" --this is a common variable name in C but of Index: Makefile =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/tools/apiGen/Makefile,v retrieving revision 1.9 retrieving revision 1.10 diff -u -d -r1.9 -r1.10 --- Makefile 17 Feb 2005 13:51:35 -0000 1.9 +++ Makefile 25 Feb 2005 01:32:11 -0000 1.10 @@ -144,7 +144,7 @@ # tools # ApiGen : ApiGen.hs Api.hs Docs.hs FormatDocs.hs \ - Marshal.hs CodeGen.hs StringUtils.hs ModuleScan.hs + Marshal.hs CodeGen.hs StringUtils.hs ModuleScan.hs MarshalFixup.hs ghc --make $< -o $@ gapi_format_xml : formatXml.c Index: MarshalFixup.hs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/tools/apiGen/MarshalFixup.hs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- MarshalFixup.hs 23 Feb 2005 14:12:35 -0000 1.1 +++ MarshalFixup.hs 25 Feb 2005 01:32:11 -0000 1.2 @@ -13,6 +13,27 @@ stripKnownPrefixes ('G':'n':'o':'m':'e':remainder) = remainder stripKnownPrefixes other = other +-- some special cases for when converting "gtk_foo_bar" to "GtkFooBar" +-- eg instead of doing gtk_hadjustment -> GtkHadjustment +-- we would prefer gtk_hadjustment -> GtkHAdjustment +-- so list those special cases here: +fixCFunctionName :: String -> String +fixCFunctionName "hadjustment" = "HAdjustment" +fixCFunctionName "vadjustment" = "VAdjustment" +fixCFunctionName "hscale" = "HScale" +fixCFunctionName "vscale" = "VScale" +fixCFunctionName "hbox" = "HBox" +fixCFunctionName "vbox" = "VBox" +fixCFunctionName "hbutton" = "HButton" +fixCFunctionName "vbutton" = "VButton" +fixCFunctionName "hpaned" = "HPaned" +fixCFunctionName "vpaned" = "VPaned" +fixCFunctionName "hseparator" = "HSeparator" +fixCFunctionName "vseparator" = "VSeparator" +fixCFunctionName "hscrollbar" = "HScrollbar" +fixCFunctionName "vscrollbar" = "VScrollbar" +fixCFunctionName other = other + -- These are ones we have bound and so we can make documentation references to -- them. Otherwise we generate FIXME messages in the docs. knownMiscType :: String -> Bool |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:32:34
|
Update of /cvsroot/gtk2hs/gtk2hs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31080 Modified Files: ChangeLog Log Message: Move TODO messages before Haddock markup section. Move name fixup information to the MarshalFixup module. Use the short {# call foo_bar #} form rather than the full {# call gtk_foo_bar #} when the original module uses this form. Index: ChangeLog =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v retrieving revision 1.367 retrieving revision 1.368 diff -u -d -r1.367 -r1.368 --- ChangeLog 25 Feb 2005 01:20:16 -0000 1.367 +++ ChangeLog 25 Feb 2005 01:32:10 -0000 1.368 @@ -130,6 +130,21 @@ docs generated for them we need to exclude the hidden modules from the html_DATA variable. + * tools/apiGen/CodeGen.hs: tweak generation of TODO doc messages. Use + the short {# call foo_bar #} form rather than the full + {# call gtk_foo_bar #} when the original module uses this form. + + * tools/apiGen/ModuleScan.hs: preserve short form of {# call #} from + scanned modules. + + * tools/apiGen/Template.chs: put TODO messages before Haddock markup + section. + + * tools/apiGen/FormatDocs.hs, tools/apiGen/MarshalFixup.hs: move name + fixup information to the MarshalFixup module. + + * tools/apiGen/Makefile: add MarshalFixup.hs dep. + 2005-02-24 Duncan Coutts <du...@co...> * configure.ac: Bump version to 0.9.7.1 |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:20:49
|
Update of /cvsroot/gtk2hs/gtk2hs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27452 Modified Files: ChangeLog Makefile.am Log Message: Hierarchy.chs.template: update template to use LGPL Add '#hide' Haddock annotation so the Types modules will not be included in the generated documentation. With the current cvs version of Haddock this makes everything work nicely. Makefile.am: since hidden modules do not have corresponding html docs generated for them we need to exclude the hidden modules from the html_DATA variable. Index: Makefile.am =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/Makefile.am,v retrieving revision 1.51 retrieving revision 1.52 diff -u -d -r1.51 -r1.52 --- Makefile.am 19 Feb 2005 13:25:16 -0000 1.51 +++ Makefile.am 25 Feb 2005 01:20:17 -0000 1.52 @@ -430,6 +430,7 @@ gtk/Graphics/UI/Gtk/Embedding/Embedding.hsc html_HSFILES_PREPROC = gtk/Graphics/UI/Gtk.hs +html_HSFILES_HIDDEN = gtk/Graphics/UI/Gtk/Types.hs gtk_Graphics_UI_Gtk_hs_HCFLAGS = -fno-warn-duplicate-exports #FIXME gtk_Graphics_UI_Gtk_Gdk_Enums_hs_HCFLAGS = -fglasgow-exts @@ -580,6 +581,8 @@ libHSglade_a_SOURCES = \ glade/Graphics/UI/Gtk/Glade.chs +html_HSFILES_HIDDEN += glade/Graphics/UI/Gtk/Glade/Types.hs + glade_Graphics_UI_Gtk_Glade_Types_hs_HCFLAGS = -fglasgow-exts glade/Graphics/UI/Gtk/Glade/Types.chs : $(srcdir)/tools/hierarchyGen/hierarchy.list \ @@ -655,6 +658,8 @@ gconf/System/Gnome/GConf/GConfClient.chs \ gconf/System/Gnome/GConf.hs +html_HSFILES_HIDDEN += gconf/System/Gnome/GConf/Types.hs + libHSgconf_a_LIBADD = \ gconf/System/Gnome/GConf/GConfClient_stub.o @@ -743,6 +748,8 @@ sourceview/Graphics/UI/Gtk/SourceView/SourceTagTable.chs \ sourceview/Graphics/UI/Gtk/SourceView/SourceView.chs +html_HSFILES_HIDDEN += sourceview/Graphics/UI/Gtk/SourceView/Types.hs + sourceview_Graphics_UI_Gtk_SourceView_Types_hs_HCFLAGS = -fglasgow-exts sourceview_Graphics_UI_Gtk_SourceView_SourceTagStyle_hs_HCFLAGS = -fglasgow-exts @@ -817,6 +824,8 @@ libHSmozembed_a_SOURCES = \ mozembed/Graphics/UI/Gtk/MozEmbed.chs +html_HSFILES_HIDDEN += mozembed/Graphics/UI/Gtk/MozEmbed/Types.hs + mozembed_Graphics_UI_Gtk_MozEmbed_Types_hs_HCFLAGS = -fglasgow-exts mozembed/Graphics/UI/Gtk/MozEmbed/Types.chs : \ @@ -881,7 +890,7 @@ $(html_HSFILES_PREPROC:.hs=.hs.uncpp) html_DATA = \ - $(foreach HSFILE, $(html_HSFILES), \ + $(foreach HSFILE, $(filter-out $(html_HSFILES_HIDDEN),$(html_HSFILES)), \ $(patsubst $(firstword $(subst /, ,$(HSFILE))).%.hs, doc/%.html, \ $(subst /,.,$(HSFILE:.uncpp=)))) \ doc/haddock.css doc/haskell_icon.gif \ Index: ChangeLog =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v retrieving revision 1.366 retrieving revision 1.367 diff -u -d -r1.366 -r1.367 --- ChangeLog 25 Feb 2005 01:11:30 -0000 1.366 +++ ChangeLog 25 Feb 2005 01:20:16 -0000 1.367 @@ -118,6 +118,18 @@ * gtk/Graphics/UI/Gtk/Windows/Dialog.chs, gtk/Graphics/UI/Gtk/Windows/Window.chs.pp: same for Windows modules. + * tools/hierarchyGen/Hierarchy.chs.template: update template to use + LGPL and add '#hide' Haddock annotation so the Types modules will not + be included in the generated documentation. With the current cvs + version of Haddock this makes everything work nicely. + + * tools/hierarchyGen/TypeGen.hs: fix templateSubstitute function to + cope with escaped '@' symbols. + + * Makefile.am: since hidden modules do not have corresponding html + docs generated for them we need to exclude the hidden modules from the + html_DATA variable. + 2005-02-24 Duncan Coutts <du...@co...> * configure.ac: Bump version to 0.9.7.1 |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:20:43
|
Update of /cvsroot/gtk2hs/gtk2hs/tools/hierarchyGen In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27452/tools/hierarchyGen Modified Files: Hierarchy.chs.template TypeGen.hs Log Message: Hierarchy.chs.template: update template to use LGPL Add '#hide' Haddock annotation so the Types modules will not be included in the generated documentation. With the current cvs version of Haddock this makes everything work nicely. Makefile.am: since hidden modules do not have corresponding html docs generated for them we need to exclude the hidden modules from the html_DATA variable. Index: Hierarchy.chs.template =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/tools/hierarchyGen/Hierarchy.chs.template,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Hierarchy.chs.template 8 Jan 2005 17:25:05 -0000 1.2 +++ Hierarchy.chs.template 25 Feb 2005 01:20:17 -0000 1.3 @@ -5,20 +5,28 @@ -- -- Author : Axel Simon -- --- Copyright (c) 2001-2004 Axel Simon +-- Version $Revision$ from $Date$ -- --- This file 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. +-- Copyright (C) 2001-2005 Axel Simon -- --- This file is distributed in the hope that it will be useful, +-- 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 General Public License for more details. +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +-- Lesser General Public License for more details. -- +-- #hide + -- | --- This file reflects the Gtk object hierarchy in terms of Haskell classes. +-- Maintainer : gtk2hs-users\@lists.sourceforge.net +-- Stability : provisional +-- Portability : portable (depends on GHC) +-- +-- This file reflects the Gtk+ object hierarchy in terms of Haskell classes. -- module @MODULE_NAME@ ( @MODULE_EXPORTS@ @@ -30,7 +38,7 @@ import GHC.Base (unsafeCoerce#) @IMPORT_PARENT@ -{#context lib="@CONTEXT_LIB@" prefix="@CONTEXT_PREFIX@" #} +{# context lib="@CONTEXT_LIB@" prefix="@CONTEXT_PREFIX@" #} -- The usage of foreignPtrToPtr should be safe as the evaluation will only be -- forced if the object is used afterwards Index: TypeGen.hs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/tools/hierarchyGen/TypeGen.hs,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- TypeGen.hs 8 Jan 2005 17:25:05 -0000 1.11 +++ TypeGen.hs 25 Feb 2005 01:20:17 -0000 1.12 @@ -266,6 +266,7 @@ templateSubstitute :: String -> (String -> ShowS) -> ShowS templateSubstitute template varSubst = doSubst template where doSubst [] = id + doSubst ('\\':'@':cs) = sc '@' . doSubst cs doSubst ('@':cs) = let (var,_:cs') = span ('@'/=) cs in varSubst var . doSubst cs' doSubst (c:cs) = sc c . doSubst cs |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:12:38
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24163/gtk/Graphics/UI/Gtk/Layout Modified Files: Alignment.chs.pp AspectFrame.chs Expander.chs.pp Fixed.chs HBox.chs HButtonBox.chs HPaned.chs Layout.chs Notebook.chs.pp Table.chs VBox.chs VButtonBox.chs VPaned.chs Log Message: Add more module level documentation and tidy up exiting documentation. Also add/modify section headers. Also LGPL'ify remaining modules with permission from Matthew Walton. Index: Fixed.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/Fixed.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Fixed.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ Fixed.chs 25 Feb 2005 01:11:34 -0000 1.3 @@ -34,24 +34,25 @@ -- automatic layout management. -- -- For most applications, you should not use this container! It keeps you --- from having to learn about the other GTK+ containers, but it results in --- broken applications. +-- from having to learn about the other Gtk+ containers, but it results in +-- broken applications. With 'Fixed', the following things will result in +-- truncated text, overlapping widgets, and other display bugs: -- -- * Themes, which may change widget sizes. -- -- * 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 GTK+, where different fonts are +-- using Windows or the framebuffer port of Gtk+, where different fonts are -- available. -- -- * Translation of text into other languages changes its size. Also, -- display of non-English text will use a different font in many cases. -- --- In addition, the fixed widget can\'t properly be mirrored in --- right-to-left languages such as Hebrew and Arabic. i.e. normally GTK+ will --- flip the interface to put labels to the right of the thing they label, but --- it can\'t do that with "Fixed". So your application will not be usable in +-- In addition, the fixed widget can't properly be mirrored in right-to-left +-- languages such as Hebrew and Arabic. i.e. normally Gtk+ will flip the +-- interface to put labels to the right of the thing they label, but it can't +-- do that with "Fixed". So your application will not be usable in -- right-to-left languages. -- -- Finally, fixed positioning makes it kind of annoying to add\/remove GUI @@ -62,7 +63,25 @@ -- prefer the simplicity of "Fixed", by all means use the widget. But you -- should be aware of the tradeoffs. +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----Fixed +-- @ + +-- * Types + Fixed, + FixedClass, + castToFixed, + +-- * Constructors fixedNew, + +-- * Methods fixedPut, fixedMove, fixedSetHasWindow, @@ -78,6 +97,8 @@ {# context lib="gtk" prefix="gtk" #} +-------------------- +-- Constructors -- | Creates a new 'Fixed' container. -- @@ -85,6 +106,9 @@ fixedNew = makeNewObject mkFixed $ liftM castPtr $ {#call unsafe fixed_new#} +-------------------- +-- Methods + -- | Adds a widget to a 'Fixed' container at the given position. -- fixedPut :: (FixedClass obj, WidgetClass widget) => obj Index: Notebook.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/Notebook.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Notebook.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ Notebook.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 @@ -19,25 +19,50 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- +-- TODO +-- +-- The signals focus-tab and select-page are not bound because it is unclear +-- what they mean. As far as I can see they are not emitted anywhere. +-- -- | -- Maintainer : gtk...@li... -- Stability : provisional -- Portability : portable (depends on GHC) -- --- This widget can display several pages of widgets. Each page can be selected --- by a tab at the top of the widget. It is useful in dialogs where a lot of --- information has to be displayed. --- --- TODO --- --- * The signals focus-tab and select-page are not bound because it is unclear --- what they mean. As far as I can see they are not emitted anywhere. +-- A tabbed notebook container. -- module Graphics.UI.Gtk.Layout.Notebook ( +-- * Description +-- +-- | The 'Notebook' widget is a 'Container' whose children are pages that can +-- be switched between using tab labels along one edge. +-- +-- There are many configuration options for 'Notebook'. Among other things, +-- you can choose on which edge the tabs appear (see 'notebookSetTabPos'), +-- whether, if there are too many tabs to fit the noteobook should be made +-- bigger or scrolling arrows added (see 'notebookSetScrollable'), and +-- whether there will be a popup menu allowing the users to switch pages. (see +-- 'notebookEnablePopup', 'noteobookDisablePopup') + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----Notebook +-- @ + +-- * Types Notebook, NotebookClass, castToNotebook, + +-- * Constructors notebookNew, + +-- * Methods notebookAppendPage, notebookAppendPageMenu, notebookPrependPage, @@ -83,6 +108,8 @@ #endif notebookSetTabLabel, notebookSetTabLabelText, + +-- * Signals onSwitchPage, afterSwitchPage ) where @@ -100,7 +127,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new notebook. -- @@ -108,6 +136,9 @@ notebookNew = makeNewObject mkNotebook $ liftM castPtr {#call unsafe notebook_new#} +-------------------- +-- Methods + #if GTK_CHECK_VERSION(2,4,0) -- | Insert a new tab to the right of the existing tabs. -- @@ -635,8 +666,8 @@ withUTFString label $ \labelPtr -> {#call notebook_set_tab_label_text#} (toNotebook nb) (toWidget child) labelPtr - --- signals +-------------------- +-- Signals -- | This signal is emitted when a new page is -- selected. @@ -649,6 +680,3 @@ afterSwitchPage nb fun = connect_BOXED_WORD__NONE "switch-page" (const $ return ()) True nb (\_ page -> fun (fromIntegral page)) - - - Index: HButtonBox.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/HButtonBox.chs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- HButtonBox.chs 8 Jan 2005 15:23:11 -0000 1.1 +++ HButtonBox.chs 25 Feb 2005 01:11:34 -0000 1.2 @@ -2,30 +2,67 @@ -- GIMP Toolkit (GTK) Widget HButtonBox -- -- Author : Matthew Walton --- +-- -- Created: 29 April 2004 -- -- Version $Revision$ from $Date$ -- --- Copyright (c) 2004 Matthew Walton +-- Copyright (C) 2004-2005 Matthew Walton -- --- This file 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 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 file is distributed in the hope that it will be useful, +-- 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 General Public License for more details. +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +-- Lesser General Public License for more details. -- -- | +-- Maintainer : gtk...@li... +-- Stability : provisional +-- Portability : portable (depends on GHC) +-- +-- A container for arranging buttons horizontally -- - module Graphics.UI.Gtk.Layout.HButtonBox ( +-- * Description +-- +-- | A button box should be used to provide a consistent layout of buttons +-- throughout your application. The layout\/spacing can be altered by the +-- programmer, or if desired, by the user to alter the \'feel\' of a program to +-- a small degree. +-- +-- A 'HButtonBox' is created with 'hButtonBoxNew'. Buttons are packed into a +-- button box the same way widgets are added to any other container, using +-- 'containerAdd'. You can also use 'boxPackStart' or 'boxPackEnd', but for +-- button boxes both these functions work just like 'containerAdd', ie., they +-- pack the button in a way that depends on the current layout style and on +-- whether the button has had 'buttonBoxSetChildSecondary' called on it. +-- +-- The spacing between buttons can be set with 'boxSetSpacing'. The +-- arrangement and layout of the buttons can be changed with +-- 'buttonBoxSetLayout'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Box' +-- | +----'ButtonBox' +-- | +----HButtonBox +-- @ + +-- * Types HButtonBox, HButtonBoxClass, castToHButtonBox, + +-- * Constructors hButtonBoxNew ) where @@ -38,11 +75,11 @@ {# context lib="gtk" prefix="gtk" #} ---methods +-------------------- +-- Constructors -- | -- hButtonBoxNew :: IO HButtonBox hButtonBoxNew = makeNewObject mkHButtonBox $ liftM castPtr {#call unsafe hbutton_box_new#} - Index: HBox.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/HBox.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- HBox.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ HBox.chs 25 Feb 2005 01:11:34 -0000 1.3 @@ -28,9 +28,34 @@ -- widgets in a horizontal line. -- module Graphics.UI.Gtk.Layout.HBox ( +-- * Description +-- +-- | 'HBox' is a container that organizes child widgets into a single row. +-- +-- Use the 'Box' packing interface to determine the arrangement, spacing, +-- width, and alignment of 'HBox' children. +-- +-- All children are allocated the same height. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Box' +-- | +----HBox +-- | +----'Combo' +-- | +----'Statusbar' +-- @ + +-- * Types HBox, HBoxClass, castToHBox, + +-- * Constructors hBoxNew ) where @@ -43,7 +68,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | -- Create a container that shows several children horizontally. If @@ -54,6 +80,3 @@ hBoxNew :: Bool -> Int -> IO HBox hBoxNew homogeneous spacing = makeNewObject mkHBox $ liftM castPtr $ {#call unsafe hbox_new#} (fromBool homogeneous) (fromIntegral spacing) - - --- Index: AspectFrame.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/AspectFrame.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- AspectFrame.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ AspectFrame.chs 25 Feb 2005 01:11:34 -0000 1.3 @@ -26,20 +26,36 @@ -- -- A frame that constrains its child to a particular aspect ratio. -- --- * The 'AspectFrame' is useful when you want pack 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. 'AspectFrame' --- derives from --- 'Frame', so it can draw a label and a frame around the child. --- The frame --- will be \"shrink-wrapped\" to the size of the child. --- module Graphics.UI.Gtk.Layout.AspectFrame ( +-- * Description +-- +-- | The 'AspectFrame' is useful when you want pack 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. 'AspectFrame' derives from +-- 'Frame', so it can draw a label and a frame around the child. The frame will +-- be \"shrink-wrapped\" to the size of the child. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Frame' +-- | +----AspectFrame +-- @ + +-- * Types AspectFrame, AspectFrameClass, castToAspectFrame, + +-- * Constructors aspectFrameNew, + +-- * Methods aspectFrameSet ) where @@ -53,7 +69,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create an AspectFrame widget. -- @@ -67,6 +84,8 @@ liftM castPtr $ {#call unsafe aspect_frame_new#} nullPtr (realToFrac xalign) (realToFrac yalign) (maybe 0.0 realToFrac ratio) (fromBool $ isNothing ratio) +-------------------- +-- Methods -- | Change the space use behaviour of an -- 'AspectFrame'. Index: Alignment.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/Alignment.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Alignment.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ Alignment.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 @@ -27,10 +27,41 @@ -- A widget which controls the alignment and size of its child -- module Graphics.UI.Gtk.Layout.Alignment ( +-- * Description +-- +-- | The 'Alignment' widget controls the alignment and size of its child +-- widget. It has four settings: xscale, yscale, xalign, and yalign. +-- +-- The scale settings are used to specify how much the child widget should +-- expand to fill the space allocated to the 'Alignment'. The values can range +-- from 0 (meaning the child doesn't expand at all) to 1 (meaning the child +-- expands to fill all of the available space). +-- +-- The align settings are used to place the child widget within the +-- available area. The values range from 0 (top or left) to 1 (bottom or +-- right). Of course, if the scale settings are both set to 1, the alignment +-- settings have no effect. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----Alignment +-- @ + +-- * Types Alignment, AlignmentClass, castToAlignment, + +-- * Constructors alignmentNew, + +-- * Methods alignmentSet #if GTK_CHECK_VERSION(2,4,0) ,alignmentSetPadding, @@ -47,7 +78,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create an alignment widget. This widget tells -- its child widget how to use the given space. @@ -57,6 +89,8 @@ liftM castPtr $ {#call unsafe alignment_new#} (realToFrac xalign) (realToFrac yalign) (realToFrac xscale) (realToFrac yscale) +-------------------- +-- Methods -- | Change the space use behaviour of an 'Alignment'. -- Index: VPaned.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/VPaned.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- VPaned.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ VPaned.chs 25 Feb 2005 01:11:34 -0000 1.3 @@ -27,9 +27,29 @@ -- A container with two panes arranged vertically. -- module Graphics.UI.Gtk.Layout.VPaned ( +-- * Description +-- +-- | The VPaned widget is a container widget with two children arranged +-- vertically. The division between the two panes is adjustable by the user by +-- dragging a handle. See 'Paned' for details. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Paned' +-- | +----VPaned +-- @ + +-- * Types VPaned, VPanedClass, castToVPaned, + +-- * Constructors vPanedNew ) where @@ -42,7 +62,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | -- Index: Layout.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/Layout.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Layout.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ Layout.chs 25 Feb 2005 01:11:34 -0000 1.3 @@ -20,17 +20,41 @@ -- Lesser General Public License for more details. -- -- | --- Maintainer : gtk2hs-users\@lists.sourceforge.net +-- Maintainer : gtk...@li... -- Stability : provisional -- Portability : portable (depends on GHC) -- --- A layout widget can hold several widgets at arbitrary positions. +-- Infinite scrollable area containing child widgets and\/or custom drawing -- module Graphics.UI.Gtk.Layout.Layout ( +-- * Description +-- +-- | 'Layout' is similar to 'DrawingArea' in that it's a \"blank slate\" and +-- doesn't do anything but paint a blank background by default. It's different +-- in that it supports scrolling natively (you can add it to a +-- 'ScrolledWindow'), and it can contain child widgets, since it's a +-- 'Container'. However if you\'re just going to draw, a 'DrawingArea' is a +-- better choice since it has lower overhead. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----Layout +-- @ + +-- * Types Layout, LayoutClass, castToLayout, + +-- * Constructors layoutNew, + +-- * Methods layoutPut, layoutMove, layoutSetSize, @@ -39,6 +63,8 @@ layoutGetVAdjustment, layoutSetHAdjustment, layoutSetVAdjustment, + +-- * Signals onSetScrollAdjustments, afterSetScrollAdjustments ) where @@ -53,7 +79,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new layout widget. -- @@ -64,6 +91,8 @@ fromMAdj :: Maybe Adjustment -> Adjustment fromMAdj = fromMaybe $ mkAdjustment nullForeignPtr +-------------------- +-- Methods -- | Insert a widget into the layout container. -- @@ -115,7 +144,8 @@ layoutSetVAdjustment :: LayoutClass l => l -> Adjustment -> IO () layoutSetVAdjustment l adj = {#call layout_set_vadjustment#} (toLayout l) adj --- signals +-------------------- +-- Signals -- | In case the adjustments are -- replaced, this signal is emitted. Index: VBox.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/VBox.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- VBox.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ VBox.chs 25 Feb 2005 01:11:34 -0000 1.3 @@ -28,9 +28,36 @@ -- in a vertical line. -- module Graphics.UI.Gtk.Layout.VBox ( +-- * Description +-- +-- | 'VBox' is a container that organizes child widgets into a single column. +-- +-- Use the 'Box' packing interface to determine the arrangement, spacing, +-- height, and alignment of 'VBox' children. +-- +-- All children are allocated the same width. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Box' +-- | +----VBox +-- | +----'ColorSelection' +-- | +----'FileChooserWidget' +-- | +----'FontSelection' +-- | +----'GammaCurve' +-- @ + +-- * Types VBox, VBoxClass, castToVBox, + +-- * Constructors vBoxNew ) where @@ -43,7 +70,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | -- Create a container that shows several children vertically. @@ -55,6 +83,3 @@ vBoxNew :: Bool -> Int -> IO VBox vBoxNew homogeneous spacing = makeNewObject mkVBox $ liftM castPtr $ {#call unsafe vbox_new#} (fromBool homogeneous) (fromIntegral spacing) - - - Index: Table.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/Table.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Table.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ Table.chs 25 Feb 2005 01:11:34 -0000 1.3 @@ -27,10 +27,46 @@ -- The table widget is a container in which widgets can be aligned in cells. -- module Graphics.UI.Gtk.Layout.Table ( +-- * Description +-- +-- | The 'Table' functions allow the programmer to arrange widgets 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 'tableNew', the size of which can later +-- be changed with 'tableResize'. +-- +-- Widgets can be added to a table using 'tableAttach' or the more +-- convenient (but slightly less flexible) 'tableAttachDefaults'. +-- +-- To alter the space next to a specific row, use 'tableSetRowSpacing', and +-- for a column, 'tableSetColSpacing'. +-- +-- The gaps between /all/ rows or columns can be changed by calling +-- 'tableSetRowSpacings' or 'tableSetColSpacings' respectively. +-- +-- 'tableSetHomogeneous', can be used to set whether all cells in the table +-- will resize themselves to the size of the largest widget in the table. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----Table +-- @ + +-- * Types Table, TableClass, castToTable, + +-- * Constructors tableNew, + +-- * Methods tableResize, AttachOptions(..), tableAttach, @@ -57,7 +93,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new table with the specified dimensions. -- Set @homogeneous@ to True if all cells should be of the same size. @@ -67,6 +104,9 @@ {#call unsafe table_new#} (fromIntegral rows) (fromIntegral columns) (fromBool homogeneous) +-------------------- +-- Methods + -- | Change the dimensions of an already existing table. -- tableResize :: TableClass tb => tb -> Int -> Int -> IO () Index: Expander.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/Expander.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Expander.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ Expander.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 @@ -24,22 +24,43 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- An Expander allows the user to hide or show its child by clicking on an --- expander triangle similar to the triangles used in a TreeView. +-- A container which can hide its child -- --- Normally you use an expander as you would use any other descendant of GtkBin --- you create the child widget and use containerAdd to add it to the expander. --- When the expander is toggled, it will take care of showing and hiding the --- child automatically. +module Graphics.UI.Gtk.Layout.Expander ( +-- * Description +-- +-- | A 'Expander' allows the user to hide or show its child by clicking on an +-- expander triangle similar to the triangles used in a 'TreeView'. -- --- * Added in GTK+ 2.4 +-- Normally you use an expander as you would use any other descendant of +-- 'Bin'; you create the child widget and use 'containerAdd' to add it to the +-- expander. When the expander is toggled, it will take care of showing and +-- hiding the child automatically. -- -module Graphics.UI.Gtk.Layout.Expander ( +-- * Module available since Gtk version 2.4 + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----Expander +-- @ + #if GTK_CHECK_VERSION(2,4,0) +-- * Types Expander, ExpanderClass, + castToExpander, + +-- * Constructors expanderNew, expanderNewWithMnemonic, + +-- * Methods expanderSetExpanded, expanderGetExpanded, expanderSetSpacing, @@ -52,6 +73,8 @@ expanderGetUseMarkup, expanderSetLabelWidget, expanderGetLabelWidget, + +-- * Signals onActivate, afterActivate #endif @@ -69,6 +92,9 @@ {# context lib="gtk" prefix ="gtk" #} +-------------------- +-- Constructors + expanderNew :: String -> IO Expander expanderNew label = makeNewObject mkExpander $ liftM castPtr $ @@ -81,6 +107,9 @@ withUTFString label $ \strPtr -> {# call gtk_expander_new_with_mnemonic #} strPtr +-------------------- +-- Methods + expanderSetExpanded :: Expander -> Bool -> IO () expanderSetExpanded expander expanded = {# call gtk_expander_set_expanded #} expander (fromBool expanded) @@ -132,6 +161,9 @@ makeNewObject mkWidget $ {# call gtk_expander_get_label_widget #} expander +-------------------- +-- Signals + onActivate :: Expander -> IO () -> IO (ConnectId Expander) afterActivate :: Expander -> IO () -> IO (ConnectId Expander) onActivate = connect_NONE__NONE "activate" False Index: HPaned.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/HPaned.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- HPaned.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ HPaned.chs 25 Feb 2005 01:11:34 -0000 1.3 @@ -27,9 +27,29 @@ -- A container with two panes arranged horizontally. -- module Graphics.UI.Gtk.Layout.HPaned ( +-- * Description +-- +-- | The HPaned widget is a container widget with two children arranged +-- horizontally. The division between the two panes is adjustable by the user +-- by dragging a handle. See 'Paned' for details. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Paned' +-- | +----HPaned +-- @ + +-- * Types HPaned, HPanedClass, castToHPaned, + +-- * Constructors hPanedNew ) where @@ -42,7 +62,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | -- Index: VButtonBox.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Layout/VButtonBox.chs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- VButtonBox.chs 8 Jan 2005 15:23:39 -0000 1.1 +++ VButtonBox.chs 25 Feb 2005 01:11:34 -0000 1.2 @@ -2,30 +2,67 @@ -- GIMP Toolkit (GTK) Widget VButtonBox -- -- Author : Matthew Walton --- +-- -- Created: 28 April 2004 -- -- Version $Revision$ from $Date$ -- --- Copyright (c) 2004 Matthew Walton +-- Copyright (C) 2004-2005 Matthew Walton -- --- This file 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 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 file is distributed in the hope that it will be useful, +-- 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 General Public License for more details. +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +-- Lesser General Public License for more details. -- -- | +-- Maintainer : gtk...@li... +-- Stability : provisional +-- Portability : portable (depends on GHC) +-- +-- A container for arranging buttons vertically +-- +module Graphics.UI.Gtk.Layout.VButtonBox ( +-- * Description +-- +-- | A button box should be used to provide a consistent layout of buttons +-- throughout your application. The layout\/spacing can be altered by the +-- programmer, or if desired, by the user to alter the \'feel\' of a program to +-- a small degree. -- +-- A 'VButtonBox' is created with 'vButtonBoxNew'. Buttons are packed into a +-- button box the same way widgets are added to any other container, using +-- 'containerAdd'. You can also use 'boxPackStart' or 'boxPackEnd', but for +-- button boxes both these functions work just like 'containerAdd', ie., they +-- pack the button in a way that depends on the current layout style and on +-- whether the button has had 'buttonBoxSetChildSecondary' called on it. +-- +-- The spacing between buttons can be set with 'boxSetSpacing'. The +-- arrangement and layout of the buttons can be changed with +-- 'buttonBoxSetLayout'. -module Graphics.UI.Gtk.Layout.VButtonBox ( +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Box' +-- | +----'ButtonBox' +-- | +----VButtonBox +-- @ + +-- * Types VButtonBox, VButtonBoxClass, castToVButtonBox, + +-- * Constructors vButtonBoxNew ) where @@ -38,11 +75,11 @@ {# context lib="gtk" prefix="gtk" #} ---methods +-------------------- +-- Constructors -- | -- vButtonBoxNew :: IO VButtonBox vButtonBoxNew = makeNewObject mkVButtonBox $ liftM castPtr {#call unsafe vbutton_box_new#} - |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:12:37
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Buttons In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24163/gtk/Graphics/UI/Gtk/Buttons Modified Files: Button.chs.pp CheckButton.chs RadioButton.chs ToggleButton.chs Log Message: Add more module level documentation and tidy up exiting documentation. Also add/modify section headers. Also LGPL'ify remaining modules with permission from Matthew Walton. Index: RadioButton.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Buttons/RadioButton.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- RadioButton.chs 12 Feb 2005 17:19:21 -0000 1.2 +++ RadioButton.chs 25 Feb 2005 01:11:32 -0000 1.3 @@ -19,29 +19,55 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- +-- TODO +-- +-- No function that directly accesses the group is bound. This is due to the +-- difficulties assuring that these groups are valid as the group is a plain +-- GSList from Glib. +-- -- | -- Maintainer : gtk...@li... -- Stability : provisional -- Portability : portable (depends on GHC) -- --- A radio group is a set of check buttons where only one button can be --- checked. --- --- * Each radio button has to be associated with a group. Generating a new --- radio button makes up a new group. Other group members can be added by --- generating radio buttons with the function --- 'radioButtonNewJoinGroup'. +-- A choice from multiple check buttons. -- --- TODO +module Graphics.UI.Gtk.Buttons.RadioButton ( +-- * Description +-- +-- | A single radio button performs the same basic function as a +-- 'CheckButton', as its 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. -- --- * No function that directly accesses the group is bound. This is due to the --- difficulties assuring that these groups are valid as the group is a plain --- GSList from Glib. +-- 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 +-- 'RadioButton' is one way of giving the user a choice from many options. -- -module Graphics.UI.Gtk.Buttons.RadioButton ( +-- Each radio button has to be associated with a group. Generating a new +-- radio button makes up a new group. Other group members can be added by +-- generating radio buttons with the function 'radioButtonNewJoinGroup'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Button' +-- | +----'ToggleButton' +-- | +----'CheckButton' +-- | +----RadioButton +-- @ + +-- * Types RadioButton, RadioButtonClass, castToRadioButton, + +-- * Constructors radioButtonNew, radioButtonNewWithLabel, radioButtonNewWithMnemonic, @@ -65,7 +91,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new RadioButton widget with a new group. -- Index: CheckButton.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Buttons/CheckButton.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- CheckButton.chs 12 Feb 2005 17:19:21 -0000 1.2 +++ CheckButton.chs 25 Feb 2005 01:11:32 -0000 1.3 @@ -27,9 +27,34 @@ -- create widgets with a discrete toggle button. -- module Graphics.UI.Gtk.Buttons.CheckButton ( +-- * Description +-- +-- | A 'CheckButton' places a discrete 'ToggleButton' next to a widget, +-- (usually a 'Label'). See the section on 'ToggleButton' widgets for more +-- information about toggle\/check buttons. +-- +-- The important signal (\'toggled\') is also inherited from 'ToggleButton'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Button' +-- | +----'ToggleButton' +-- | +----CheckButton +-- | +----'RadioButton' +-- @ + +-- * Types CheckButton, CheckButtonClass, castToCheckButton, + +-- * Constructors checkButtonNew, checkButtonNewWithLabel, checkButtonNewWithMnemonic @@ -45,7 +70,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new button with a check field. -- @@ -71,5 +97,3 @@ checkButtonNewWithMnemonic lbl = withUTFString lbl (\strPtr -> makeNewObject mkCheckButton $ liftM castPtr $ {#call unsafe check_button_new_with_mnemonic#} strPtr) - - Index: ToggleButton.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Buttons/ToggleButton.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- ToggleButton.chs 12 Feb 2005 17:19:21 -0000 1.2 +++ ToggleButton.chs 25 Feb 2005 01:11:32 -0000 1.3 @@ -24,16 +24,49 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- A ToggleButton is the base class for all buttons that have an inherit --- state. +-- Create buttons which retain their state. -- module Graphics.UI.Gtk.Buttons.ToggleButton ( +-- * Description +-- +-- | A 'ToggleButton' is a 'Button' which will remain \'pressed-in\' when +-- clicked. Clicking again will cause the toggle button to return to its normal +-- state. +-- +-- A toggle button is created by calling either 'toggleButtonNew' or +-- 'toggleButtonNewWithLabel'. If using the former, it is advisable to pack a +-- widget, (such as a 'Label' and\/or a 'Pixmap'), into the toggle button's +-- container. (See 'Button' for more information). +-- +-- The state of a 'ToggleButton' can be set specifically using +-- 'toggleButtonSetActive', and retrieved using 'toggleButtonGetActive'. +-- +-- To simply switch the state of a toggle button, use 'toggleButtonToggled'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Button' +-- | +----ToggleButton +-- | +----'CheckButton' +-- @ + +-- * Types ToggleButton, ToggleButtonClass, castToToggleButton, + +-- * Constructors toggleButtonNew, toggleButtonNewWithLabel, toggleButtonNewWithMnemonic, + +-- * Methods toggleButtonSetMode, toggleButtonGetMode, toggleButtonToggled, @@ -41,6 +74,8 @@ toggleButtonSetActive, toggleButtonGetInconsistent, toggleButtonSetInconsistent, + +-- * Signals onToggled, afterToggled ) where @@ -55,7 +90,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new ToggleButton widget. -- @@ -79,6 +115,9 @@ makeNewObject mkToggleButton $ liftM castPtr $ {#call unsafe toggle_button_new_with_mnemonic#} strPtr) +-------------------- +-- Methods + -- | Sets whether the button is displayed as a separate indicator and label. -- You can call this function on a "CheckButton" or a "RadioButton" with @False@ -- to make the button look like a normal button. @@ -126,8 +165,8 @@ toggleButtonSetInconsistent incon tb = {#call toggle_button_set_inconsistent#} (toToggleButton tb) (fromBool incon) --- signals - +-------------------- +-- Signals -- | Whenever the state of the button is changed, the toggled signal is emitted. -- Index: Button.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Buttons/Button.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Button.chs.pp 12 Feb 2005 17:19:21 -0000 1.2 +++ Button.chs.pp 25 Feb 2005 01:11:32 -0000 1.3 @@ -27,13 +27,43 @@ -- A widget that creates a signal when clicked on. -- module Graphics.UI.Gtk.Buttons.Button ( +-- * Description +-- +-- | The 'Button' widget is generally used to attach a function to that is +-- called when the button is pressed. The various signals and how to use them +-- are outlined below. +-- +-- The 'Button' widget can hold any valid child widget. That is it can hold +-- most any other standard 'Widget'. The most commonly used child is the +-- 'Label'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----Button +-- | +----'ToggleButton' +-- | +----'ColorButton' +-- | +----'FontButton' +-- | +----'OptionMenu' +-- @ + +-- * Types Button, ButtonClass, castToButton, + +-- * Constructors buttonNew, buttonNewWithLabel, buttonNewWithMnemonic, buttonNewFromStock, + +-- * Methods buttonPressed, buttonReleased, buttonClicked, @@ -54,6 +84,8 @@ buttonSetAlignment, buttonGetAlignment, #endif + +-- * Signals onButtonActivate, afterButtonActivate, onClicked, @@ -79,7 +111,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new Button widget. -- @@ -113,6 +146,9 @@ throwIfNull "buttonNewFromStock: Invalid stock identifier." $ {#call unsafe button_new_from_stock#} strPtr) +-------------------- +-- Methods + -- | Depress the button, i.e. emit the pressed signal. -- buttonPressed :: ButtonClass b => b -> IO () @@ -234,8 +270,8 @@ return (realToFrac xalign, realToFrac yalign) #endif - --- signals +-------------------- +-- Signals -- | The button has been depressed (but not -- necessarily released yet). See @clicked@ signal. |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:12:29
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Embedding In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24163/gtk/Graphics/UI/Gtk/Embedding Modified Files: Plug.chs Socket.chs Log Message: Add more module level documentation and tidy up exiting documentation. Also add/modify section headers. Also LGPL'ify remaining modules with permission from Matthew Walton. Index: Plug.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Embedding/Plug.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Plug.chs 12 Feb 2005 17:19:22 -0000 1.2 +++ Plug.chs 25 Feb 2005 01:11:33 -0000 1.3 @@ -24,17 +24,40 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- Plug is a window that is to be attached to the window of another --- application. If you have managed to receive the 'XID' from --- the inviting application you can construct the Plug and add your widgets --- to it. +-- Toplevel for embedding into other processes. -- module Graphics.UI.Gtk.Embedding.Plug ( +-- * Description +-- +-- | Together with 'Socket', 'Plug' 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 'Socket' widget and, passes the ID of that +-- widgets window to the other process, which then creates a 'Plug' with that +-- window ID. Any widgets contained in the 'Plug' then will appear inside the +-- first applications window. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Window' +-- | +----Plug +-- @ + +-- * Types Plug, PlugClass, castToPlug, NativeWindowId, + +-- * Constructors plugNew, + +-- * Methods plugGetId ) where @@ -49,7 +72,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new 'Window' to hold another -- application. @@ -64,6 +88,9 @@ plugNew mnw = makeNewObject mkPlug $ liftM castPtr $ {#call unsafe plug_new#} (fromIntegral (fromMaybe 0 mnw)) +-------------------- +-- Methods + -- | Retrieve the 'NativeWindowId'. -- -- * The result should be passed to the application which is to be embedded. @@ -72,6 +99,9 @@ plugGetId :: PlugClass p => p -> IO NativeWindowId plugGetId p = liftM fromIntegral $ {#call unsafe plug_get_id#} (toPlug p) +-------------------- +-- Signals + -- | This plug received another application. -- onEmbedded, afterEmbedded :: PlugClass p => p -> IO () -> IO (ConnectId p) Index: Socket.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Embedding/Socket.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Socket.chs 12 Feb 2005 17:19:22 -0000 1.2 +++ Socket.chs 25 Feb 2005 01:11:33 -0000 1.3 @@ -24,30 +24,70 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- This widget provides the possibility that other application display their --- widgets within this application. +-- Container for widgets from other processes. -- --- * After creation of the Socket, you may retrieve the --- 'NativeWindow' of the socket. --- For this to work, the socket must at least be realized (e.g. shown). +module Graphics.UI.Gtk.Embedding.Socket ( +-- * Description +-- +-- | Together with 'Plug', 'Socket' 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 'Socket' widget and, passes the that widget's +-- window ID to the other process, which then creates a 'Plug' with that window +-- ID. Any widgets contained in the 'Plug' then will appear inside the first +-- applications window. -- --- * The application has to make sure the 'Socket' --- is not destroyed while the --- other application tries to connect. If the 'NativeWindow' was --- transmitted, the --- inviting application can check with 'socketHasPlug' if the --- plug has --- already connected. +-- The socket's window ID is obtained by using 'socketGetId'. Before using +-- this function, the socket must have been realized, and for hence, have been +-- added to its parent. -- -module Graphics.UI.Gtk.Embedding.Socket ( +-- Note that if you pass the window ID of the socket to another process that +-- will create a plug in the socket, you must make sure that the socket widget +-- is not destroyed until that plug is created. Violating this rule will cause +-- unpredictable consequences, the most likely consequence being that the plug +-- will appear as a separate toplevel window. You can check if the plug has +-- been created by calling 'socketHasPlug'. +-- If this returns @True@, then the plug has been successfully created inside +-- of the socket. +-- +-- When Gtk+ 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 'Socket' and a 'Plug' follows the XEmbed +-- protocol. This protocol has also been implemented in other toolkits, e.g. +-- Qt, allowing the same level of integration when embedding a Qt widget in +-- Gtk+ or vice versa. +-- +-- A socket can also be used to swallow arbitrary pre-existing top-level +-- windows using 'socketSteal', though the integration when this is done will +-- not be as close as between a 'Plug' and a 'Socket'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----Socket +-- @ + +-- * Types Socket, SocketClass, castToSocket, NativeWindowId, + +-- * Constructors socketNew, + +-- * Methods socketHasPlug, socketAddId, socketGetId, + +-- * Signals onPlugAdded, afterPlugAdded, onPlugRemoved, @@ -64,7 +104,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a 'Container' for embedding. -- @@ -76,6 +117,9 @@ socketNew :: IO Socket socketNew = makeNewObject mkSocket $ liftM castPtr {#call unsafe socket_new#} +-------------------- +-- Methods + -- | Insert another application into this socket. -- -- * Inserts the other application into this plug. The @@ -97,6 +141,9 @@ socketGetId soc = liftM fromIntegral $ {#call unsafe socket_get_id#} (toSocket soc) +-------------------- +-- Signals + -- | This socket was added into another application. -- onPlugAdded, afterPlugAdded :: SocketClass s => s -> IO () -> IO (ConnectId s) |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:12:29
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Display In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24163/gtk/Graphics/UI/Gtk/Display Modified Files: AccelLabel.chs Image.chs.pp Label.chs ProgressBar.chs Statusbar.chs Log Message: Add more module level documentation and tidy up exiting documentation. Also add/modify section headers. Also LGPL'ify remaining modules with permission from Matthew Walton. Index: Image.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Display/Image.chs.pp,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Image.chs.pp 15 Feb 2005 17:54:57 -0000 1.3 +++ Image.chs.pp 25 Feb 2005 01:11:32 -0000 1.4 @@ -19,41 +19,94 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- +-- TODO +-- +-- Figure out what other functions are useful within Haskell. Maybe we should +-- support loading Pixmaps without exposing them. +-- +-- Because Haskell is not the best language to modify large images directly +-- only functions are bound that allow loading images from disc or by stock +-- names. +-- +-- Another function for extracting the 'Pixbuf' is added for +-- 'CellRenderer'. +-- -- | -- Maintainer : gtk...@li... -- Stability : provisional -- Portability : portable (depends on GHC) -- --- This widget displays an image. +-- A widget displaying an image -- +module Graphics.UI.Gtk.Display.Image ( +-- * Description +-- +-- | The 'Image' widget displays an image. Various kinds of object can be +-- displayed as an image; most typically, you would load a 'Pixbuf' (\"pixel +-- buffer\") from a file, and then display that. There's a convenience function +-- to do this, 'imageNewFromFile', used as follows: 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 'pixbufNewFromFile', then create the 'Image' with 'imageNewFromPixbuf'. -- --- * Because Haskell is not the best language to modify large images directly --- only functions are bound that allow loading images from disc or by stock --- names. +-- > image <- imageNewFromFile "myfile.png" -- --- * Another function for extracting the 'Pixbuf' is added for --- 'CellRenderer'. +-- The image file may contain an animation, if so the 'Image' will display +-- an animation ('PixbufAnimation') instead of a static image. -- --- TODO +-- 'Image' is a subclass of 'Misc', which implies that you can align it +-- (center, left, right) and add padding to it, using 'Misc' methods. -- --- * Figure out what other functions are useful within Haskell. Maybe we should --- support loading Pixmaps without exposing them. +-- 'Image' is a \"no window\" widget (has no \"Gdk Window\" 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 'EventBox', then connect to +-- the event signals on the event box. -- -module Graphics.UI.Gtk.Display.Image ( +-- 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 'Misc'). 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. +-- +-- 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 +-- gdk-pixbuf-csource. This program allows you to convert an image into a C +-- variable declaration, which can then be loaded into a 'Pixbuf' using +-- 'pixbufNewFromInline'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Misc' +-- | +----Image +-- @ + +-- * Types Image, ImageClass, castToImage, + +-- * Constructors imageNewFromFile, + imageNewFromPixbuf, + imageNewFromStock, + +-- * Methods + imageGetPixbuf, + imageSetFromPixbuf, + +-- * Icon Sizes IconSize, iconSizeMenu, iconSizeSmallToolbar, iconSizeLargeToolbar, iconSizeButton, iconSizeDialog, - imageNewFromStock, - imageGetPixbuf, - imageSetFromPixbuf, - imageNewFromPixbuf ) where import Monad (liftM) @@ -70,7 +123,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create an image by loading a file. -- @@ -82,6 +136,13 @@ withUTFString path {#call unsafe image_new_from_file#} #endif +-- | Create an 'Image' from a +-- 'Pixbuf'. +-- +imageNewFromPixbuf :: Pixbuf -> IO Image +imageNewFromPixbuf pbuf = makeNewObject mkImage $ liftM castPtr $ + {#call unsafe image_new_from_pixbuf#} pbuf + -- | Create a set of images by specifying a stock -- object. -- @@ -90,6 +151,9 @@ makeNewObject mkImage $ liftM castPtr $ {#call unsafe image_new_from_stock#} strPtr (fromIntegral ic) +-------------------- +-- Methods + -- | Extract the Pixbuf from the 'Image'. -- imageGetPixbuf :: Image -> IO Pixbuf @@ -97,15 +161,7 @@ throwIfNull "Image.imageGetPixbuf: The image contains no Pixbuf object." $ {#call unsafe image_get_pixbuf#} img - -- | Overwrite the current content of the 'Image' with a new 'Pixbuf'. -- imageSetFromPixbuf :: Image -> Pixbuf -> IO () imageSetFromPixbuf img pb = {#call unsafe gtk_image_set_from_pixbuf#} img pb - --- | Create an 'Image' from a --- 'Pixbuf'. --- -imageNewFromPixbuf :: Pixbuf -> IO Image -imageNewFromPixbuf pbuf = makeNewObject mkImage $ liftM castPtr $ - {#call unsafe image_new_from_pixbuf#} pbuf Index: ProgressBar.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Display/ProgressBar.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- ProgressBar.chs 12 Feb 2005 17:19:22 -0000 1.2 +++ ProgressBar.chs 25 Feb 2005 01:11:32 -0000 1.3 @@ -28,10 +28,50 @@ -- patient while some time intensive task is going on. -- module Graphics.UI.Gtk.Display.ProgressBar ( +-- * Description +-- +-- | The 'ProgressBar' is typically used to display the progress of a long +-- running operation. It provides a visual clue that processing is underway. +-- The 'ProgressBar' can be used in two different modes: percentage mode and +-- activity mode. +-- +-- 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 'ProgressBar' 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 'progressBarSetFraction' periodically to +-- update the progress bar. +-- +-- When an application has no accurate way of knowing the amount of work to +-- do, it can use the 'ProgressBar' 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 'progressBarPulse' perodically to update the +-- progress bar. +-- +-- There is quite a bit of flexibility provided to control the appearance of +-- the 'ProgressBar'. Functions 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. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Progress' +-- | +----ProgressBar +-- @ + +-- * Types ProgressBar, ProgressBarClass, castToProgressBar, + +-- * Constructors progressBarNew, + +-- * Methods progressBarPulse, progressBarSetText, progressBarSetFraction, @@ -55,7 +95,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new ProgreeBar. -- @@ -63,6 +104,9 @@ progressBarNew = makeNewObject mkProgressBar $ liftM castPtr $ {#call unsafe progress_bar_new#} +-------------------- +-- Methods + -- | Indicates that some progress is made, but you -- don't know how much. Causes the progress bar to enter \`activity mode', -- where a block bounces back and forth. Each call to @@ -141,4 +185,3 @@ progressBarGetOrientation pb = liftM (toEnum.fromIntegral) $ {#call unsafe progress_bar_get_orientation#} (toProgressBar pb) - Index: Statusbar.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Display/Statusbar.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Statusbar.chs 12 Feb 2005 17:19:22 -0000 1.2 +++ Statusbar.chs 25 Feb 2005 01:11:32 -0000 1.3 @@ -26,36 +26,64 @@ -- -- Report messages of minor importance to the user. -- --- * A Statusbar is usually placed along the bottom of an application's main --- Window. 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 FTP client, for example). +module Graphics.UI.Gtk.Display.Statusbar ( +-- * Description +-- +-- | A 'Statusbar' is usually placed along the bottom of an application's main +-- 'Window'. 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 FTP 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 Gtk+ maintain a stack of messages. The message at the top --- of the each bar's stack is the one that will currently be displayed. --- Any messages added to a statusbar's stack must specify a ContextId that --- is used to uniquely identify the source of a message. This ContextId can --- be generated by statusbarGetContextId, given a message and the statusbar --- that it will be added to. 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. --- Messages are added to the bar's stack with statusbarPush. The message at --- the top of the stack can be removed using statusbarPop. A message can be --- removed from anywhere in the stack if it's MessageId was recorded at the --- time it was added. This is done using statusbarRemove. +-- Status bars in Gtk+ maintain a stack of messages. The message at the top +-- of the each bar's stack is the one that will currently be displayed. -- -module Graphics.UI.Gtk.Display.Statusbar ( +-- Any messages added to a statusbar's stack must specify a /context_id/ +-- that is used to uniquely identify the source of a message. This context_id +-- can be generated by 'statusbarGetContextId', given a message and the +-- statusbar that it will be added to. 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. +-- +-- Status bars are created using 'statusbarNew'. +-- +-- Messages are added to the bar's stack with 'statusbarPush'. +-- +-- The message at the top of the stack can be removed using 'statusbarPop'. +-- A message can be removed from anywhere in the stack if its message_id was +-- recorded at the time it was added. This is done using 'statusbarRemove'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Box' +-- | +----'HBox' +-- | +----Statusbar +-- @ + +-- * Types Statusbar, StatusbarClass, castToStatusbar, + +-- * Constructors statusbarNew, + +-- * Methods statusbarGetContextId, statusbarPush, statusbarPop, statusbarRemove, statusbarSetHasResizeGrip, statusbarGetHasResizeGrip, + +-- * Signals onTextPopped, afterTextPopped, onTextPushed, @@ -72,7 +100,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new Statusbar. -- @@ -80,6 +109,9 @@ statusbarNew = makeNewObject mkStatusbar $ liftM castPtr {#call unsafe statusbar_new#} +-------------------- +-- Methods + type ContextId = {#type guint#} -- | Given a context description, this function @@ -124,7 +156,8 @@ statusbarGetHasResizeGrip sb = liftM toBool $ {#call unsafe statusbar_get_has_resize_grip#} (toStatusbar sb) --- signals +-------------------- +-- Signals -- | Called if a message is removed. -- Index: AccelLabel.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Display/AccelLabel.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- AccelLabel.chs 12 Feb 2005 17:19:21 -0000 1.2 +++ AccelLabel.chs 25 Feb 2005 01:11:32 -0000 1.3 @@ -24,17 +24,55 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- This widget is a special version of 'Label'. It displays an --- accelerator key next to the Label. --- --- * The key name is not explicitly set but taken from the key that --- is associated with the activation of another widget. +-- A label which displays an accelerator key on the right of the text. -- module Graphics.UI.Gtk.Display.AccelLabel ( +-- * Description +-- +-- | The 'AccelLabel' widget is a subclass of 'Label' that also displays an +-- accelerator key on the right of the label text, e.g. \'Ctl+S\'. It is +-- commonly used in menus to show the keyboard short-cuts for commands. +-- +-- The accelerator key to display is not set explicitly. Instead, the +-- 'AccelLabel' displays the accelerators which have been added to a particular +-- widget. This widget is set by calling 'accelLabelSetAccelWidget'. +-- +-- For example, a 'MenuItem' widget may have an accelerator added to emit +-- the \"activate\" signal when the \'Ctl+S\' key combination is pressed. A +-- 'AccelLabel' is created and added to the 'MenuItem', and +-- 'accelLabelSetAccelWidget' is called with the 'MenuItem' as the second +-- argument. The 'AccelLabel' will now display \'Ctl+S\' after its label. +-- +-- Note that creating a 'MenuItem' with 'menuItemNewWithLabel' (or one of +-- the similar functions for 'CheckMenuItem' and 'RadioMenuItem') automatically +-- adds a 'AccelLabel' to the 'MenuItem' and calls 'accelLabelSetAccelWidget' +-- to set it up for you. +-- +-- A 'AccelLabel' will only display accelerators which have 'AccelVisible' +-- set (see 'AccelFlags'). A 'AccelLabel' can display multiple accelerators and +-- even signal names, though it is almost always used to display just one +-- accelerator key. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Misc' +-- | +----'Label' +-- | +----AccelLabel +-- @ + +-- * Types AccelLabel, AccelLabelClass, castToAccelLabel, + +-- * Constructors accelLabelNew, + +-- * Methods accelLabelSetAccelWidget, accelLabelGetAccelWidget ) where @@ -49,7 +87,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new label with an accelerator key. -- @@ -57,6 +96,9 @@ accelLabelNew str = withUTFString str $ \strPtr -> makeNewObject mkAccelLabel $ liftM castPtr $ {#call unsafe accel_label_new#} strPtr +-------------------- +-- Methods + -- | Set the key name from the activation -- signal of another widget. -- Index: Label.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Display/Label.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Label.chs 12 Feb 2005 17:19:22 -0000 1.2 +++ Label.chs 25 Feb 2005 01:11:32 -0000 1.3 @@ -27,11 +27,100 @@ -- A widget that displays a small to medium amount of text. -- module Graphics.UI.Gtk.Display.Label ( +-- * Description +-- +-- | The 'Label' widget displays a small amount of text. As the name implies, +-- most labels are used to label another widget such as a 'Button', a +-- 'MenuItem', or a 'OptionMenu'. + +-- ** Mnemonics +-- +-- | Labels may contain mnemonics. Mnemonics are underlined characters in the +-- label, used for keyboard navigation. Mnemonics are created by providing a +-- string with an underscore before the mnemonic character, such as +-- @\"_File\"@, to the functions 'labelNewWithMnemonic' or +-- 'labelSetTextWithMnemonic'. +-- +-- Mnemonics automatically activate any activatable widget the label is +-- inside, such as a 'Button'; if the label is not inside the mnemonic's target +-- widget, you have to tell the label about the target using +-- 'labelSetMnemonicWidget'. Here's a simple example where the label is inside +-- a button: There's a convenience function to create buttons with a mnemonic +-- label already inside: To create a mnemonic for a widget alongside the label, +-- such as a 'Entry', you have to point the label at the entry with +-- 'labelSetMnemonicWidget': +-- +-- > -- Pressing Alt+H will activate this button +-- > button <- buttonNew +-- > label <- labelNewWithMnemonic "_Hello" +-- > containerAdd button label +-- +-- > -- Pressing Alt+H will activate this button +-- > button <- buttonNewWithMnemonic "_Hello" +-- +-- > -- Pressing Alt+H will focus the entry +-- > entry <- entryNew +-- > label <- labelNewWithMnemonic "_Hello" +-- > labelSetMnemonicWidget label entry + +-- ** Markup (styled text) +-- +-- | To make it easy to format text in a label (changing colors, fonts, etc.), +-- label text can be provided in a simple markup format. Here's how to create a +-- label with a small font: (See complete documentation of available tags in +-- the Pango manual.) +-- +-- > label <- labelNew Nothing +-- > labelSetMarkup label "<small>Small text</small>" +-- +-- The markup passed to 'labelSetMarkup' must be valid; for example, literal +-- \<\/>\/& characters must be escaped as @\"<\"@, @\">\"@, and +-- @\"&@\". If you pass +-- text obtained from the user, file, or a network to 'labelSetMarkup', you\'ll +-- want to escape it with 'gMarkupEscapeText'. + +-- ** Selectable labels +-- +-- | Labels can be made selectable with 'labelSetSelectable'. 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. + +-- ** Text layout +-- +-- | 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. +-- +-- Labels can automatically wrap text if you call 'labelSetLineWrap'. +-- +-- 'labelSetJustify' 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 'miscSetAlignment'. +-- + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Misc' +-- | +----Label +-- | +----'AccelLabel' +-- | +----'TipsQuery' +-- @ + +-- * Types Label, LabelClass, castToLabel, + +-- * Constructors labelNew, labelNewWithMnemonic, + +-- * Methods labelSetText, labelSetLabel, labelSetTextWithMnemonic, @@ -74,8 +163,8 @@ import Graphics.UI.Gtk.Pango.Markup {# context lib="gtk" prefix="gtk" #} - --- methods +-------------------- +-- Constructors -- | Create a new label widget. -- @@ -85,6 +174,19 @@ Nothing -> {#call label_new#} nullPtr (Just str) -> withUTFString str {#call label_new#} +-- | Create a new label widget with accelerator key. +-- +-- * Each underscore in @str@ is converted into an underlined character in the +-- label. Entering this character will activate the label widget or any other +-- widget set with 'labelSetMnemonicWidget'. +-- +labelNewWithMnemonic :: String -> IO Label +labelNewWithMnemonic str = makeNewObject mkLabel $ liftM castPtr $ + withUTFString str {#call label_new_with_mnemonic#} + +-------------------- +-- Methods + -- | Set the text the label widget shows. -- labelSetText :: LabelClass l => l -> String -> IO () @@ -222,16 +324,6 @@ labelGetLabel :: LabelClass l => l -> IO String labelGetLabel l = {#call unsafe label_get_label#} (toLabel l) >>= peekUTFString --- | Create a new label widget with accelerator key. --- --- * Each underscore in @str@ is converted into an underlined character in the --- label. Entering this character will activate the label widget or any other --- widget set with 'labelSetMnemonicWidget'. --- -labelNewWithMnemonic :: String -> IO Label -labelNewWithMnemonic str = makeNewObject mkLabel $ liftM castPtr $ - withUTFString str {#call label_new_with_mnemonic#} - -- | Select a region in the label. -- labelSelectRegion :: LabelClass l => l -> Int -> Int -> IO () |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:12:28
|
Update of /cvsroot/gtk2hs/gtk2hs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24163 Modified Files: ChangeLog Log Message: Add more module level documentation and tidy up exiting documentation. Also add/modify section headers. Also LGPL'ify remaining modules with permission from Matthew Walton. Index: ChangeLog =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v retrieving revision 1.365 retrieving revision 1.366 diff -u -d -r1.365 -r1.366 --- ChangeLog 24 Feb 2005 21:58:55 -0000 1.365 +++ ChangeLog 25 Feb 2005 01:11:30 -0000 1.366 @@ -1,4 +1,124 @@ -2005-02-23 Duncan Coutts <du...@co...> +2005-02-25 Duncan Coutts <du...@co...> + + * gtk/Graphics/UI/Gtk/Abstract/Bin.chs, + gtk/Graphics/UI/Gtk/Abstract/Box.chs, + gtk/Graphics/UI/Gtk/Abstract/ButtonBox.chs.pp, + gtk/Graphics/UI/Gtk/Abstract/Container.chs, + gtk/Graphics/UI/Gtk/Abstract/Misc.chs, + gtk/Graphics/UI/Gtk/Abstract/Object.chs.pp, + gtk/Graphics/UI/Gtk/Abstract/Paned.chs.pp, + gtk/Graphics/UI/Gtk/Abstract/Range.chs, + gtk/Graphics/UI/Gtk/Abstract/Scale.chs, + gtk/Graphics/UI/Gtk/Abstract/Widget.chs: add more module level + documentation and tidy up exiting documentation. Also add/modify + section headers. Also LGPL'ify remaining modules with permission from + Matthew Walton. + + * gtk/Graphics/UI/Gtk/Buttons/Button.chs.pp, + gtk/Graphics/UI/Gtk/Buttons/CheckButton.chs, + gtk/Graphics/UI/Gtk/Buttons/RadioButton.chs, + gtk/Graphics/UI/Gtk/Buttons/ToggleButton.chs: same for Buttons modules + + * gtk/Graphics/UI/Gtk/Display/AccelLabel.chs, + gtk/Graphics/UI/Gtk/Display/Image.chs.pp, + gtk/Graphics/UI/Gtk/Display/Label.chs, + gtk/Graphics/UI/Gtk/Display/ProgressBar.chs, + gtk/Graphics/UI/Gtk/Display/Statusbar.chs: same for Display modules + + * gtk/Graphics/UI/Gtk/Embedding/Plug.chs, + gtk/Graphics/UI/Gtk/Embedding/Socket.chs: same for Embedding modules + + * gtk/Graphics/UI/Gtk/Entry/Editable.chs.pp, + gtk/Graphics/UI/Gtk/Entry/Entry.chs.pp, + gtk/Graphics/UI/Gtk/Entry/EntryCompletion.chs.pp, + gtk/Graphics/UI/Gtk/Entry/HScale.chs, + gtk/Graphics/UI/Gtk/Entry/SpinButton.chs, + gtk/Graphics/UI/Gtk/Entry/VScale.chs: same for Entry modules + + * gtk/Graphics/UI/Gtk/General/IconFactory.chs.pp, + gtk/Graphics/UI/Gtk/General/Style.chs: same for General modules + + * gtk/Graphics/UI/Gtk/Layout/Alignment.chs.pp, + gtk/Graphics/UI/Gtk/Layout/AspectFrame.chs, + gtk/Graphics/UI/Gtk/Layout/Expander.chs.pp, + gtk/Graphics/UI/Gtk/Layout/Fixed.chs, + gtk/Graphics/UI/Gtk/Layout/HBox.chs, + gtk/Graphics/UI/Gtk/Layout/HButtonBox.chs, + gtk/Graphics/UI/Gtk/Layout/HPaned.chs, + gtk/Graphics/UI/Gtk/Layout/Layout.chs, + gtk/Graphics/UI/Gtk/Layout/Notebook.chs.pp, + gtk/Graphics/UI/Gtk/Layout/Table.chs, + gtk/Graphics/UI/Gtk/Layout/VBox.chs, + gtk/Graphics/UI/Gtk/Layout/VButtonBox.chs, + gtk/Graphics/UI/Gtk/Layout/VPaned.chs: same for Layout modules. Also + Also LGPL'ify remaining modules with permission from Matthew Walton. + + * gtk/Graphics/UI/Gtk/MenuComboToolbar/CheckMenuItem.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/Combo.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/ComboBox.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/ComboBoxEntry.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/ImageMenuItem.chs, + gtk/Graphics/UI/Gtk/MenuComboToolbar/Menu.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/MenuBar.chs, + gtk/Graphics/UI/Gtk/MenuComboToolbar/MenuItem.chs, + gtk/Graphics/UI/Gtk/MenuComboToolbar/MenuShell.chs, + gtk/Graphics/UI/Gtk/MenuComboToolbar/OptionMenu.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/RadioMenuItem.chs, + gtk/Graphics/UI/Gtk/MenuComboToolbar/TearoffMenuItem.chs, + gtk/Graphics/UI/Gtk/MenuComboToolbar/ToolItem.chs.pp, + gtk/Graphics/UI/Gtk/MenuComboToolbar/Toolbar.chs.pp: same for + MenuComboToolbar modules. + + * gtk/Graphics/UI/Gtk/Misc/Adjustment.chs, + gtk/Graphics/UI/Gtk/Misc/Calendar.chs.pp, + gtk/Graphics/UI/Gtk/Misc/DrawingArea.chs, + gtk/Graphics/UI/Gtk/Misc/EventBox.chs.pp, + gtk/Graphics/UI/Gtk/Misc/HandleBox.chs, + gtk/Graphics/UI/Gtk/Misc/SizeGroup.chs, + gtk/Graphics/UI/Gtk/Misc/Tooltips.chs.pp, + gtk/Graphics/UI/Gtk/Misc/Viewport.chs: same for Misc modules. + + * gtk/Graphics/UI/Gtk/Multiline/TextBuffer.chs, + gtk/Graphics/UI/Gtk/Multiline/TextMark.chs, + gtk/Graphics/UI/Gtk/Multiline/TextTag.chs.pp, + gtk/Graphics/UI/Gtk/Multiline/TextTagTable.chs, + gtk/Graphics/UI/Gtk/Multiline/TextView.chs: same for Multiline modules + + * gtk/Graphics/UI/Gtk/Ornaments/Frame.chs, + gtk/Graphics/UI/Gtk/Ornaments/HSeparator.chs, + gtk/Graphics/UI/Gtk/Ornaments/VSeparator.chs: same for the Ornaments + modules. + + * gtk/Graphics/UI/Gtk/Scrolling/HScrollbar.chs, + gtk/Graphics/UI/Gtk/Scrolling/ScrolledWindow.chs, + gtk/Graphics/UI/Gtk/Scrolling/VScrollbar.chs: same for the Scrolling + modules. + + * gtk/Graphics/UI/Gtk/Selectors/ColorSelection.chs, + gtk/Graphics/UI/Gtk/Selectors/ColorSelectionDialog.chs, + gtk/Graphics/UI/Gtk/Selectors/FileChooser.chs.pp, + gtk/Graphics/UI/Gtk/Selectors/FileChooserDialog.chs.pp, + gtk/Graphics/UI/Gtk/Selectors/FileChooserWidget.chs.pp, + gtk/Graphics/UI/Gtk/Selectors/FontSelection.chs, + gtk/Graphics/UI/Gtk/Selectors/FontSelectionDialog.chs: same for the + Selectors modules. + + * gtk/Graphics/UI/Gtk/TreeList/CellRendererPixbuf.chs, + gtk/Graphics/UI/Gtk/TreeList/CellRendererText.chs, + gtk/Graphics/UI/Gtk/TreeList/CellRendererToggle.chs, + gtk/Graphics/UI/Gtk/TreeList/ListStore.chs.pp, + gtk/Graphics/UI/Gtk/TreeList/TreeModel.chs.pp, + gtk/Graphics/UI/Gtk/TreeList/TreeModelSort.chs.pp, + gtk/Graphics/UI/Gtk/TreeList/TreeSelection.chs.pp, + gtk/Graphics/UI/Gtk/TreeList/TreeStore.chs.pp, + gtk/Graphics/UI/Gtk/TreeList/TreeView.chs.pp, + gtk/Graphics/UI/Gtk/TreeList/TreeViewColumn.chs.pp: same for the + TreeList modules. + + * gtk/Graphics/UI/Gtk/Windows/Dialog.chs, + gtk/Graphics/UI/Gtk/Windows/Window.chs.pp: same for Windows modules. + +2005-02-24 Duncan Coutts <du...@co...> * configure.ac: Bump version to 0.9.7.1 |
|
From: Duncan C. <dun...@us...> - 2005-02-25 01:12:15
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24163/gtk/Graphics/UI/Gtk/MenuComboToolbar Modified Files: CheckMenuItem.chs.pp Combo.chs.pp ComboBox.chs.pp ComboBoxEntry.chs.pp ImageMenuItem.chs Menu.chs.pp MenuBar.chs MenuItem.chs MenuShell.chs OptionMenu.chs.pp RadioMenuItem.chs TearoffMenuItem.chs ToolItem.chs.pp Toolbar.chs.pp Log Message: Add more module level documentation and tidy up exiting documentation. Also add/modify section headers. Also LGPL'ify remaining modules with permission from Matthew Walton. Index: Menu.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/Menu.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Menu.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ Menu.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 @@ -19,6 +19,16 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- +-- TODO +-- +-- The following not bound functions might be useful: +-- menuSetAccelGroup, menuSetAccelGroup, menuReposition +-- +-- The function menuPopup at a specific position is difficult to bind: +-- The callback function that determines at which position the menu is +-- to be shown is keept after the call returns. Maybe we could destroy +-- this function pointer with a destory event? +-- -- | -- Maintainer : gtk...@li... -- Stability : provisional @@ -28,21 +38,42 @@ -- are two kinds: Those that are part of a 'MenuBar' and those -- that appear as a context menu (within the work space). -- --- TODO +module Graphics.UI.Gtk.MenuComboToolbar.Menu ( +-- * Description +-- +-- | A 'Menu' is a 'MenuShell' that implements a drop down menu consisting of +-- a list of 'MenuItem' objects which can be navigated and activated by the +-- user to perform application functions. -- --- * The following not bound functions might be useful: --- menuSetAccelGroup, menuSetAccelGroup, menuReposition +-- A 'Menu' is most commonly dropped down by activating a 'MenuItem' in a +-- 'MenuBar' or popped up by activating a 'MenuItem' in another 'Menu'. -- --- * The function menuPopup at a specific position is difficult to bind: --- The callback function that determines at which position the menu is --- to be shown is keept after the call returns. Maybe we could destroy --- this function pointer with a destory event? +-- A 'Menu' can also be popped up by activating a 'OptionMenu'. Other +-- composite widgets such as the 'Notebook' can pop up a 'Menu' as well. -- -module Graphics.UI.Gtk.MenuComboToolbar.Menu ( +-- Applications can display a 'Menu' as a popup menu by calling the +-- 'menuPopup' function. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'MenuShell' +-- | +----Menu +-- @ + +-- * Types Menu, MenuClass, castToMenu, + +-- * Constructors menuNew, + +-- * Methods menuReorderChild, menuPopup, menuSetAccelGroup, @@ -80,7 +111,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Make an empty Menu. -- @@ -88,6 +120,9 @@ menuNew = makeNewObject mkMenu $ liftM castPtr {#call unsafe menu_new#} +-------------------- +-- Methods + -- | Move a child to a new position within the menu. -- -- * The position is counted from 0 to n-1 if the menu contains n entries. Index: ToolItem.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/ToolItem.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- ToolItem.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ ToolItem.chs.pp 25 Feb 2005 01:11:35 -0000 1.3 @@ -24,22 +24,43 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- ToolItem is the base class of widgets that can be added to a "Toolbar". --- --- * Added in GTK+ 2.4 +-- 'ToolItem' is the base class of widgets that can be added to 'Toolbar'. -- module Graphics.UI.Gtk.MenuComboToolbar.ToolItem ( -- * Description -- --- | "ToolItem"s are widgets that can appear on a toolbar. To create a toolbar +-- | 'ToolItem's are widgets that can appear on a toolbar. To create a toolbar -- item that contain something else than a button, use 'toolItemNew'. Use -- 'containerAdd' to add a child widget to the tool item. -- --- For toolbar items that contain buttons, see the "ToolButton", --- "ToggleToolButton" and "RadioToolButton" classes. +-- For toolbar items that contain buttons, see the 'ToolButton', +-- 'ToggleToolButton' and 'RadioToolButton' classes. -- +-- * Module available since Gtk version 2.4 + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----ToolItem +-- | +----'ToolButton' +-- | +----'SeparatorToolItem' +-- @ + #if GTK_CHECK_VERSION(2,4,0) +-- * Types + ToolItem, + ToolItemClass, + castToToolItem, + +-- * Constructors toolItemNew, + +-- * Methods toolItemSetHomogeneous, toolItemGetHomogeneous, toolItemSetExpand, @@ -81,12 +102,18 @@ {# context lib="gtk" prefix="gtk" #} +-------------------- +-- Constructors + -- | Creates a new "ToolItem". -- toolItemNew :: IO ToolItem toolItemNew = makeNewObject mkToolItem {#call unsafe tool_item_new#} +-------------------- +-- Methods + -- | Sets whether 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. Index: RadioMenuItem.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/RadioMenuItem.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- RadioMenuItem.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ RadioMenuItem.chs 25 Feb 2005 01:11:35 -0000 1.3 @@ -31,9 +31,31 @@ -- widget interface. -- module Graphics.UI.Gtk.MenuComboToolbar.RadioMenuItem ( +-- * Description +-- +-- | A radio menu item is a check menu item that belongs to a group. At each +-- instant exactly one of the radio menu items from a group is selected. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Item' +-- | +----'MenuItem' +-- | +----'CheckMenuItem' +-- | +----RadioMenuItem +-- @ + +-- * Types RadioMenuItem, RadioMenuItemClass, castToRadioMenuItem, + +-- * Constructors radioMenuItemNew, radioMenuItemNewWithLabel, radioMenuItemNewWithMnemonic, @@ -57,7 +79,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new radio menu item. -- Index: MenuBar.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/MenuBar.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- MenuBar.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ MenuBar.chs 25 Feb 2005 01:11:35 -0000 1.3 @@ -24,12 +24,33 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- A subclass widget for "MenuShell" which holds "MenuItem" widgets +-- A subclass widget for 'MenuShell' which holds 'MenuItem' widgets -- module Graphics.UI.Gtk.MenuComboToolbar.MenuBar ( +-- * Description +-- +-- | The 'MenuBar' is a subclass of 'MenuShell' which contains one to many +-- 'MenuItem'. The result is a standard menu bar which can hold many menu +-- items. 'MenuBar' allows for a shadow type to be set for aesthetic purposes. +-- The shadow types are defined in the 'menuBarSetShadowType' function. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'MenuShell' +-- | +----MenuBar +-- @ + +-- * Types MenuBar, MenuBarClass, castToMenuBar, + +-- * Constructors menuBarNew ) where @@ -42,7 +63,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a horizontal bar that contains menu items. -- Index: Combo.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/Combo.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Combo.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ Combo.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 @@ -19,29 +19,56 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- +-- TODO +-- +-- The combo_set_item_string function is not bound as we do not handle +-- arbitrary widgets yet. +-- -- | --- Maintainer : gtk2hs-users\@lists.sourceforge.net +-- Maintainer : gtk...@li... -- Stability : provisional -- Portability : portable (depends on GHC) -- -- A Combo box is a text entry field with a drop down list of predefined -- alternatives. -- --- * The Combo widget allows to insert arbitrary widgets as alternatives. Due --- to the deprecated ListItem object we currently make no use of this --- feature. +module Graphics.UI.Gtk.MenuComboToolbar.Combo ( +-- * Description +-- +-- | The 'Combo' 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. -- --- TODO +-- List elements +-- can contain arbitrary widgets, but if an element is not a plain label, then +-- you must use the 'listSetItemString' function. This sets the string which +-- will be placed in the text entry field when the item is selected. -- --- * The combo_set_item_string function is not bound as we do not handle --- arbitrary widgets yet. +-- By default, the user can step through the items in the list using the +-- arrow (cursor) keys, though this behaviour can be turned off with +-- 'comboSetUseArrows'. -- -module Graphics.UI.Gtk.MenuComboToolbar.Combo ( +-- As of Gtk+ 2.4, 'Combo' has been deprecated in favor of 'ComboBox'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Box' +-- | +----'HBox' +-- | +----Combo +-- @ #ifndef DISABLE_DEPRECATED +-- * Types Combo, ComboClass, castToCombo, comboNew, + +-- * Methods comboSetPopdownStrings, comboSetValueInList, comboSetUseArrows, @@ -65,7 +92,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Methods -- Create a new Combo text entry field. -- Index: CheckMenuItem.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/CheckMenuItem.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- CheckMenuItem.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ CheckMenuItem.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 @@ -27,11 +27,40 @@ -- This widget implements a 'MenuItem' with a check next to it. -- module Graphics.UI.Gtk.MenuComboToolbar.CheckMenuItem ( +-- * Description +-- +-- | A 'CheckMenuItem' is a menu item that maintains the state of a boolean +-- value in addition to a 'MenuItem''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 'MenuItem'. Activating the 'MenuItem' toggles the value. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Item' +-- | +----'MenuItem' +-- | +----CheckMenuItem +-- | +----'RadioMenuItem' +-- @ + +-- * Types CheckMenuItem, CheckMenuItemClass, + castToCheckMenuItem, + +-- * Constructors checkMenuItemNew, checkMenuItemNewWithLabel, checkMenuItemNewWithMnemonic, + +-- * Methods checkMenuItemSetActive, checkMenuItemGetActive, checkMenuItemToggled, @@ -53,7 +82,8 @@ {#context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new 'MenuItem' with a check next to it. -- @@ -77,6 +107,9 @@ makeNewObject mkCheckMenuItem $ liftM castPtr $ {#call unsafe check_menu_item_new_with_mnemonic#} strPtr +-------------------- +-- Methods + -- | Sets the active state of the menu item's check box. -- checkMenuItemSetActive :: CheckMenuItemClass mi => mi -> Bool -> IO () Index: Toolbar.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/Toolbar.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- Toolbar.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ Toolbar.chs.pp 25 Feb 2005 01:11:35 -0000 1.3 @@ -50,6 +50,16 @@ -- Creating a context menu for the toolbar can be done using -- 'onPopupContextMenu'. +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----Toolbar +-- @ + #ifndef DISABLE_DEPRECATED -- | * The following information applies to the old interface only. -- @@ -70,12 +80,17 @@ -- honored this way. #endif +-- * Types Toolbar, ToolbarClass, castToToolbar, Orientation(..), ToolbarStyle(..), + +-- * Constructors toolbarNew, + +-- * Methods #ifndef DISABLE_DEPRECATED toolbarInsertNewButton, toolbarAppendNewButton, @@ -148,7 +163,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new, empty toolbar. -- @@ -163,6 +179,9 @@ mkToolText (Just (text,private)) fun = withUTFString text $ \txtPtr -> withUTFString private $ \prvPtr -> fun txtPtr prvPtr +-------------------- +-- Methods + #ifndef DISABLE_DEPRECATED -- | Insert a new 'Button' into the 'Toolbar'. -- @@ -486,7 +505,8 @@ {#call unsafe toolbar_get_relief_style#} (toToolbar tb) #endif --- signals +-------------------- +-- Signals -- | Emitted when toolbarSetOrientation is called. -- Index: OptionMenu.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/OptionMenu.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- OptionMenu.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ OptionMenu.chs.pp 25 Feb 2005 01:11:35 -0000 1.3 @@ -20,21 +20,56 @@ -- Lesser General Public License for more details. -- -- | --- Maintainer : gtk2hs-users\@lists.sourceforge.net +-- Maintainer : gtk...@li... -- Stability : provisional -- Portability : portable (depends on GHC) -- +-- A widget used to choose from a list of valid choices. +-- module Graphics.UI.Gtk.MenuComboToolbar.OptionMenu ( +-- * Description +-- +-- | A 'OptionMenu' is a widget that allows the user to choose from a list of +-- valid choices. The 'OptionMenu' displays the selected choice. When activated +-- the 'OptionMenu' displays a popup 'Menu' which allows the user to make a new +-- choice. +-- +-- Using a 'OptionMenu' is simple; build a 'Menu', by calling 'menuNew', +-- then appending menu items to it with 'menuShellAppend'. Set that menu on the +-- option menu with 'optionMenuSetMenu'. Set the selected menu item with +-- 'optionMenuSetHistory'; connect to the \"changed\" signal on the option +-- menu; in the \"changed\" signal, check the new selected menu item with +-- 'optionMenuGetHistory'. +-- +-- As of Gtk+ 2.4, 'OptionMenu' has been deprecated in favor of 'ComboBox'. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Button' +-- | +----OptionMenu +-- @ + #ifndef DISABLE_DEPRECATED +-- * Types OptionMenu, OptionMenuClass, castToOptionMenu, + +-- * Methods optionMenuNew, optionMenuGetMenu, optionMenuSetMenu, optionMenuRemoveMenu, optionMenuSetHistory, optionMenuGetHistory, + +-- * Signals onOMChanged, afterOMChanged #endif @@ -50,7 +85,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Methods -- | Create a new option menu. -- @@ -91,7 +127,8 @@ optionMenuGetHistory om = liftM fromIntegral $ {#call unsafe option_menu_get_history#} (toOptionMenu om) --- signals +-------------------- +-- Signals -- | This signal is called if the selected option has changed. -- Index: ComboBoxEntry.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/ComboBoxEntry.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- ComboBoxEntry.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ ComboBoxEntry.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 @@ -29,12 +29,34 @@ -- * Added in gtk 2.4 -- module Graphics.UI.Gtk.MenuComboToolbar.ComboBoxEntry ( +-- * Description +-- +-- | * Module available since Gtk version 2.4 + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'ComboBox' +-- | +----ComboBoxEntry +-- @ + #if GTK_CHECK_VERSION(2,4,0) - ComboBoxEntryClass, +-- * Types ComboBoxEntry, + ComboBoxEntryClass, + castToComboBoxEntry, + +-- * Constructors comboBoxEntryNew, comboBoxEntryNewWithModel, comboBoxEntryNewText, + +-- * Methods comboBoxEntrySetTextColumn, comboBoxEntryGetTextColumn, #endif @@ -51,6 +73,8 @@ {# context lib="gtk" prefix ="gtk" #} +-------------------- +-- Constructors comboBoxEntryNew :: IO ComboBoxEntry comboBoxEntryNew = @@ -67,6 +91,9 @@ makeNewObject mkComboBoxEntry $ liftM castPtr $ {# call gtk_combo_box_entry_new_text #} +-------------------- +-- Methods + comboBoxEntrySetTextColumn :: ComboBoxEntryClass combo => combo -> Int -> IO () comboBoxEntrySetTextColumn combo textColumn = {# call gtk_combo_box_entry_set_text_column #} (toComboBoxEntry combo) Index: TearoffMenuItem.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/TearoffMenuItem.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- TearoffMenuItem.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ TearoffMenuItem.chs 25 Feb 2005 01:11:35 -0000 1.3 @@ -24,19 +24,42 @@ -- Stability : provisional -- Portability : portable (depends on GHC) -- --- * A TearoffMenuItem is a special GtkMenuItem which is used to tear off --- and reattach its menu. When its menu is shown normally, the --- TearoffMenuItem 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 TearoffMenuItem is drawn as a dotted line which has a left --- pointing arrow graphic indicating that the tearoff menu can be reattached. --- Activating it will erase the tearoff menu window. +-- A menu item used to tear off and reattach its menu. -- module Graphics.UI.Gtk.MenuComboToolbar.TearoffMenuItem ( +-- * Description +-- +-- | a 'TearoffMenuItem' is a special 'MenuItem' which is used to tear off and +-- reattach its menu. +-- +-- When its menu is shown normally, the 'TearoffMenuItem' 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 'TearoffMenuItem' is drawn +-- as a dotted line which has a left pointing arrow graphic indicating that the +-- tearoff menu can be reattached. Activating it will erase the tearoff menu +-- window. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Item' +-- | +----'MenuItem' +-- | +----TearoffMenuItem +-- @ + +-- * Types TearoffMenuItem, TearoffMenuItemClass, castToTearoffMenuItem, + +-- * Constructors tearoffMenuItemNew ) where @@ -49,11 +72,11 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new tear off menu item. -- tearoffMenuItemNew :: IO TearoffMenuItem tearoffMenuItemNew = makeNewObject mkTearoffMenuItem $ liftM castPtr {#call unsafe tearoff_menu_item_new#} - Index: MenuItem.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/MenuItem.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- MenuItem.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ MenuItem.chs 25 Feb 2005 01:11:35 -0000 1.3 @@ -19,6 +19,13 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- Lesser General Public License for more details. -- +-- TODO +-- +-- figure out what the signals \"toggle-size-allocate\" and +-- \"toggle-size-request\" are good for and bind them if useful +-- +-- figure out if the connectToToggle signal is useful at all +-- -- | -- Maintainer : gtk...@li... -- Stability : provisional @@ -30,20 +37,43 @@ -- is the only child of that widget. The three signals defined by Item are -- therefore bound in this module. -- --- TODO --- --- * figure out what the signals \"toggle-size-allocate\" and --- \"toggle-size-request\" are good for and bind them if useful --- --- * figure out if the connectToToggle signal is useful at all --- module Graphics.UI.Gtk.MenuComboToolbar.MenuItem ( +-- * Description +-- +-- | The 'MenuItem' widget and the derived widgets are the only valid childs +-- for menus. Their function is to correctly handle highlighting, alignment, +-- events and submenus. +-- +-- As it derives from 'Bin' it can hold any valid child widget, altough only +-- a few are really useful. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Item' +-- | +----MenuItem +-- | +----'CheckMenuItem' +-- | +----'ImageMenuItem' +-- | +----'SeparatorMenuItem' +-- | +----'TearoffMenuItem' +-- @ + +-- * Types MenuItem, MenuItemClass, castToMenuItem, + +-- * Constructors menuItemNew, menuItemNewWithLabel, menuItemNewWithMnemonic, + +-- * Methods menuItemSetSubmenu, menuItemGetSubmenu, menuItemRemoveSubmenu, @@ -57,6 +87,8 @@ afterActivateLeaf, onActivateItem, afterActivateItem, + +-- * Signals onSelect, afterSelect, onDeselect, @@ -75,7 +107,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Constructors -- | Create a new menu item. This is the smallest part -- of a menu that the user can click on or select with the keyboard. @@ -99,6 +132,9 @@ makeNewObject mkMenuItem $ liftM castPtr $ {#call unsafe menu_item_new_with_mnemonic#} strPtr +-------------------- +-- Methods + -- | Set the item's submenu. -- menuItemSetSubmenu :: (MenuItemClass mi, MenuClass m) => mi -> m -> IO () @@ -165,7 +201,8 @@ maybeWith withCString accelPath $ \strPtr -> {#call menu_item_set_accel_path#} (toMenuItem mi) strPtr --- signals +-------------------- +-- Signals -- | The user has chosen the menu item and the item does not contain a submenu. -- Index: ComboBox.chs.pp =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/ComboBox.chs.pp,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- ComboBox.chs.pp 12 Feb 2005 17:19:23 -0000 1.2 +++ ComboBox.chs.pp 25 Feb 2005 01:11:34 -0000 1.3 @@ -29,11 +29,34 @@ -- * Added in Gtk 2.4 -- module Graphics.UI.Gtk.MenuComboToolbar.ComboBox ( +-- * Description +-- +-- | * Module available since Gtk version 2.4 + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----ComboBox +-- | +----'ComboBoxEntry' +-- @ + #if GTK_CHECK_VERSION(2,4,0) - ComboBoxClass, +-- * Types ComboBox, + ComboBoxClass, + castToComboBox, + +-- * Constructors comboBoxNew, + comboBoxNewText, comboBoxNewWithModel, + +-- * Methods comboBoxSetWrapWidth, comboBoxSetRowSpanColumn, comboBoxSetColumnSpanColumn, @@ -43,7 +66,6 @@ comboBoxSetActiveIter, comboBoxGetModel, comboBoxSetModel, - comboBoxNewText, comboBoxAppendText, comboBoxInsertText, comboBoxPrependText, @@ -67,17 +89,27 @@ {# context lib="gtk" prefix ="gtk" #} +-------------------- +-- Constructors comboBoxNew :: IO ComboBox comboBoxNew = makeNewObject mkComboBox $ liftM castPtr $ {# call gtk_combo_box_new #} +comboBoxNewText :: IO ComboBox +comboBoxNewText = + makeNewObject mkComboBox $ liftM castPtr $ + {# call gtk_combo_box_new_text #} + comboBoxNewWithModel :: TreeModel -> IO ComboBox comboBoxNewWithModel model = makeNewObject mkComboBox $ liftM castPtr $ {# call gtk_combo_box_new_with_model #} model +-------------------- +-- Methods + comboBoxSetWrapWidth :: ComboBoxClass combo => combo -> Int -> IO () comboBoxSetWrapWidth combo width = {# call gtk_combo_box_set_wrap_width #} (toComboBox combo) @@ -128,11 +160,6 @@ comboBoxSetModel combo model = {# call gtk_combo_box_set_model #} (toComboBox combo) model -comboBoxNewText :: IO ComboBox -comboBoxNewText = - makeNewObject mkComboBox $ liftM castPtr $ - {# call gtk_combo_box_new_text #} - comboBoxAppendText :: ComboBoxClass combo => combo -> String -> IO () comboBoxAppendText combo text = withUTFString text $ \strPtr -> Index: MenuShell.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/MenuShell.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- MenuShell.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ MenuShell.chs 25 Feb 2005 01:11:35 -0000 1.3 @@ -28,15 +28,42 @@ -- menu items. -- module Graphics.UI.Gtk.MenuComboToolbar.MenuShell ( +-- * Description +-- +-- | A 'MenuShell' is the abstract base class used to derive the 'Menu' and +-- 'MenuBar' subclasses. +-- +-- A 'MenuShell' is a container of 'MenuItem' objects arranged in a list +-- which can be navigated, selected, and activated by the user to perform +-- application functions. A 'MenuItem' can have a submenu associated with it, +-- allowing for nested hierarchical menus. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----MenuShell +-- | +----'MenuBar' +-- | +----'Menu' +-- @ + +-- * Types MenuShell, MenuShellClass, castToMenuShell, + +-- * Methods menuShellAppend, menuShellPrepend, menuShellInsert, menuShellDeactivate, menuShellSelectItem, menuShellDeselect, + +-- * Signals onActivateCurrent, afterActivateCurrent, onCancel, @@ -60,7 +87,8 @@ {# context lib="gtk" prefix="gtk" #} --- methods +-------------------- +-- Methods -- | Append the new entry @child@ to a menu. -- @@ -110,7 +138,8 @@ menuShellDeselect ms = {#call menu_shell_deselect#} (toMenuShell ms) --- signals +-------------------- +-- Signals -- | This signal is called if an item is -- activated. The boolean flag @hide@ is True whenever the menu will Index: ImageMenuItem.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/MenuComboToolbar/ImageMenuItem.chs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- ImageMenuItem.chs 12 Feb 2005 17:19:23 -0000 1.2 +++ ImageMenuItem.chs 25 Feb 2005 01:11:34 -0000 1.3 @@ -31,14 +31,41 @@ -- * imageMenuItemNewFromSock should also have a AccelGroup argument -- module Graphics.UI.Gtk.MenuComboToolbar.ImageMenuItem ( +-- * Description +-- +-- | A 'ImageMenuItem' is a menu item which has an icon next to the text +-- label. +-- +-- Note that the user can disable display of menu icons, so make sure to +-- still fill in the text label. + +-- * Class Hierarchy +-- | +-- @ +-- | 'GObject' +-- | +----'Object' +-- | +----'Widget' +-- | +----'Container' +-- | +----'Bin' +-- | +----'Item' +-- | +----'MenuItem' +-- | +----ImageMenuItem +-- @ + +-- * Types ImageMenuItem, ImageMenuItemClass, - imageMenuItemSetImage, - imageMenuItemGetImage, + castToImageMenuItem, + +-- * Constructors imageMenuItemNew, imageMenuItemNewFromStock, imageMenuItemNewWithLabel, - imageMenuItemNewWithMnemonic + imageMenuItemNewWithMnemonic, + +-- * Methods + imageMenuItemSetImage, + imageMenuItemGetImage ) where import Monad (liftM) @@ -51,24 +78,8 @@ {#context lib="gtk" prefix="gtk" #} --- methods - - --- | Sets the image for the ImageMenuItem. --- -imageMenuItemSetImage :: (ImageMenuItemClass imi,WidgetClass wd) => - imi -> wd -> IO () -imageMenuItemSetImage imi wd = - {#call unsafe image_menu_item_set_image#} (toImageMenuItem imi) - (toWidget wd) - --- | Get the image that is currently set a the image. --- -imageMenuItemGetImage :: ImageMenuItemClass imi => imi -> IO (Maybe Widget) -imageMenuItemGetImage imi = do - imPtr <- {#call unsafe image_menu_item_get_image#} (toImageMenuItem imi) - if imPtr==nullPtr then return Nothing else do - liftM Just $ makeNewObject mkWidget $ return imPtr +-------------------- +-- Constructors -- | Create a new 'MenuItem' with a image next to it. -- @@ -98,3 +109,22 @@ imageMenuItemNewWithMnemonic str = withUTFString str $ \strPtr -> makeNewObject mkImageMenuItem $ liftM castPtr $ {#call unsafe image_menu_item_new_with_mnemonic#} strPtr + +-------------------- +-- Methods + +-- | Sets the image for the ImageMenuItem. +-- +imageMenuItemSetImage :: (ImageMenuItemClass imi,WidgetClass wd) => + imi -> wd -> IO () +imageMenuItemSetImage imi wd = + {#call unsafe image_menu_item_set_image#} (toImageMenuItem imi) + (toWidget wd) + +-- | Get the image that is currently set a the image. +-- +imageMenuItemGetImage :: ImageMenuItemClass imi => imi -> IO (Maybe Widget) +imageMenuItemGetImage imi = do + imPtr <- {#call unsafe image_menu_item_get_image#} (toImageMenuItem imi) + if imPtr==nullPtr then return Nothing else do + liftM Just $ makeNewObject mkWidget $ return imPtr |
2 messages has been excluded from this view by a project administrator.
