Merge lp:~aacid/unity-2d/unity-2d-shell_behaviours_shuffling into lp:~unity-2d-team/unity-2d/unity-2d-shell

[Albert Astals Cid]

Documentation on the visibility Behaviors and group them all in the same folder

=== added directory 'shell/common/visibilityBehaviors'
=== renamed file 'shell/common/AlwaysVisibleBehavior.qml' => 'shell/common/visibilityBehaviors/AlwaysVisibleBehavior.qml'
--- shell/common/AlwaysVisibleBehavior.qml	2012-02-08 11:58:01 +0000
+++ shell/common/visibilityBehaviors/AlwaysVisibleBehavior.qml	2012-02-08 16:39:18 +0000
@@ -18,6 +18,8 @@
 
 import QtQuick 1.0
 
+// shown is always true in this behaviour
+
 BaseBehavior {
     property bool shown: true
 }

=== renamed file 'shell/launcher/AutoHideBehavior.qml' => 'shell/common/visibilityBehaviors/AutoHideBehavior.qml'
--- shell/launcher/AutoHideBehavior.qml	2012-02-07 20:19:29 +0000
+++ shell/common/visibilityBehaviors/AutoHideBehavior.qml	2012-02-08 16:39:18 +0000
@@ -17,7 +17,14 @@
  */
 
 import QtQuick 1.0
-import "../common"
+
+// Shows the target when it has the focus or when you move the
+// mouse for 500 msec to the edge of the target
+// Hides the target when none of the above conditions are met
+// and you have not had the mouse over it during more than 1000 msec
+// To use this Behavior your target needs to provide two properties
+//  - containsMouse: Defines if the mouse is inside the target
+//  - outerEdgeContainsMouse: Defines if the mouse is in the edge of the target
 
 BaseBehavior {
     id: autoHide

=== renamed file 'shell/common/BaseBehavior.qml' => 'shell/common/visibilityBehaviors/BaseBehavior.qml'
--- shell/common/BaseBehavior.qml	2012-02-08 11:58:01 +0000
+++ shell/common/visibilityBehaviors/BaseBehavior.qml	2012-02-08 16:39:18 +0000
@@ -19,8 +19,15 @@
 import QtQuick 1.0
 
 Item {
+    // true if the behaviour wants the target to be shown, false otherwise
     property bool shown
+
+    // The target the behavior will be deciding if has to be shown or not
     property variant target
+
+    // Wheter the target has been shown by an external reason
     property bool forcedVisible: false
+
+    // The id that triggered the last forcedVisible change
     property variant forcedVisibleChangeId
 }

=== renamed file 'shell/launcher/IntelliHideBehavior.qml' => 'shell/common/visibilityBehaviors/IntelliHideBehavior.qml'
--- shell/launcher/IntelliHideBehavior.qml	2012-02-07 20:19:29 +0000
+++ shell/common/visibilityBehaviors/IntelliHideBehavior.qml	2012-02-08 16:39:18 +0000
@@ -18,8 +18,16 @@
 
 import QtQuick 1.0
 import Unity2d 1.0
-import "../common"
-import "../common/utils.js" as Utils
+import "../utils.js" as Utils
+
+// Shows the target when it has the focus or when you move the
+// mouse for 500 msec to the edge of the target or there are no 
+// windows that intersect with the target
+// Hides the target when none of the above conditions are met
+// and you have not had the mouse over it during more than 1000 msec
+// To use this Behavior your target needs to provide two properties
+//  - containsMouse: Defines if the mouse is inside the target
+//  - outerEdgeContainsMouse: Defines if the mouse is in the edge of the target
 
 BaseBehavior {
     id: intellihide

=== modified file 'shell/launcher/LauncherLoader.qml'
--- shell/launcher/LauncherLoader.qml	2012-02-07 20:19:29 +0000
+++ shell/launcher/LauncherLoader.qml	2012-02-08 16:39:18 +0000
@@ -36,9 +36,9 @@
     Loader {
         id: launcherBehavior
 
-        property variant modesMap: { 0: '../common/AlwaysVisibleBehavior.qml',
-                                     1: 'AutoHideBehavior.qml',
-                                     2: 'IntelliHideBehavior.qml' }
+        property variant modesMap: { 0: '../common/visibilityBehaviors/AlwaysVisibleBehavior.qml',
+                                     1: '../common/visibilityBehaviors/AutoHideBehavior.qml',
+                                     2: '../common/visibilityBehaviors/IntelliHideBehavior.qml' }
 
         source: modesMap[Utils.clamp(launcher2dConfiguration.hideMode, 0, 2)]
     }