\var{switchto} & bool & Do we want to switch to the client window. \\
\var{jumpto} & bool & Do we want to jump to the client window. \\
\var{userpos} & bool & Geometry set by user. \\
- \var{dockapp} & bool & Client window is a dockapp. \\
+ \var{dockapp} & bool & Client window is a dock-app. \\
\var{maprq} & bool & Map request (and not initialisation scan). \\
\var{gravity} & number & Window gravity. \\
\var{geom} & table & Requested geometry; \var{x}, \var{y}, \var{w}, \var{h}.\\
\end{function}
+\begin{function}
+ \index{clientwin-property-change-hook@\code{clientwin_property_change_hook}}
+ \hookname{clientwin_property_change_hook}
+ \hookparams{(WClientWin, integer)}
+ \begin{funcdesc}
+ Called when the property identified by the parameter atom id
+ (integer) has changed on a client window.
+ \end{funcdesc}
+\end{function}
+
+
\begin{function}
\index{clientwin-unmapped-hook@\code{clientwin_unmapped_hook}}
\hookname{clientwin_unmapped_hook}
\begin{tabularx}{\linewidth}{llX}
\tabhead{Field & Type & Description}
\var{reg} & WFrame & The frame in question \\
- \var{mode} & string & \var{"switchonly"}, \var{"reorder"},
- \var{"add"} or \var{"remove"} \\
- \var{sw} & bool & Switch occured \\
+ \var{mode} & string & \codestr{switchonly}, \codestr{reorder},
+ \codestr{add} or \codestr{remove} \\
+ \var{sw} & bool & Switch occurred \\
\var{sub} & WRegion & The managed region (primarily) affected \\
\end{tabularx}
\end{funcdesc}
\hookparams{()}
\begin{funcdesc}
Called when Ion has done all initialisation and is almost ready to
- enter the mainloop, except no windows are yet being managed.
+ enter the main-loop, except no windows are yet being managed.
\end{funcdesc}
\end{function}
\end{function}
+\begin{function}
+ \index{ioncore-submap-ungrab-hook@\code{ioncore_submap_ungrab_hook}}
+ \hookname{ioncore_submap_ungrab_hook}
+ \hookparams{()}
+ \begin{funcdesc}
+ This hook is used to signal whenever Ion leaves the submap grab mode.
+ \end{funcdesc}
+\end{function}
+
+
\begin{function}
\index{tiling-placement-alt@\code{tiling_placement_alt}}
\hookname{tiling_placement_alt}
the moment) to be placed \\
\var{mp} & \type{table} & This table contains the same fields as
the parameter of \fnref{clientwin_do_manage_alt} \\
- \var{res_frame} & \type{WFrame} & A succesfull handler should
+ \var{res_frame} & \type{WFrame} & A successful handler should
return the target frame here. \\
\end{tabularx}
This hook is just for placing within a given workspace after the
\end{function}
-%\begin{function}
-% \index{panews-init-layout-alt@\code{panews_init_layout_alt}}
-% \hookname{panews_init_layout_alt}
-% \hookparams{table}
-% \begin{funcdesc}
-% Called to initialise panews layout. The table parameter has
-% initially a single field \var{ws} pointing to the workspace,
-% but the succesfull handler should set the field \var{layout}
-% to a proper layout (as those saved in the layout savefiles).
-% \end{funcdesc}
-%\end{function}
-
-
-\begin{function}
- \index{panews-make-placement-alt@\code{panews_make_placement_alt}}
- \hookname{panews_make_placement_alt}
- \hookparams{table}
- \begin{funcdesc}
- Called to make a placement on panews. The parameter table has
- the following fields:
-
- \begin{tabularx}{\linewidth}{llX}
- \tabhead{Field & Type & Description}
- \var{ws} & \type{WPaneWS} & The workspace \\
- \var{frame} & \type{WFrame} & A frame initially allocated for the
- region to be placed \\
- \var{reg} & \type{WRegion} & The region to be placed \\
- \var{specifier} & \type{WRegion} & For drag\&drop on handling empty areas\\
- \end{tabularx}
-
- The handler should set some of these fields on success:
-
- \begin{tabularx}{\linewidth}{llX}
- \tabhead{Field & Type & Description}
- \var{res_node} & \type{WSplit} & Target split \\
- \var{res_config} & \type{WFrame} & New configuration for it, unless
- \type{WSplitRegion} \\
- \var{res_w} & integer & New width for target split (optional) \\
- \var{res_h} & integer & New height for target split (optional) \\
- \end{tabularx}
- \end{funcdesc}
-\end{function}
-
-
-\begin{function}
- \index{region-activated-hook@\code{region_activated_hook}}
- \hookname{region_activated_hook}
- \hookparams{WRegion}
- \begin{funcdesc}
- Signalled when a region or one of its children has received the focus.
- \end{funcdesc}
-\end{function}
-
-
-\begin{function}
- \index{region-activity-hook@\code{region_activity_hook}}
- \hookname{region_activity_hook}
- \hookparams{WRegion}
- \begin{funcdesc}
- This hook is triggered when the activity flag of the parameter
- region has been changed.
- \end{funcdesc}
-\end{function}
-
-
\begin{function}
\index{region-do-warp-alt@\code{region_do_warp_alt}}
\hookname{region_do_warp_alt}
\end{function}
-\begin{function}
- \index{region-inactivated-hook@\code{region_inactivated_hook}}
- \hookname{region_inactivated_hook}
- \hookparams{WRegion}
- \begin{funcdesc}
- Signalled when the focus has moved from the parameter region or
- one of its children to a non-child region of the parameter region.
- \end{funcdesc}
-\end{function}
-
-
\begin{function}
\index{screen-managed-changed-hook@\code{screen_managed_changed_hook}}
\hookname{screen_managed_changed_hook}
\fnref{frame_managed_changed_hook}.
\end{funcdesc}
\end{function}
+
+
+\begin{function}
+ \index{region-notify-hook@\code{region_notify_hook}}
+ \hookname{region_notify_hook}
+ \hookparams{(WRegion, string)}
+ \begin{funcdesc}
+ Signalled when something (minor) has changed in relation to
+ the first parameter region. The string argument gives the
+ change:
+
+ \begin{tabularx}{\linewidth}{lX}
+ \tabhead{String & Description}
+ \code{deinit} & The region is about to be deinitialised. \\
+ \code{activated} & The region has received focus. \\
+ \code{inactivated} & The region has lost focus. \\
+ \code{activity} & There's been activity in the region itself. \\
+ \code{sub_activity} & There's been activity in some sub-region. \\
+ \code{name} & The name of the region has changed. \\
+ \code{unset_manager} & The region no longer has a manager. \\
+ \code{set_manager} & The region now has a manager. \\
+ \code{tag} & Tagging state has changed. \\
+ \code{pseudoactivated} & The region has become pseudo-active
+ (see below). \\
+ \code{pseudoinactivated} & The region is no longer pseudo-active. \\
+ \end{tabularx}
+
+ A region is pseudo-active, when a) it is itself not active (does
+ not not have the focus, and may not even have a window that could
+ have it), but b) some region managed by it is active.
+ \end{funcdesc}
+\end{function}
+
+
projects / ion3-doc.git / blobdiff