Menu
▾
▴
[Gtk2hs-commit] gtk2hs/gtk/ornaments Frame.chs,1.3,1.4 HSeparator.chs,1.3,1.4 VSeparator.chs,1.3,1.4
|
From: Duncan C. <dun...@us...> - 2004-05-23 16:11:21
|
Update of /cvsroot/gtk2hs/gtk2hs/gtk/ornaments In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17652/gtk/ornaments Modified Files: Frame.chs HSeparator.chs VSeparator.chs Log Message: initial haddockification Index: Frame.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/ornaments/Frame.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Frame.chs 9 Jul 2003 22:42:45 -0000 1.3 +++ Frame.chs 23 May 2004 16:10:57 -0000 1.4 @@ -1,5 +1,5 @@ -- -*-haskell-*- --- GIMP Toolkit (GTK) @entry Widget Frame@ +-- GIMP Toolkit (GTK) Widget Frame -- -- Author : Axel Simon -- @@ -19,15 +19,11 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -- GNU General Public License for more details. -- --- @description@ -------------------------------------------------------------- --- --- * This container adds a frame around its contents. This is useful to --- logically separate items in a dialog box. --- --- @documentation@ ------------------------------------------------------------ +-- | -- +-- This container adds a frame around its contents. This is useful to +-- logically separate items in a dialog box. -- --- @todo@ --------------------------------------------------------------------- module Frame( Frame, @@ -54,27 +50,27 @@ -- methods --- @constructor frameNew@ Create a new frame without a label. +-- | Create a new frame without a label. -- --- * A label can later be set by calling @ref method frameSetLabel@. +-- * A label can later be set by calling 'frameSetLabel'. -- frameNew :: IO Frame frameNew = makeNewObject mkFrame $ liftM castPtr $ {#call unsafe frame_new#} nullPtr --- @method frameSetLabel@ Replace the label of the frame. +-- | Replace the label of the frame. -- frameSetLabel :: FrameClass f => f -> String -> IO () frameSetLabel f label = withUTFString label $ \strPtr -> {#call frame_set_label#} (toFrame f) strPtr --- @method frameSetLabelWidget@ Replace the label with a (label) widget. +-- | Replace the label with a (label) widget. -- frameSetLabelWidget :: (FrameClass f, WidgetClass w) => f -> w -> IO () frameSetLabelWidget f w = {#call frame_set_label_widget#} (toFrame f) (toWidget w) --- @method frameSetLabelAlign@ Specify where the label should be placed. +-- | Specify where the label should be placed. -- -- * A value of 0.0 means left justified (the default), a value of 1.0 means -- right justified. @@ -83,15 +79,15 @@ frameSetLabelAlign f align = {#call frame_set_label_align#} (toFrame f) (realToFrac align) 0.0 --- @method frameSetShadowType@ Set the shadow type of the frame. +-- | Set the shadow type of the frame. -- frameSetShadowType :: FrameClass f => f -> ShadowType -> IO () frameSetShadowType f shadow = {#call frame_set_shadow_type#} (toFrame f) ((fromIntegral.fromEnum) shadow) --- @method frameGetLabel@ Retrieve the label of the frame. +-- | Retrieve the label of the frame. -- --- * An exception is thrown if a non-Label widget was set. (EXPORTED) +-- * An exception is thrown if a non-Label widget was set. -- frameGetLabel :: FrameClass f => f -> IO String frameGetLabel f = do Index: HSeparator.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/ornaments/HSeparator.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- HSeparator.chs 9 Jul 2003 22:42:45 -0000 1.3 +++ HSeparator.chs 23 May 2004 16:10:57 -0000 1.4 @@ -1,5 +1,5 @@ -- -*-haskell-*- --- GIMP Toolkit (GTK) @entry Widget HSeparator@ +-- GIMP Toolkit (GTK) Widget HSeparator -- -- Author : Axel Simon -- @@ -19,18 +19,14 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -- GNU General Public License for more details. -- --- @description@ -------------------------------------------------------------- +-- | -- --- * The HSeparator widget is a horizontal separator, used to group the --- widgets within a window. It displays a horizontal line with a shadow --- to make it appear sunken into the interface. +-- The HSeparator widget is a horizontal separator, used to group the +-- widgets within a window. It displays a horizontal line with a shadow +-- to make it appear sunken into the interface. -- -- * This has nothing to do with a menu separator. -- --- @documentation@ ------------------------------------------------------------ --- --- --- @todo@ --------------------------------------------------------------------- module HSeparator( HSeparator, Index: VSeparator.chs =================================================================== RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/ornaments/VSeparator.chs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- VSeparator.chs 9 Jul 2003 22:42:45 -0000 1.3 +++ VSeparator.chs 23 May 2004 16:10:57 -0000 1.4 @@ -1,5 +1,5 @@ -- -*-haskell-*- --- GIMP Toolkit (GTK) @entry Widget VSeparator@ +-- GIMP Toolkit (GTK) Widget VSeparator -- -- Author : Axel Simon -- @@ -19,18 +19,14 @@ -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -- GNU General Public License for more details. -- --- @description@ -------------------------------------------------------------- +-- | -- --- * The VSeparator widget is a horizontal separator, used to group the --- widgets within a window. It displays a horizontal line with a shadow --- to make it appear sunken into the interface. +-- The VSeparator widget is a horizontal separator, used to group the +-- widgets within a window. It displays a horizontal line with a shadow +-- to make it appear sunken into the interface. -- -- * This has nothing to do with a menu separator. -- --- @documentation@ ------------------------------------------------------------ --- --- --- @todo@ --------------------------------------------------------------------- module VSeparator( VSeparator, |