configtool.tex

Wxpython Implemented on Windows CE, Source code

many settings are disabled because they depend on other settings
being enabled (or disabled).

As an end user, you will probably only want to enable or disable
options, but it's possible you may wish to update the structure
of the settings file itself. In which case you can use the
{\bf Edit} menu to add, remove, or rename items; and you can
add custom properties to an item, but this is usually only
useful for a developer of the tool to do.

Undo/Redo can be applied to most editing commands, but (currently) not
enabling and disabling operations.

There are three tabs in the main window: {\bf Properties}, {\bf Setup.h},
and {\bf Configure}. The Properties tab contains the properties
for the selected option. Setup.h shows the setup file,
and there are buttons to allow you to copy the file to the clipboard
and regenerate the file. Similarly, the Configure tab shows
the script that will invoke configure.

The property editor allows you to show detailed information
about the option. A description for each property is shown
when you click on the property. You can also edit property values,
either by clicking and typing, or by double-clicking or clicking
on the {\bf Edit...} button. If a special editor is defined for
the property type, it will be shown.

You can invoke help for the selected option, by clicking
on the question mark toolbar button or the {\bf Help | Configuration Item Help} menu
item. If there is a help topic defined for the option, the
wxWidgets reference manual will be opened at that topic.

\begin{comment}
\chapter{Getting started: a step-by-step guide}\label{gettingstarted}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%

This section will quickly get you up and running with \ctshortname. Click
on \helpref{Step 1}{step1} to start. If you are
using a Mac, please interpret 'left-click' to mean 'click', and
'right-click' to mean 'control-click'.

\section{Step 1: creating a new configuration}\label{step1}

When you run \ctshortname for the first time, you are presented with an
empty configuration window.

Go to \helpref{Step 2}{step2} to learn how to do the next thing.

\section{Step 2: doing something else}\label{step2}

Go to \helpref{Step 3}{step3} to learn how to do a third thing.

\section{Step 3: a third thing}\label{step3}

Go to \helpref{Step 4}{step4} to learn about saving your document and reloading it.

\section{Step 4: saving and loading documents}\label{step4}

You may wish to save a document, so you can come back to it later. Click on {\bf File | Save} or
the \image{}{save.png} toolbar button. The first time you save the file, you will be prompted
for a filename: you can accept the default one provided, or choose another.

To reload the document, click on {\bf File | Open...} or the \image{}{open.gif} toolbar button.
If you are working on another document, you will be prompted to save it first.

Go to \helpref{Step 5: generating configurations}{step5}

\section{Step 5: generating configurations}\label{step5}

Todo.

Go to \helpref{Step 6: where next?}{step6}

\section{Step 6: where next?}\label{step6}

Congratulations! You have learnt how to create, edit, save, and load configuration
files.

To get to know \ctshortname more thoroughly, here are some further things you
can do.

\begin{itemize}
\item Read the \helpref{How To}{howto} section.
\item Use the help facilities: most dialogs have a {\bf Help} button for a general description, and they
also have a {\bf "?"} button for getting information on individual controls on a dialog.
\item Explore the menubar and the menus that appear when you right-click over
the window background and individual cards.
\end{itemize}

\end{comment}

\chapter{Using menubar commands}\label{menubarcommands}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%

%\image{}{menubar.gif}

This section describes the menubar commands. Commands
that are not available in the current context are disabled (shown in grey).

\section{File menu}

The File menu shows commands that are mostly related to working
with files.

\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf New...} (Ctrl+N)}{Creates a new \ctshortname document.}
\twocolitem{{\bf Open...} (Ctrl+O)}{Opens an existing document.}
\twocolitem{{\bf Close} (Ctrl+W)}{Closes the current document.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Save} (Ctrl+S)}{Saves the current document.}
\twocolitem{{\bf Save As...}}{Saves the current document under a new name.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Save Setup.h...} (Ctrl+H)}{Saves the generated setup.h file in the specified location.}
\twocolitem{{\bf Save Configure Script...} (Ctrl+G)}{Saves the generated script containing a configure command in the specified location.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Go} (F5)}{Saves the generated setup.h file or configurewx.sh script (according to the default setting) in the last-saved.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Exit} (Alt+F4)}{Exits the program.}
\end{twocollist}

\section{Edit menu}

The Edit menu shows commands that are related to editing
document elements.

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf Undo} (Ctrl+Z)}{Undoes the last undoable action.}
\twocolitem{{\bf Redo} (Ctrl+Y)}{Redoes the last redoable action.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Cut} (Ctrl+T)}{Cuts the selected option and places it on the clipboard.}
\twocolitem{{\bf Copy} (Ctrl+C)}{Copies the selected option.}
\twocolitem{{\bf Paste} (Ctrl+V)}{Pastes an option from the clipboard to the position. Whether the
option is pasted as a child or sibling of the selection is determined by whether
the selection is a folder or not. If you want finer control, right-click on the
item in the tree control and select one of the paste commands.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Add Option}}{Shows a menu for adding one of several option types.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Custom Property}}{Shows a menu for adding, editing or deleting a custom option property.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Delete Option}}{Deletes the selected option.}
\twocolitem{{\bf Rename Option}}{Shows a dialog for renaming the selected option.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Find...}}{Shows the Find dialog, allowing you to search for text
within name, description and notes for each item.}
\end{twocollist}

\section{View menu}

The View menu gives you commands related to showing or hiding windows
and various other preferences.

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf Show Toolbar}}{Shows or hides the toolbar, beneath the menubar.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Settings...} (Ctrl+T)}{Shows the \helpref{Settings Dialog}{settingsdialog}, which
relate to application-wide settings.}
\end{twocollist}

\section{Help menu}

The Help menu gives you commands related to getting help.

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf Contents}}{Invokes the on-line help, showing the contents page.}
\twocolitem{{\bf wxWidgets Help Contents}}{Invokes the on-line wxWidgets reference manual, showing the contents page.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf Configuration Option Help} (F1)}{Invokes the on-line wxWidgets reference manual at the topic for the selected option (if a topic
is defined).}
\twocolitem{{\bf What's This?}}{Click to get help on a window or configuration option.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf About...}}{Displays a dialog giving a brief description of the program.}
\end{twocollist}

\chapter{Using context menu commands}\label{contextmenucommands}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%

This section describes the context menu commands available when you right-click.
On the Mac, this is achieved with control-click.

\section{Configuration tree context menu}

This menu is shown when you right-click over the configuration tree window background.
On the Mac, this is achieved with control-click.

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf Paste before this option}}{Pastes the clipboard option before the clicked-on option.}
\twocolitem{{\bf Paste after this option}}{Pastes the clipboard option after the clicked-on option.}
\twocolitem{{\bf Paste as child of this option}}{Pastes the clipboard option as a child of the clicked-on option,
if it is a group option.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{{\bf C&opy}}{Copies the clicked-on option to the internal clipboard.}
\twocolitem{{\bf Cu&t}}{Copies the clicked-on option to the internal clipboard, and
deletes the option from the tree.}
\end{twocollist}

\chapter{Using toolbar commands}\label{toolbarcommands}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%

This section describes the toolbar commands.

%\image{}{toolbar.gif}

The toolbar provides quick access to commonly-used
commands.

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{\image{}{new.png}{\bf  New Document}}{Creates a new document.}
\twocolitem{\image{}{open.png}{\bf  Open Document}}{Opens an existing document, closing the currently open document.}
\twocolitem{\image{}{save.png}{\bf  Save Document}}{Saves the current document.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{\image{}{undo.png}{\bf  Undo}}{Undoes the last command.}
\twocolitem{\image{}{redo.png}{\bf  Redo}}{Redoes the last command.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{\image{}{copy.png}{\bf  Copy}}{Copies the selected option to an internal clipboard.}
\twocolitem{\image{}{cut.png}{\bf  Cut}}{Cuts the selected option and copies it to the internal clipboard..}
\twocolitem{\image{}{paste.png}{\bf  Paste}}{Pastes the option from the clipboard to the configuration tree.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{\image{}{go.png}{\bf Go}}{Saves the generated setup.h file or configurewx.sh script (according to the default setting) in the last-saved.}
\twocolitem{\hrule}{\htmlonly{\hrule}}
\twocolitem{\image{}{help.png}{\bf  Help}}{Shows the wxWidgets manual topic for the
\twocolitem{\image{}{helpcs.png}{\bf  Context Help}}{Shows a context-sensitive help
cursor; click on a window to show brief help about that window.}
selected configuration item.}
\end{twocollist}

\chapter{Using dialogs}\label{dialogs}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%

Most dialogs have a {\bf "?"} button on their caption to provide context-sensitive help.
Click on this and then on a control
in a dialog to get quick help on that control. You can also click on the {\bf Help} button
for more detailed help on the dialog.

\section{Settings dialog}\label{settingsdialog}

This dialog has a number of tabs to allow you to
edit different categories of settings that are applicable
to the application as a whole.

\subsection{General settings dialog}\label{generalapplicationsettingsdialog}

The General Settings Dialog allows you to set a variety of \ctshortname options.

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf Load last document on startup}}{If checked, the last viewed document will
be reloaded when \ctshortname starts up.}
% If the application terminated abnormally, this
%option will be switched off the next time \ctshortname runs in case there was a problem with
%the document file.}
%\twocolitem{{\bf Auto-save document}}{If checked, \ctshortname will regularly
%save the document to a temporary file. If \ctshortname or the operating system
%should terminate abnormally, the next time \ctshortname is run it will
%check for an auto-save file and ask if you wish to open that file.}
%\twocolitem{{\bf Show welcome dialog on startup}}{If checked, the \helpref{Welcome Dialog}{welcomedialog} will
%be shown on startup.}
\twocolitem{{\bf Show tooltips}}{If checked, tooltips will be shown in most dialogs, when you hover
the mouse pointer over a control.}
\end{twocollist}