Re: Comments on toolbar

[Matthias Clasen <maclas gmx de>]

Am Die, 2003-07-01 um 02.56 schrieb Owen Taylor:
> On Sun, 2003-06-29 at 21:00, Soeren Sandmann wrote:
> > Owen Taylor <otaylor redhat com> writes:
> 
> > > Comments about relationship between properties for GtkToolButton
> 
> [....]
> 
> > This is a thing that I did totally different since your last
> > comments.
> 
> OK, a point for me for being consistent in the things I comment
> on, a point against me for not remembering that I had commented
> on it earlier or noticing that you had fixed it.
> 
> > The way it is intended to work currently is like your first
> > possibility with the exception that "icon_widget" and "icon_set" are
> > mutually exclusive.
> > 
> > Here is a quote from the libegg ChangeLog:
> > 
> >         Properties are now interpreted like this:
> > 
> >               - icon_set and icon_widget are mutually exclusive.
> > 
> >               - if the tool button has an icon_set or an icon_widget,
> >                 these will be used as icons. Otherwise, if the tool
> >                 button has a stock id, the corresponding stock icon
> >                 will be used. Otherwise, the tool button will not have
> >                 an icon.
> > 
> >               - if the tool button has a label widget then that widget
> >                 will be used as label. Otherwise, if the tool button
> >                 has a label text, that text will be used as
> >                 label. Otherwise, if the toolbutton has a stock id,
> >                 the corresponding text will be used as
> >                 label. Otherwise, the toolbutton will have an empty
> >                 label.
> >
> >               - the use_underline property means that underlines in
> >                 the label property are "elided".
> 
> Having this type of information commented in the code would be very
> useful. (Perhaps in the docs, though it's hard to fit it into the
> property doc strings. You could have hings 
> "Overrides 'label'.t" in the 
> 

We can document signals and properties with inline doc comment now, so
there's no need to squeeze too much information in the (essentially
1-line) blurb. See gtkwidget.c for some examples.

Matthias