Merge lp:~damiannohales/plank/window-border-margin into lp:plank

[Damián Nohales]

This adds the WindowBorderMargin setting to the dock, that allows to the user to add an extra spacing between the window border and the dock.

[Rico Tzschichholz (ricotz)]

This sounds reasonable if a theme defines a negative TopPadding. Considering that this should be a parameter in *dock.theme* not in settings. ;-)

So please move it to DockTheme as TopMargin. You should be able to contain the needed changes to DockTheme.vala, DockPreferences.vala and PositionManager.vala.

review: Needs Fixing

[Damián Nohales (damiannohales)]

> This sounds reasonable if a theme defines a negative TopPadding. Considering
> that this should be a parameter in *dock.theme* not in settings. ;-)
>
> So please move it to DockTheme as TopMargin. You should be able to contain the
> needed changes to DockTheme.vala, DockPreferences.vala and
> PositionManager.vala.

You are describing my first try when implementing this :P

I changed it to a setting because the plank settings also defines "outside" alignment stuff, but is ok, let's move it to the theme.

[Damián Nohales (damiannohales)]

I've overwritten the branch with the fixed commit.

[lp:~damiannohales/plank/window-border-margin]

1034. By Rico Tzschichholz on 2014-06-17

positionmanager: Precalculate top_offset to have it include TopPadding

This avoids doing this over and over again in several places.

[Rico Tzschichholz (ricotz)]

Do not trigger setting the struts unconditionally.

TopMargin should taken into account as follow:
* only in case of HideMode==HideType.NONE
* ignore it for non-compositing, so there is no "spacing"
  if the (solid) background covers the item-regions
* don't have it influence the cursor-region or item-regions

Please rebase it on the current trunk.

review: Needs Fixing

[lp:~damiannohales/plank/window-border-margin]

1035. By Rico Tzschichholz on 2014-06-17

Make sure to update visibile-items in prepare

Not pinned items doesnt show up initially.

Regression caused by r1029

[Damián Nohales (damiannohales)]

> Do not trigger setting the struts unconditionally.
>
> TopMargin should taken into account as follow:
> * only in case of HideMode==HideType.NONE
> * ignore it for non-compositing, so there is no "spacing"
> if the (solid) background covers the item-regions
> * don't have it influence the cursor-region or item-regions
>
> Please rebase it on the current trunk.

I think a don't understand the 3rd point, could you explain?

[Rico Tzschichholz (ricotz)]

I mean this margin should not change the size of areas which are used to determine whether the mouse cursor interacts with the dock or not. This doesn't mean it isn't needed to calculate them.

[lp:~damiannohales/plank/window-border-margin]

1036. By Damián Nohales on 2014-06-26

Add TopMargin theme option

This option allows to add an extra margin between
the window border and the top of the dock.

[Damián Nohales (damiannohales)]

Updated, but I still don't understand how this can affect the calculation of the cursor/items region, because the TopMargin parameter is only used in PositionManager::get_struts method.

[Rico Tzschichholz (ricotz)]

I am not speaking about your current implementation in specific. Putting things directly in the struts-calcution is elegant, but this might change if you follow the other requirements.

Unmerged revisions

1036. By Damián Nohales on 2014-06-26

Add TopMargin theme option

This option allows to add an extra margin between
the window border and the top of the dock.

=== modified file 'lib/DockRenderer.vala'
--- lib/DockRenderer.vala	2014-05-20 15:36:44 +0000
+++ lib/DockRenderer.vala	2014-06-26 15:05:18 +0000
@@ -161,6 +161,7 @@
 				reset_position_manager_timer = 0;
 				controller.position_manager.reset_caches (theme);
 				controller.position_manager.update_regions ();
+				controller.window.update_struts ();
 				
 				return false;
 			});

=== modified file 'lib/Drawing/DockTheme.vala'
--- lib/Drawing/DockTheme.vala	2013-10-07 10:25:43 +0000
+++ lib/Drawing/DockTheme.vala	2014-06-26 15:05:18 +0000
@@ -40,6 +40,9 @@
 		
 		[Description(nick = "bottom-padding", blurb = "The padding on the bottom dock edge, in tenths of a percent of IconSize.")]
 		public double BottomPadding { get; set; }
+
+		[Description(nick = "top-margin", blurb = "The distance between the window border and the dock, in tenths of a percent of IconSize.")]
+		public double TopMargin { get; set; }
 		
 		[Description(nick = "item-padding", blurb = "The padding between items on the dock, in tenths of a percent of IconSize.")]
 		public double ItemPadding { get; set; }
@@ -120,6 +123,7 @@
 			HorizPadding = 0.0;
 			TopPadding = -11.0;
 			BottomPadding = 2.5;
+			TopMargin = 0.0;
 			ItemPadding = 2.0;
 			IndicatorSize = 5.0;
 			IconShadowSize = 1.0;
@@ -542,6 +546,11 @@
 				if (BottomPadding < 0)
 					BottomPadding = 0;
 				break;
+
+			case "TopMargin":
+				if (TopMargin < 0.0)
+					TopMargin = 0.0;
+				break;
 			
 			case "ItemPadding":
 				if (ItemPadding < 0)

=== modified file 'lib/PositionManager.vala'
--- lib/PositionManager.vala	2014-06-17 07:25:12 +0000
+++ lib/PositionManager.vala	2014-06-26 15:05:18 +0000
@@ -213,6 +213,10 @@
 		 */
 		public int BottomPadding { get; private set; }
 		/**
+		 * Theme-based top margin, scaled by icon size.
+		 */
+		public int TopMargin { get; private set; }
+		/**
 		 * Theme-based item padding, scaled by icon size.
 		 */
 		public int ItemPadding   { get; private set; }
@@ -308,6 +312,7 @@
 			HorizPadding  = (int) (theme.HorizPadding  * scaled_icon_size);
 			TopPadding    = (int) (theme.TopPadding    * scaled_icon_size);
 			BottomPadding = (int) (theme.BottomPadding * scaled_icon_size);
+			TopMargin     = (int) (theme.TopMargin     * scaled_icon_size);
 			ItemPadding   = (int) (theme.ItemPadding   * scaled_icon_size);
 			UrgentBounceHeight = (int) (theme.UrgentBounceHeight * IconSize);
 			LineWidth     = theme.LineWidth;
@@ -1070,22 +1075,22 @@
 			switch (controller.prefs.Position) {
 			default:
 			case PositionType.BOTTOM:
-				struts [Struts.BOTTOM] = (VisibleDockHeight + controller.window.get_screen ().get_height () - monitor_geo.y - monitor_geo.height) * window_scale_factor;
+				struts [Struts.BOTTOM] = (VisibleDockHeight + TopMargin + controller.window.get_screen ().get_height () - monitor_geo.y - monitor_geo.height) * window_scale_factor;
 				struts [Struts.BOTTOM_START] = monitor_geo.x * window_scale_factor;
 				struts [Struts.BOTTOM_END] = (monitor_geo.x + monitor_geo.width) * window_scale_factor - 1;
 				break;
 			case PositionType.TOP:
-				struts [Struts.TOP] = (monitor_geo.y + VisibleDockHeight) * window_scale_factor;
+				struts [Struts.TOP] = (monitor_geo.y + VisibleDockHeight + TopMargin) * window_scale_factor;
 				struts [Struts.TOP_START] = monitor_geo.x * window_scale_factor;
 				struts [Struts.TOP_END] = (monitor_geo.x + monitor_geo.width) * window_scale_factor - 1;
 				break;
 			case PositionType.LEFT:
-				struts [Struts.LEFT] = (monitor_geo.x + VisibleDockWidth) * window_scale_factor;
+				struts [Struts.LEFT] = (monitor_geo.x + VisibleDockWidth + TopMargin) * window_scale_factor;
 				struts [Struts.LEFT_START] = monitor_geo.y * window_scale_factor;
 				struts [Struts.LEFT_END] = (monitor_geo.y + monitor_geo.height) * window_scale_factor - 1;
 				break;
 			case PositionType.RIGHT:
-				struts [Struts.RIGHT] = (VisibleDockWidth + controller.window.get_screen ().get_width () - monitor_geo.x - monitor_geo.width) * window_scale_factor;
+				struts [Struts.RIGHT] = (VisibleDockWidth + TopMargin + controller.window.get_screen ().get_width () - monitor_geo.x - monitor_geo.width) * window_scale_factor;
 				struts [Struts.RIGHT_START] = monitor_geo.y * window_scale_factor;
 				struts [Struts.RIGHT_END] = (monitor_geo.y + monitor_geo.height) * window_scale_factor - 1;
 				break;

=== modified file 'lib/Widgets/DockWindow.vala'
--- lib/Widgets/DockWindow.vala	2014-04-12 14:58:48 +0000
+++ lib/Widgets/DockWindow.vala	2014-06-26 15:05:18 +0000
@@ -684,6 +684,12 @@
 				get_window ().input_shape_combine_region (new Region.rectangle (rect), 0, 0);
 			}
 		}
+
+		public void update_struts ()
+		{
+			if (screen.is_composited() && controller.prefs.HideMode == HideType.NONE)
+				set_struts();
+		}
 		
 		void set_struts ()
 		{