]> git.saurik.com Git - wxWidgets.git/blame - contrib/samples/ogl/studio/manual/studio.tex
Fixed compile error (seen on OS/2).
[wxWidgets.git] / contrib / samples / ogl / studio / manual / studio.tex
CommitLineData
1fc25a89
JS
1\documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}%
2\twocolwidtha{4cm}%
3\input{psbox.tex}
4\newcommand{\commandref}[2]{\helpref{{\tt $\backslash$#1}}{#2}}%
5\newcommand{\commandrefn}[2]{\helprefn{{\tt $\backslash$#1}}{#2}\index{#1}}%
6\newcommand{\commandpageref}[2]{\latexignore{\helprefn{{\tt $\backslash$#1}}{#2}}\latexonly{{\tt $\backslash$#1} {\it page \pageref{#2}}}\index{#1}}%
7\newcommand{\indexit}[1]{#1\index{#1}}%
8\newcommand{\inioption}[1]{{\tt #1}\index{#1}}%
9\parskip=10pt%
10\parindent=0pt%
11\title{Manual for OGL Studio}%
12\author{by Julian Smart}%
13\makeindex%
14\begin{document}%
15\maketitle%
16\pagestyle{fancyplain}%
17\bibliographystyle{plain}%
18\pagenumbering{arabic}%
19\setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}%
20\setfooter{\thepage}{}{}{}{}{\thepage}%
21\tableofcontents%
22
23\chapter{Welcome to OGL Studio}%
24\setheader{{\it Welcome}}{}{}{}{}{{\it Welcome}}%
25\setfooter{\thepage}{}{}{}{}{\thepage}%
26
27Welcome to OGL Studio, an extended sample for the Object Graphics Library.
28
29For release information, please see the \helpref{Read Me}{readme} section.
30
31\chapter{Read Me}\label{readme}%
32\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
33\setfooter{\thepage}{}{}{}{}{\thepage}%
34
35\section{Change log}
36
37Version 1, February 7th, 1999
38
39\begin{itemize}\itemsep=0pt
40\item First release.
41\end{itemize}
42
43\section{Bugs}
44
45There are no known bugs.
46
47\begin{comment}
48\chapter{Getting Started}\label{gettingstarted}%
49\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
50\setfooter{\thepage}{}{}{}{}{\thepage}%
51\end{comment}
52
53\chapter{Working with the diagram window}\label{schedule}%
54\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
55\setfooter{\thepage}{}{}{}{}{\thepage}%
56
57This section describes how you work in the diagram window.
58
59In addition, you may wish to refer to the following sections:
60
61\begin{itemize}\itemsep=0pt
62\item \helpref{How To}{howto}
63%\item \helpref{Getting started}{gettingstarted}
64\item \helpref{Using Menu Commands}{menucommands}
65\item \helpref{Using Toolbar Commands}{toolbarcommands}
66\end{itemize}
67
68When you first run OGL Studio, there is a menubar, a single
69toolbar with commonly-used functionality such as loading and
70saving, a project window to the left, and an MDI (Multiple Document
71Interface) area to the right, which will contain documents.
72
73\section{Creating a diagram}
74
75To create a new diagram, click on "File|New" or the New tool.
76
77A blank document and two new toolbars will appear. The first
78new toolbar is the \helpref{diagramming formatting toolbar}{diagramformattingtoolbar}, and contains
79icons and controls for:
80
81\begin{itemize}\itemsep=0pt
82\item alignment and size cloning;
83\item arrow toggling;
84\item point size;
85\item zoom level.
86\end{itemize}
87
88The second new toolbar is called the \helpref{diagram palette}{diagrampalette} and contains:
89
90\begin{itemize}\itemsep=0pt
91\item a pointer tool used for selecting, moving and sizing objects;
92\item a text tool used for editing text or creating new text boxes;
93\item a tool for each of the symbols.
94\end{itemize}
95
96\section{Basic editing}
97
98To add a symbol, left-click on the symbol in the diagram palette,
99and then left-click on the document. The currently selected
100tool will revert to the pointer tool, so to add another object,
101click on the symbol again, then on the document.
102
103To draw a line between two objects, right-drag between the two
104objects, starting at the attachment point area you wish to start the
105line with, and ending at another appropriate attachment point
106area. The initial ordering of the lines may not be correct (lines
107may overlap, for example) so to reorder lines on a particular
108side of a object, select a line, then left-drag the desired end to a new
109position (tip: keep within the object perimeter). Left-dragging the
110line end can also be used to change the attachment point of that
111end of the line, to a new side or vertex (depending on the object).
112
113To select or deselect a object, left click the object. To select
114several objects at once, keep the shift key pressed down when
115left-clicking, or left-drag a 'lassoo' around several objects.
116
117To delete a object or line, select it and press the Delete key, or use
118"Edit|Clear", or right-click on the object to show a menu and choose
119the "Cut" item.
120
121If you are deleting a object which has one ore more lines
122attached, the lines are deleted prior to the object deletion.
123
124Shapes can be rotated by right-clicking and selecting "Rotate
125clockwise" or "Rotate anticlockwise".
126
127Line arrows can be added (pointing in the direction in which
128you created the line) by selecting the line and pressing the
129"Toggle arrow" tool on the formatting toolbar.
130
131\section{Adding text}
132
133Select the text tool (on the symbol palette) and left-click on
134a object. If you click outside a object on the document, you are
135prompted to add a new free-floating text box.
136
137Alternatively, you can select a object and press Return (or
138select the "Edit|Edit label" menu item); or right-click and
139select "Edit label" from the object menu.
140
141Change the point size using the combobox on the formatting
142toolbar.
143
144\section{Aligning objects}
145
146Select several objects and click on an alignment tool on
147the formatting toolbar. The alignment will be done with
148respect to the first object you select. You can also copy
149the size of a object to other objects with the "Copy size" tool.
150
151\section{Adding segments to lines and straightening them}
152
153To make a line have more than one segment, select the line,
154then press the "New line point" tool. Create as many new control points
155(and therefore segments) as you like. Then arrange the points
156into a rough approximation of how they should be laid out
157horizontally and vertically. Click on "Straighten lines" to
158tidy up the layout.
159
160To delete a line control point, select the line and click on
161"Cut line point" tool. An arbitrary point will be deleted.
162
163\section{Undo/Redo}
164
165Every operation can be undone, and then redone, back until
166the time at which you last saved your document. Use
167"Edit|Undo" and "Edit|Redo"; or the shortcuts Ctrl-Z and Ctrl-Y.
168
169\section{Loading and saving files}
170
171Load and save files using the main toolbar, or "File|Open...",
172"File|Save", "File|Save As..." menu items.
173
174\section{Copy and paste}
175
176OGL Studio has a diagram clipboard, into which you can copy selections. You can then
177paste the contents of clipboard into the same or another diagram window.
178
179Use "Edit|Copy" (or the toolbar copy button) to copy the selection. Use "Edit|Cut" (or the toolbar cut button) to
180copy and then delete the selection. Use "Edit|Paste" (or the toolbar paste button) to copy the selection to
181the current diagram window.
182
183Under Windows, copy and cutting also copies the selection to the Windows clipboard into metafile (vector)
184format, and Windows bitmap format. Note that not all Windows applications can accept the vector format.
185If the application seems to be pasting the wrong format into the document, try using that application's
186"Edit|Paste Special..." menu item, if one exists.
187
188\section{Keyboard shortcuts}
189
190The following keyboard shortcuts are available. {\bf Note:} The OGL Studio menus indicate which shortcuts are
191available.
192
193\begin{twocollist}\itemsep=0pt
194\twocolitem{Delete}{Clear selected object(s)}
195\twocolitem{Enter}{Edit text for selected object}
196\twocolitem{Ctrl-A}{Select all}
197\twocolitem{Ctrl-C}{Copy the selection to the clipboard}
198\twocolitem{Ctrl-D}{Duplicate the selection}
199\twocolitem{Ctrl-O}{Open a diagram}
200\twocolitem{Ctrl-N}{Create a new diagram}
201\twocolitem{Ctrl-P}{Print (not implemented)}
202\twocolitem{Ctrl-S}{Save the diagram file without prompting}
203\twocolitem{Ctrl-V}{Paste the selection}
204\twocolitem{Ctrl-W}{Close the current window}
205\twocolitem{Ctrl-X}{Cut the selection}
206\twocolitem{Ctrl-Z}{Undo last action}
207\twocolitem{Ctrl-Y}{Redo current action on the undo stack}
208\twocolitem{Ctrl-Enter}{Confirm the label editing operation (dismisses the dialog)}
209\twocolitem{Esc}{Cancel the label editing dialog}
210\twocolitem{F1}{Invoke the manual}
211\twocolitem{F12}{Save the diagram file, prompting for a filename}
212\end{twocollist}
213
214\chapter{Menu commands}\label{menucommands}%
215\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
216\setfooter{\thepage}{}{}{}{}{\thepage}%
217
218This section describes the menu commands.
219
220\section{File}
221
222\begin{twocollist}\itemsep=0pt
223\twocolitem{{\bf New...}}{Creates a new diagram window.}
224\twocolitem{{\bf Open...}}{Opens a diagram file.}
225\twocolitem{{\bf Close}}{Closes the current window.}
226\twocolitem{{\bf Save}}{Saves the current diagram without prompting.}
227\twocolitem{{\bf Save As...}}{Saves the current diagram, prompting for a filename.}
228\twocolitem{{\bf Print...}}{Prints the current diagram (not implemented).}
229\twocolitem{{\bf Print Setup...}}{Invokes the printer setup dialog.}
230\twocolitem{{\bf Print Preview}}{Invokes print preview for this diagram (not implemented).}
231\twocolitem{{\bf Exit}}{Exits the program.}
232\end{twocollist}
233
234Further menu items appended to the end of the File menu allow you
235to load previously-saved diagram files quickly.
236
237\section{Edit}
238
239\begin{twocollist}\itemsep=0pt
240\twocolitem{{\bf Undo}}{Undoes the previous action.}
241\twocolitem{{\bf Redo}}{Redoes the previously undone action.}
242\twocolitem{{\bf Cut}}{Deletes the current selection and places it on the clipboard.}
243\twocolitem{{\bf Copy}}{Copies the current selection onto the clipboard, both to the internal
244diagram clipboard and under Windows, to the Windows clipboard, in metafile and bitmap formats.}
245\twocolitem{{\bf Paste}}{Pastes from the internal diagram clipboard to the currently active window.}
246\twocolitem{{\bf Duplicate}}{Duplicates the current selection, placing the objects further down and to the right.}
247\twocolitem{{\bf Clear}}{Clears the current selection without placing it on the clipboard.}
248\twocolitem{{\bf Select All}}{Selects all objects.}
249\twocolitem{{\bf Edit Label...}}{Invokes a dialog to edit the label of the currently selected object.}
250\end{twocollist}
251
252\begin{comment}%
253\section{View}
254
255\begin{twocollist}\itemsep=0pt
256\twocolitem{{\bf Toolbar}}{Toggles the toolbar on and off.}
257\twocolitem{{\bf Status Bar}}{Toggles the status bar on and off.}
258\twocolitem{{\bf Settings}}{Invokes the \helpref{Settings dialog}{settings} to allow you to adjust a variety of
259settings.}
260\end{twocollist}
261\end{comment}%
262
263\section{Window}
264
265The Window menu is shown when one or more child window is active.
266
267\begin{twocollist}\itemsep=0pt
268\twocolitem{{\bf Cascade}}{Arranges the child windows in a cascade.}
269\twocolitem{{\bf Tile}}{Arranges the child windows in a tiled formation.}
270\twocolitem{{\bf Arrange Icons}}{Arranges the minimized icons.}
271\twocolitem{{\bf Next}}{Activates the next MDI window.}
272\end{twocollist}
273
274Further menu items appended to the end of the Window menu allow you
275to restore and activate any child window.
276
277\section{Help}
278
279\begin{twocollist}\itemsep=0pt
280\twocolitem{{\bf Help Contents}}{Invokes the on-line help, showing the contents page.}
281\twocolitem{{\bf About}}{Displays a small dialog giving copyright and version information.}
282\end{twocollist}
283
284\chapter{Toolbar commands}\label{toolbarcommands}%
285\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
286\setfooter{\thepage}{}{}{}{}{\thepage}%
287
288This section describes the commands associated with the various toolbars and diagram palette.
289
290\section{Main toolbar}\label{maintoolbar}
291
292The main toolbar is active all the time, with buttons greyed out if not appropriate to the current context.
293
294\begin{twocollist}
295\twocolitem{\image{1cm;0cm}{new.bmp}}{{\bf New} Creates a new diagram window.}
296\twocolitem{\image{1cm;0cm}{open.bmp}}{{\bf Open} Opens a diagram file.}
297\twocolitem{\image{1cm;0cm}{save.bmp}}{{\bf Save} Saves the current diagram without prompting.}
298\twocolitem{\image{1cm;0cm}{print.bmp}}{{\bf Print} Prints the current diagram (not implemented).}
299\twocolitem{\image{1cm;0cm}{copy.bmp}}{{\bf Copy} Copies the current selection onto the internal clipboard, and under Windows, into the Windows clipboard
300in metafile and bitmap formats.}
301\twocolitem{\image{1cm;0cm}{cut.bmp}}{{\bf Cut} Deletes the current selection and puts it on the clipboard.}
302\twocolitem{\image{1cm;0cm}{paste.bmp}}{{\bf Paste} Pastes the contents of the internal diagram clipboard onto the
303current diagram window.}
304\twocolitem{\image{1cm;0cm}{undo.bmp}}{{\bf Undo} Undoes the last command.}
305\twocolitem{\image{1cm;0cm}{redo.bmp}}{{\bf Redo} Redoes the last command.}
306\twocolitem{\image{1cm;0cm}{help.bmp}}{{\bf Help button} Invokes on-line help.}
307\end{twocollist}
308
309\section{Diagram formatting toolbar}\label{diagramformattingtoolbar}
310
311The diagram toolbar is visible only when a diagram window is active.
312
313\begin{twocollist}
314\twocolitem{\image{1cm;0cm}{alignl.bmp}}{{\bf Align left} Aligns the selected objects to the left side of the last selection.}
315\twocolitem{\image{1cm;0cm}{alignr.bmp}}{{\bf Align right} Aligns the selected objects to the right side of the last selection.}
316\twocolitem{\image{1cm;0cm}{alignt.bmp}}{{\bf Align top} Aligns the selected objects to the top side of the last selection.}
317\twocolitem{\image{1cm;0cm}{alignb.bmp}}{{\bf Align bottom} Aligns the selected objects to the bottom side of the last selection.}
318\twocolitem{\image{1cm;0cm}{horiz.bmp}}{{\bf Align horizontally} Aligns the selected objects to be centered horizontally with respect to the last selection.}
319\twocolitem{\image{1cm;0cm}{vert.bmp}}{{\bf Align vertically} Aligns the selected objects to be centered vertically with respect to the last selection.}
320\twocolitem{\image{1cm;0cm}{copysize.bmp}}{{\bf Copy size} Makes the selected objects the same size as the last selection.}
321\twocolitem{\image{1cm;0cm}{linearrow.bmp}}{{\bf Line arrow} Toggles an arrow on or off for the selected objects.}
322\twocolitem{\image{1cm;0cm}{newpoint.bmp}}{{\bf New point} Inserts a control point into the selected line(s).}
323\twocolitem{\image{1cm;0cm}{cutpoint.bmp}}{{\bf Cut point} Deletes a control point from the selected line(s).}
324\twocolitem{\image{1cm;0cm}{straight.bmp}}{{\bf Straighten} Straightens line segments that are nearly horizontal
325or vertical.}
326\twocolitem{\image{1cm;0cm}{pointsize.bmp}}{{\bf Point size} Allows selection of the point size for the current
327selection.}
328\twocolitem{\image{1cm;0cm}{zoom.bmp}}{{\bf Zoom control} Allows selection of the zoom level for the current diagram.}
329\end{twocollist}
330
331\section{Diagram palette}\label{diagrampalette}
332
333The diagram palette is visible only when a diagram window is active. It contains the tools for
334adding objects and text to a diagram.
335
336\begin{twocollist}
337\twocolitem{\image{1cm;0cm}{arrow.bmp}}{{\bf Pointer tool} Click on this to allow dragging and selection of objects.}
338\twocolitem{\image{1cm;0cm}{texttool.bmp}}{{\bf Text tool} Click on this, then click on objects or the diagram background
339to edit object or free-floating text labels.}
340\end{twocollist}
341
342The other tools on this palette represent demo objects.
343
344To place an object on a diagram, click on its symbol, then left-click on the diagram. You will need to click
345on the palette symbol each time you wish to create an object, since the palette selection reverts to the pointer tool
346after each object is created.
347
348\chapter{Dialogs}\label{dialogs}%
349\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
350\setfooter{\thepage}{}{}{}{}{\thepage}%
351
352To be written.
353
354\chapter{How To}\label{howto}%
355\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
356\setfooter{\thepage}{}{}{}{}{\thepage}%
357
358\section{Create a new object}
359
360Create a new diagram window if you have not already. Then:
361
362\begin{itemize}\itemsep=0pt
363\item Left-click on the required object on the palette, then left-click on the diagram window.
364\end{itemize}
365
366
367% This section commented out
368\begin{comment}
369\bibliography{refs}
370\addcontentsline{toc}{chapter}{Bibliography}
371\setheader{{\it REFERENCES}}{}{}{}{}{{\it REFERENCES}}%
372\setfooter{\thepage}{}{}{}{}{\thepage}%
373\end{comment}
374
375\addcontentsline{toc}{chapter}{Index}
376\printindex%
377
378\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}%
379\setfooter{\thepage}{}{}{}{}{\thepage}%
380
381\end{document}