OSD improvements

[johanmalm]

--EDIT-- This list is now managed at #968

Based on @1qh list in issue #879

• item height
• item width
• item vertical padding
• focused item border width
• focused item background and text color
• possible to hide each of 3 columns
• position of desktop name (top/bottom)
• different font size for desktop switcher and window switcher
• size of the squares in desktop switcher

TODO:

• Consider s/osd.window-switcher.item.width/osd-window-switcher.width/
• Consider allowing window-switcher width to be specified as a percentage of output width
• Calculate window-switcher width based on item-width + padding
• Take into account output->scale
• osd.c: simplify the get_title() helper and associated is_title_different()
• Cope with many nr_items * item_height > output_height
• Show always on-top windows
• Consider showing multiple work-spaces in window-switcher (although config might get pretty hard
• Consider showing window thumbnails 😄

Notes:

Have used osd.window-switcher.foo: bar because the window-switcher is only one type of OSD and we might want to set different value for the workspace-switcher for example. If anyone wants to set them to the same, they can simply do osd.*.foo: bar.

[1qh]

awesome !!

[Consolatis]

Have used osd.window-switcher.foo: bar because the window-switcher is only one type of OSD and we might want to set different value for the workspace-switcher for example. If anyone wants to set them to the same, they can simply do osd.*.foo: bar.

Is this common for the openbox theme format?
For the buttons it is

• window.active.button.unpressed.image.color: #000000 to set all of them and
• window.active.button.iconify.unpressed.image.color: #333333 to set individual ones for example.

Thus I think osd.item.width to set all the OSD ones and osd.window-switcher.item.width to set the individual ones would be more consistent.

Edit:
On a related note, is osd.item.width actually the best option here? I'd argue osd.width / osd.window-switcher.width would be better, that would then also work for the workspace OSD.

Edit 2:
For osd.height / osd.window-switcher.height we could use something like for the menu width: osd.height.min and osd.height.max and then calculate the actual size based on the number of items like what we are doing now. And if the result is larger than osd.height.max, remove items until we are under it. That would require some kind of paging but we'd need that anyway to fix

• Cope with many nr_items * item_height > output_height

Edit 3:

• Take into account output->scale

That should be done already, we only operate in the unscaled coordinate space and supply the scale to cairo when creating the buffer: output->osd_buffer = buffer_create_cairo(w, h, scale, /* free_on_destroy */ true). That should take care of everything for us, including pango.

[johanmalm]

Thanks for review @Consolatis

Have used osd.window-switcher.foo: bar because the window-switcher is only one type of OSD and we might want to set different value for the workspace-switcher for example. If anyone wants to set them to the same, they can simply do osd.*.foo: bar.

Is this common for the openbox theme format? For the buttons it is

* `window.active.button.unpressed.image.color: #000000` to set all of them and

* `window.active.button.iconify.unpressed.image.color: #333333` to set individual ones for example. 

Thus I think osd.item.width to set all the OSD ones and osd.window-switcher.item.width to set the individual ones would be more consistent.

Well 😄 The example you have given is the only think I know of in Openbox 3.6 that is not documented. Only the first version (without iconify) is documented. I suspect that the iconify (and others) version is a later addition and in hindsight would have been better dealt with * - but of course in order to be backward compatible they probably kept the original version and just left the iconify version as some sort of override.

So, I other words, I think the example you have give in an oddity and that now that we have a chance to design the osd hierarchy we ought to go with a clean + consistent approach.

Edit: On a related note, is osd.item.width actually the best option here? I'd argue osd.width / osd.window-switcher.width would be better, that would then also work for the workspace OSD.

100% agree. That is indeed my first TODO bullet, so we're thinking alike. It was just getting to late to re-do last night.

Edit 2: For osd.height / osd.window-switcher.height we could use something like for the menu width: osd.height.min and osd.height.max and then calculate the actual size based on the number of items like what we are doing now. And if the result is larger than osd.height.max, remove items until we are under it. That would require some kind of paging but we'd need that anyway to fix

• Cope with many nr_items * item_height > output_height

Yep, good idea.

Edit 3:

• Take into account output->scale

That should be done already, we only operate in the unscaled coordinate space and supply the scale to cairo when creating the buffer: output->osd_buffer = buffer_create_cairo(w, h, scale, /* free_on_destroy */ true). That should take care of everything for us, including pango.

Oh, I forgot. Thanks for reminding me. 😊

[johanmalm]

Ready to go from my perspective. Would appreciate review.

[Consolatis]

I didn't verify all the calculations but assuming you tested it while developing this LGTM apart from the comment above regarding the added side effect of draw_cairo_border().

[johanmalm]

I didn't verify all the calculations but assuming you tested it while developing this LGTM apart from the comment above regarding the added side effect of draw_cairo_border().

Thanks. Yes, I've tested pretty thoroughly as I've gone.