Skip to content

Commit

Permalink
Added new section on workspaces
Browse files Browse the repository at this point in the history
  • Loading branch information
azonenberg committed Dec 3, 2024
1 parent dbc482e commit 35e22c2
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 0 deletions.
1 change: 1 addition & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ set(NGDOC_LIST
section-spectrometer-drivers.tex
section-triggers.tex
section-decodes.tex
section-workspaces.tex

# section-internals.tex
# section-protoanalyzer.tex
Expand Down
Binary file added ng-images/docking.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ng-images/workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ng-images/workspace2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ng-images/workspace3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions ngscopeclient-manual.tex
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
\include{section-tutorials}
\include{section-ng-mainwindow}
\include{section-dialogs}
\include{section-workspaces}
\include{section-ng-waveformgroups}
\include{section-ng-waveformviews}
\include{section-ng-history}
Expand Down
50 changes: 50 additions & 0 deletions section-workspaces.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
\chapter{Workspaces and Window Management}

All dialog boxes, waveform groups, and other GUI elements in ngscopeclient may be used docked or free-floating as
needed.

To dock a window, drag the title bar (if floating) or tab title (if docked) to the desired location (Fig.
\ref{w-docking}).

\begin{figure}[h]
\centering
\bigimage{ng-images/docking.png}
\caption{Docking a floating window}
\label{w-docking}
\end{figure}

To create more complex windowing layouts, you may find it helpful to create \emph{workspaces}.

A workspace is a window which has no function of its own, and simply serves as a container for docking other windows
into. The workspace can itself be docked into another workspace or the main application window, allowing creation of
complex multi-window or multi-tab layouts to suit your experimental needs (Fig. \ref{w-workspace}, \ref{w-workspace2},
\ref{w-workspace3}).

In the default ngscopeclient window layout, for example, the "Filter Graph" tab is a workspace which contains both the
filter graph editor and the filter palette.

To rename a workspace, right click on the window title (if floating) or tab title (if docked) and enter the desired
name.

\begin{figure}[h]
\centering
\bigimage{ng-images/workspace.png}
\caption{A docked workspace containing a waveform group and two protocol analyzer tabs}
\label{w-workspace}
\end{figure}


\begin{figure}[h]
\centering
\bigimage{ng-images/workspace2.png}
\caption{Switching from the waveform workspace to the filter graph editor workspace}
\label{w-workspace2}
\end{figure}


\begin{figure}[h]
\centering
\bigimage{ng-images/workspace3.png}
\caption{Free-floating workspace not docked to the main application window}
\label{w-workspace3}
\end{figure}

0 comments on commit 35e22c2

Please sign in to comment.