[svn-upgrade] Integrating new upstream version, ion3 (20070318)

[ion3-doc.git] / conf-winprops.tex

diff --git a/conf-winprops.tex b/conf-winprops.tex
index 10c1c10fa8b3d4bc4ddf8485b4d9285ebe66c5cb..e564b47331f8110f7df4a007b4521bd9115afe43 100644 (file)
--- a/conf-winprops.tex
+++ b/conf-winprops.tex
@@ -41,13 +41,6 @@ usual method of identifying windows, and how to obtain this information.
 \end{winprop}
 
 
-\begin{winprop}{aspect}{table}
-    \index{aspect@\var{aspect}}
-    The table should contain the entries \var{w} and \var{h} that
-    override application-supplied aspect ratio hint.
-\end{winprop}
-
-
 \begin{winprop}{float}{boolean}
     \index{float@\var{float}}
     Set this to open the window in a floating frame, when
@@ -74,12 +67,6 @@ usual method of identifying windows, and how to obtain this information.
 \end{winprop}
 
 
-\begin{winprop}{ignore_resizeinc}{boolean}
-    \index{ignore-resizeinc@\var{ignore_resizeinc}}
-    Should application supplied size increments be ignored?
-\end{winprop}
-
-
 \begin{winprop}{jumpto}{boolean}
     \index{jumpto@\var{jumpto}}
     Should a newly created client window always be made
@@ -87,16 +74,14 @@ usual method of identifying windows, and how to obtain this information.
 \end{winprop}
 
 
-\begin{winprop}{max_size}{table}
-    \index{max-size@\var{max_size}}
-    The table should contain the entries \var{w} and \var{h} that
-    override application-supplied maximum size hint. 
-\end{winprop}
-
-
-\begin{winprop}{min_size}{table}
-    \index{min-size@\var{min_size}}
-    Similar to \var{max_size} but for the minimum size hint. 
+\begin{winprop}{new_group}{string}
+    \index{new-group@\var{new_group}}
+    If the region specified by \code{target} winprop does not exist
+    (or that winprop is not set), create a new workspace using the 
+    previously stored layout (see \fnref{ioncore.deflayout}) named by
+    this property. After creating the workspace, \code{target} is 
+    attempted to be found again. (If that still fails, the newly 
+    created workspace is still asked to manage the client window.)
 \end{winprop}
 
 
@@ -106,6 +91,15 @@ usual method of identifying windows, and how to obtain this information.
 \end{winprop}
 
 
+\begin{winprop}{statusbar}{string}
+    \index{statusbar@\var{statusbar}}
+    Put the window in the statusbar, in the named tray component,
+    (The default tray component is called simply \code{"systray"}, 
+    and others you give names to in your custom template, always 
+    prefixed by \code{"systray_"}.
+\end{winprop}
+
+
 \begin{winprop}{switchto}{boolean}
     \index{switchto@\var{switchto}}
     Should a newly mapped client window be switched to within
@@ -116,35 +110,51 @@ usual method of identifying windows, and how to obtain this information.
 \begin{winprop}{target}{string}
     \index{target@\var{target}}
     The name of an object (workspace, frame) that should manage 
-    windows of this type. 
+    windows of this type. See also \code{new_group}.
 \end{winprop}
 
         
 \begin{winprop}{transient_mode}{string}
     \index{transient-mode@\var{transient_mode}}
-    "normal": No change in behaviour. "current": The window
-    should be thought of as a transient for the current active
-    client window (if any) even if it is not marked as a
-    transient by the application. "off": The window should be
-    handled as a normal window even if it is marked as a
+    \code{"normal"}: No change in behaviour. \code{"current"}:
+    The window should be thought of as a transient for the current
+    active client window (if any) even if it is not marked as a
+    transient by the application. \code{"off"}: The window should 
+    be handled as a normal window even if it is marked as a
     transient by the application. 
 \end{winprop}
 
 
-\begin{winprop}{transients_at_top}{boolean}
-    \index{transients-at-top@\var{transients_at_top}}
-    When transients are managed by the client window itself (as it
-    is the case on tiled workspaces), should the transients be
-    placed at the top of the window instead of bottom? 
-\end{winprop}
-
-
 \begin{winprop}{transparent}{boolean}
     \index{transparent@\var{transparent}}
     Should frames be made transparent when this window is selected? \\
 \end{winprop}
 
 
+\subsection{Sizehint winprops}
+
+Additionally, the winprops 
+\code{max_size}\index{max-size@\var{max_size}},
+\code{min_size}\index{min-size@\var{min_size}},
+\code{aspect}\index{aspect@\var{aspect}},
+\code{resizeinc}\index{aspect@\var{resizeinc}},
+and
+\code{ignore_max_size}\index{ignore-max-size@\var{ignore_max_size}},
+\code{ignore_min_size}\index{ignore-min-size@\var{ignore_min_size}},
+\code{ignore_aspect}\index{ignore-aspect@\var{ignore_aspect}},
+\code{ignore_resizeinc}\index{ignore-aspect@\var{ignore_resizeinc}},
+may be used to override application-supplied size hints. The four
+first ones are tables with the fields \var{w} and \var{h}, indicating
+the width and height size hints in pixels, and the latter ignore
+winprop is a boolean. 
+
+Finally, the boolean
+\code{userpos}\index{userpos@\var{userpos}} option may be used to
+override the \code{USPosition} flag of the size hints. Normally,
+when this flag is set, Ion tries to respect the supplied window
+position more than when it is not set. Obviously, this makes sense
+only for floating windows.
+
 
 \subsection{Classes, roles and instances}
 \label{sec:classesrolesinstances}