Merge lp:~aprilis/plank/get_position_dbus into lp:plank

[Jarosław Kwiecień]

Hi

I've created a Facebook Messenger desktop app which received very enthusiastic feedback (https://www.reddit.com/r/elementaryos/comments/6fml4c/desktop_app_for_facebook_messenger/). It shows conversations in chat bubbles anchored to the Plank dock. To do this, I had to add one function to Plank's D-Bus API - it just returns the result of get_menu_position.

I'd be very grateful if you accepted these changes - that would allow me to publish my app in the elementary's AppCenter.

Of course you can change the function name and the format of returned value - get_menu_position and array of two ints maybe aren't the best choice.

[Rico Tzschichholz (ricotz)]

Yeah, this design seems a bit weird. Afaics you will be better off with an position/direction where to point to? Using the requisition internally is fine, but seems out of place in such an external use-case.

So I would suggest to retrieve the x,y coords for the (nearest) appropriate position "above" the given item.

review: Needs Information

[Rico Tzschichholz (ricotz)]

Also a merge-proposal against the git repository is preferred.

https://code.launchpad.net/plank
https://github.com/ricotz/plank

[Jarosław Kwiecień (aprilis)]

For me it was quite convenient to receive coordinates of a window with specified size hovering over a given item but retrieving only the coords of the nearest point above would be OK too. Does Gtk have any structure suitable for storing coordinates? I couldn't find any so I guess it should be created (it's not a problem of course but I wanted to add as little code as possible).

I've never used launchpad before and I couldn't find a way to fork the git repository, that's why I submited the proposal to bazaar repo.

[Jarosław Kwiecień (aprilis)]

Uhm, I've just noticed that the same repo is on github, so it's easy to fork. Forget the last paragraph from the previous message

[Rico Tzschichholz (ricotz)]

Don't invent new structures, simply use 3 out parameters (x, y, direction)

[Jarosław Kwiecień (aprilis)]

Wow I didn't know that out parameters works so easily with D-Bus too. Vala is cool :)
So I'll do some code changes and propose merge on the github repository. Thanks for help!

[Rico Tzschichholz (ricotz)]

https://git.launchpad.net/plank/commit/?id=a99649ec9d3e23f709b0c8e66d133fa19caab4be

review: Disapprove

Unmerged revisions

1599. By Jarosław Kwiecień on 2017-06-07

Added dbus get_menu_position function

=== modified file 'lib/DBus/Client.vala'
--- lib/DBus/Client.vala	2016-02-15 20:19:49 +0000
+++ lib/DBus/Client.vala	2017-06-07 17:20:27 +0000
@@ -307,5 +307,26 @@
 			
 			return null;
 		}
+
+		/**
+		 * Returns an array of 2 integers - x and y position of the menu or null in case of failure
+		 *
+		 * @return the array 2 integers or null
+		 */
+		public int[]? get_menu_position (string uri, Gtk.Requisition requisition)
+		{
+			if (items_proxy == null) {
+				warning ("No proxy connected");
+				return null;
+			}
+			
+			try {
+				return items_proxy.get_menu_position (uri, requisition);
+			} catch (IOError e) {
+				warning (e.message);
+			}
+			
+			return null;
+		}
 	}
 }

=== modified file 'lib/DBus/Interfaces.vala'
--- lib/DBus/Interfaces.vala	2015-11-03 10:37:19 +0000
+++ lib/DBus/Interfaces.vala	2017-06-07 17:20:27 +0000
@@ -71,5 +71,12 @@
 		 * @return the array of uris
 		 */
 		public abstract string[] get_transient_applications () throws GLib.IOError;
+
+		/**
+		 * Returns an array of 2 integers - x and y position of the menu or null in case of failure
+		 *
+		 * @return the array 2 integers or null
+		 */
+		public abstract int[]? get_menu_position (string uri, Gtk.Requisition requisition) throws GLib.IOError;
 	}
 }

=== modified file 'lib/DBusManager.vala'
--- lib/DBusManager.vala	2016-02-22 10:12:31 +0000
+++ lib/DBusManager.vala	2017-06-07 17:20:27 +0000
@@ -136,6 +136,25 @@
 			
 			return result;
 		}
+
+		public int[]? get_menu_position (string uri, Gtk.Requisition requisition) {
+			
+			unowned ApplicationDockItemProvider? provider = (controller.default_provider as ApplicationDockItemProvider);
+			if (provider == null)
+				return null;
+			
+			unowned DockItem? item = provider.item_for_uri (uri);
+			if (item == null)
+				return null;
+				
+			unowned PositionManager? manager = controller.position_manager;
+			if (manager == null)
+				return null;
+			
+			int x, y;
+			manager.get_menu_position (item, requisition, out x, out y);	
+			return { x, y };
+		}
 	}
 	
 	/**