maemo.org Bugzilla – Bug 4598
HildonCheckButton documentation doesn't say why it exists
Last modified: 2009-09-11 15:17:40 UTC
You need to log in before you can comment on or make changes to this bug.
The HildonCheckButtons documentation http://maemo.org/api_refs/5.0/alpha/libhildon/HildonCheckButton.html#HildonCheckButton.description does not say why this class exists and should be used instead of GtkCheckButton. A screenshot might make that clearer but it should also be explained in text. Hopefully this does more than just a rethemed GtkCheckButton.
Moving to the widgets.
Mass-adding the new "docs" keyword. Sorry for the noise - You can filter your bugmail by searching for "docs-cleanup-20090610".
So - why does the widget exist? Anyone know?
HildonCheckButton is very similar to GtkCheckButton, but it was created because it was not possible to obtain the desired look using existing Gtk widgets. So maybe it's a good idea to add a short note explaining that.
How about something like this?: "HildonCheckButton is similar to the GtkCheckButton widget, but with a different look that combines the appearance of a standard button with that of a check box."
I think you need to mention that this could not be done by theming alone. I take your word for that. I guess you can ignore that this could be done by changing the GTK+ implementation because there seems to be general disagreement about whether easier porting is preferable to API changes. And you should mention that this appearance (not "look") is demanded by the Hildon HIG, conveniently ignoring the fact that the Hildon HIG doesn't say why.
(In reply to comment #6) > I think you need to mention that this could not be done by theming > alone. I take your word for that. I don't see why the widget documentation should say that. For example, GtkCheckButton doesn't explain why it was created, or how it is different from GtkToggleButton (appart from its appearance), or the technical reasons why it can't be implemented with GtkToggleButton. http://library.gnome.org/devel/gtk/unstable/GtkCheckButton.html It doesn't add new properties, new signals nor new API. It has the same semantics as GtkToggleButton, yet it's a different widget. And well, I never got confused because of that :-)
Fixed: https://git.maemo.org/projects/hildon/gitweb?p=hildon;a=commitdiff;h=1d61a613fd38b86d892bb4922d1cdba0bcd494db
(In reply to comment #7) > (In reply to comment #6) > > I think you need to mention that this could not be done by theming > > alone. I take your word for that. > > I don't see why the widget documentation should say that. > > For example, GtkCheckButton doesn't explain why it was created, or how > it is different from GtkToggleButton (appart from its appearance), or > the technical reasons why it can't be implemented with > GtkToggleButton. That's because applications have reasons to use both in the same UI. (GtkToggleButton is useful when there is very little space, though unfortunately neither the API nor the GNOME HIG mention that's purpose). But there is _no_ time that a GtkCheckButton should be used in a Maemo 5 application. So it's reasonable for people to wonder why HildonCheckButton exists just to change the appearance of a GtkCheckButton. Right now, the logic is "Use GtkCheckButton (via GtkRadioButton's helpful API) if you want a radio button, or use HildonCheckButton if you are using Hildon", which is strangely arbitrary.
(In reply to comment #9) > > For example, GtkCheckButton doesn't explain why it was created, or > > how it is different from GtkToggleButton (appart from its > > appearance), or the technical reasons why it can't be implemented > > with GtkToggleButton. > That's because applications have reasons to use both in the same UI. There _is_ a reason to use GtkCheckButton: if you are using an application written for Maemo 4. In this case, we don't want to break those apps by changing GtkCheckButton unconditionally. I agree that this is debatable, though, but I don't think we can change it at this point. So, to have this bug fixed, what do you suggest for the HildonCheckButton documentation?
I'd like to have this bug closed. To summarize this: we support apps written with the Maemo 4 (or desktop) UI style, hence we keep GtkCheckButton as it has always been but we also provide HildonCheckButton, which has the style recommended in Maemo 5.
(In reply to comment #11) > I'd like to have this bug closed. ...and you already have the bug permissions to do this. :-) So is that actually a question to the reporter whether he agrees, or how to interpret?
(In reply to comment #12) > > I'd like to have this bug closed. > ...and you already have the bug permissions to do this. :-) > So is that actually a question to the reporter whether he agrees, or > how to interpret? Ah, yes, I was just trying to summarize everything to see if anyone has anything else to say before closing this.
Marking as fixed