expandable widget cannot collapse widgets to the number defined by "collapsed-widgets"

[XiaoGuo, Liu]

https://developer.ubuntu.com/api/scopes/cpp/sdk-15.04/previewwidgets/

I tried to used the example code shown in the above link:

PreviewWidget expandable("exp", "expandable");
expandable.add_attribute_value("title", Variant("This is an expandable widget"));
expandable.add_attribute_value("collapsed-widgets", Variant(0));
PreviewWidget w1("w1", "text");
w1.add_attribute_value("title", Variant("Subwidget 1"));
w1.add_attribute_value("text", Variant("A text"));
PreviewWidget w2("w2", "text");
w2.add_attribute_value("title", Variant("Subwidget 2"));
w2.add_attribute_value("text", Variant("A text"));
expandable.add_widget(w1);
expandable.add_widget(w2);

regardless of whatever number is defined in "collapsed-widgets", it always shows all of the widgets there.

Thanks & best regards,
XiaoGuo

[Launchpad Janitor (janitor)]

Status changed to 'Confirmed' because the bug affects multiple users.

[Albert Astals Cid (aacid)]

I think the problem is that the documentation doesn't match what the code does.

The internal documentation we have in the code says

    This widget shows a list of widgets defined in widgetData["widgets"]
    Those widgets can be collapsed or uncollapsed. When uncollapsed
    all the widgets are shown, when collapsed only the first
    widgetData["collapsed-widgets"] are shown. It has a title that comes
    in via widgetData["title"]. This widget expands all child widgets
    when initialized by specifying widgetData["expanded"] == true.
    It's in unexpanded mode by default.

There's nothing about 0 being a magic number and also collapsed-widgets is the number of widgets that will still be shown when the widget is collapsed.

I think it's best to update the documentation to match the code since there's a few scopes using the widget already.