Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
dev:monitor-plugin [2013/03/18 22:06]
landry [Basic Architecture]
dev:monitor-plugin [2013/03/23 13:45] (current)
nick [Sample API 2]
Line 4: Line 4:
  
 There is a need for a generic plugin that provides basic UI (icon, label(s), menu, etc., see below) and allows the plugin writer to implement only data collection logic. There is a need for a generic plugin that provides basic UI (icon, label(s), menu, etc., see below) and allows the plugin writer to implement only data collection logic.
 +
 +Question: should this mechanism allow independent applications communicate with the plugin (e.g. via dbus) and display "​indicators"​ on the panel (that'​s how indicator plugin works)? Even if such functionality is not needed now, it may be necessary if the panel is used in a non-X environment (one that does not support widget embedding). So far, this page assumes that this feature is //not// needed. --- //​[[ndrwrdck@gmail.com|Andrzej]] 2013/03/19 00:00//
  
 ====== Basic Architecture ====== ====== Basic Architecture ======
Line 24: Line 26:
     * A user readable and translatable name,     * A user readable and translatable name,
     * A user readable and translatable description,​     * A user readable and translatable description,​
 +    * Version number, if not hard to do or a lot of additional work --- //​[[h.judt@gmx.at|Harald Judt]] 2013/03/19 16:10//
     * An icon (32px, dnd size) --- //​[[ndrwrdck@gmail.com|Andrzej]] 2013/03/18 10:36//     * An icon (32px, dnd size) --- //​[[ndrwrdck@gmail.com|Andrzej]] 2013/03/18 10:36//
       * Icon-name. The item dialog show dnd size icons (32px) ​ --- //​[[nick@xfce.org|Nick Schermer]] 2013/03/18 09:49//       * Icon-name. The item dialog show dnd size icons (32px) ​ --- //​[[nick@xfce.org|Nick Schermer]] 2013/03/18 09:49//
Line 40: Line 43:
         * Should be translatable when it makes sense,         * Should be translatable when it makes sense,
         * (should support Pango markup?)         * (should support Pango markup?)
 +        * (what about custom widgets like the weather plugin'​s scrollbox? how would these be handled?​) ​  --- //​[[h.judt@gmx.at|Harald Judt]] 2013/03/19 16:31//
       * If icon and labels are shown, Monitor-UI should arrange them in one of the following layouts:       * If icon and labels are shown, Monitor-UI should arrange them in one of the following layouts:
         * Stacked vertically - icon at the top, labels below. In this case, all objects should be centered.         * Stacked vertically - icon at the top, labels below. In this case, all objects should be centered.
Line 76: Line 80:
       * Maybe it should always provide basic appearance settings, so user can configure this (the backend is only responsible for the data, not the display). When building the dialog the plugin can populate its own frame/box for additional settings that are required for the data collection. --- //​[[nick@xfce.org|Nick Schermer]] 2013/03/18 09:53//       * Maybe it should always provide basic appearance settings, so user can configure this (the backend is only responsible for the data, not the display). When building the dialog the plugin can populate its own frame/box for additional settings that are required for the data collection. --- //​[[nick@xfce.org|Nick Schermer]] 2013/03/18 09:53//
         * Yes, appearance settings could be handled directly by Monitor-UI, but what about settings related to the actual function of the plugin? (e.g. location in weather plugin) --- //​[[ndrwrdck@gmail.com|Andrzej]] 2013/03/18 10:36//         * Yes, appearance settings could be handled directly by Monitor-UI, but what about settings related to the actual function of the plugin? (e.g. location in weather plugin) --- //​[[ndrwrdck@gmail.com|Andrzej]] 2013/03/18 10:36//
 +        * This part sounds tricky; Alternatively,​ how about only creating an abstract "​template"​ plugin that does all the basics but is supposed to be extended by the plugin developer? ​  --- //​[[h.judt@gmx.at|Harald Judt]] 2013/03/19 16:28// 
 +      * Basic appearance settings could simply be provided by an entry in the context menu. I'd somehow rather associate this with the panel, or with the genericness of the plugin, e.g. font size, font color. ​ --- //​[[h.judt@gmx.at|Harald Judt]] 2013/03/19 16:25//
  
 ===== Optional ===== ===== Optional =====
Line 87: Line 92:
     * (Monitor-UI should draw the "​progress-bar"​ on top of the icon, so that it is visible even if only icon is shown).     * (Monitor-UI should draw the "​progress-bar"​ on top of the icon, so that it is visible even if only icon is shown).
   * Monitor-UI or panel should generate periodic (configurable?​) events for polling external events that are then propagated to Monito-logic objects. Doing this centrally in one place, reduces the number of CPU wake-ups.   * Monitor-UI or panel should generate periodic (configurable?​) events for polling external events that are then propagated to Monito-logic objects. Doing this centrally in one place, reduces the number of CPU wake-ups.
 +    * The idea is nice and I thought about that too some time ago, but then there are plugins that update their widgets quite frequently and more frequently than others, so the questions here are more like: "Is it worth all the engineering?​ Does it really make a noticeable difference?"​ Maybe it makes a difference in powersave mode, if such a mode is planned. But how big are the gains in reality? One positive side-effect would be that all plugins update at once, which might perhaps look better and less chaotic, I'm not sure. On the other hand, could it lead to bad effects when all plugins update at the same time (jerkiness,​...)?​ I'm all in for a central place to configure or enable general powersave mode, however. But then the plugins themselves might need to decide how to implement powersaving. ​ --- //​[[h.judt@gmx.at|Harald Judt]] 2013/03/19 21:25//
 +  * Decision needed: Font size and color selectable in the panel or in the plugin? ​ --- //​[[h.judt@gmx.at|Harald Judt]] 2013/03/19 16:10//
   * A recommendation:​ we should avoid "​setters",​ "​updaters"​ etc. in Monitor-logic API in favor of "​getters"​ and signals - this makes both sides of the API deal with only its own tasks.   * A recommendation:​ we should avoid "​setters",​ "​updaters"​ etc. in Monitor-logic API in favor of "​getters"​ and signals - this makes both sides of the API deal with only its own tasks.
 +  * Currently without a use-case, but perhaps it could be useful: Support reacting to external signals, e.g. via D-Bus? ​ --- //​[[h.judt@gmx.at|Harald Judt]] 2013/03/19 16:18//
 +  * Not sure this belongs here, but... as an alternative to making a plugin "​small",​ could it somehow be achieved that a plugin can occupy more than one row but still have the "​small"​ properties and so share space with another plugin? ​ --- //​[[h.judt@gmx.at|Harald Judt]] 2013/03/19 21:13//
  
 ====== UI mockups ====== ====== UI mockups ======
Line 222: Line 231:
   ​   ​
  
 +====== Sample API 2 ======
 +
 +http://​users.xfce.org/​~nick/​proposal/​indicator-api/​
 +
 +  * Idea is the plugin shows preferences for the widgets:
 +    * set their position, therefore the static names for both multiple items (in case of example the sysload plugin), but also the position of the indicator items (by default icon/​progressbar,​ label).
 +    * Plugins can pack a widget (vbox or a single frame) for the plugin specific settings.
 +    * Color settings for progressbar and label.
 +    * Graph appearance.
 +  * An option would be a xfce_panel_indicator_item_add_width (XfcePanelIndicatorItem *item, const gchar *name, const gchar *display_name,​ GtkWidget *widget); to pack custom widgets. No idea if that is really useful and would affect the '​standardization'​ we try to accomplish here.
 +  * Plugin is responsible for the updates (so its own gdk timeout).
 +  * A graph widget could be a nice addition. It would at least merge the cpugraph and sysload plugins, making them both more functional (also graph of memory/swap usage), but also the netload and diskperf plugin would benefit. Bit of fancy cairo and transparency wouldn'​t hurt here :-).
 +    * Xfce4-taskmanager has a nice widget already.