X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d7463f75f9c170c29b4965d27dccf535ac32cfde..cb7d73757f9e8771e7d8fc6b22f1acf27aac35bd:/utils/configtool/docs/manual/configtool.tex
diff --git a/utils/configtool/docs/manual/configtool.tex b/utils/configtool/docs/manual/configtool.tex
index 0dbc4b4b73..818cb730ab 100644
--- a/utils/configtool/docs/manual/configtool.tex
+++ b/utils/configtool/docs/manual/configtool.tex
@@ -41,7 +41,7 @@
\setheader{{\it Welcome}}{}{}{}{}{{\it Welcome}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
-Welcome to \ctname, the easy way to configure wxWindows.
+Welcome to \ctname, the easy way to configure wxWidgets.
Instead of tweaking a setup.h file, or typing a long configure
command, you can now check and uncheck options in a convenient
GUI tool, read the relevant reference document for each
@@ -63,7 +63,7 @@ The \ctname home page is at:
{\tt \cturl}
For help with \ctshortname or to report bugs,
-please go to the wxWindows web site.
+please go to the wxWidgets web site.
\section{Credits}
@@ -80,7 +80,7 @@ please go to the wxWindows web site.
{\it Additional programming by}
-{\bf The wxWindows development team}
+{\bf The wxWidgets development team}
\end{center}
@@ -107,7 +107,7 @@ in your filesystem. A directory of the form wxconfigtool-x.xx
Add the location to your PATH and run the application with
'wxconfigtool'. You may wish to set the environment variable
-WXCONFIGTOOLDIR so that wxWindows Configuration Tool can find its data files.
+WXCONFIGTOOLDIR so that wxWidgets Configuration Tool can find its data files.
For example:
@@ -125,14 +125,14 @@ script in a location already on your PATH, such as
\begin{verbatim}
#!/bin/sh
- # Invokes wxWindows Configuration Tool
+ # Invokes wxWidgets Configuration Tool
export WXCONFIGTOOLDIR=/home/mydir/wxconfigtool-1.01
$WXCONFIGTOOLDIR/wxconfigtool $*
\end{verbatim}
{\bf On Mac:}
-Download and unarchive the HQX file, and drag the wxWindows Configuration Tool folder to an appropriate location
+Download and unarchive the HQX file, and drag the wxWidgets Configuration Tool folder to an appropriate location
on your hard disk. Then double-click on the 'wxconfigtool' executable.
\chapter{Release notes}\label{releasenotes}%
@@ -151,6 +151,21 @@ the licence files in the installation directory:
\section{What's New?}\label{whatsnew}
+{\bf Version 1.02, June 16th 2003}
+
+\begin{itemize}\itemsep=10pt
+\item The Platform group has been renamed
+Target, since there can be multiple targets
+per platform.
+\item The Windows/Universal target has been added.
+\end{itemize}
+
+{\bf Version 1.01, June 14th 2003}
+
+\begin{itemize}\itemsep=10pt
+\item Added Find facility.
+\end{itemize}
+
{\bf Version 1.0, June 11th 2003}
\begin{itemize}\itemsep=10pt
@@ -191,7 +206,7 @@ the command-line. Just like configure :-)
\section{Differences between Windows, Linux and Mac versions}\label{platformdifferences}
-Although every effort has been made to make wxWindows Configuration Tool work
+Although every effort has been made to make wxWidgets Configuration Tool work
the same way on different environments, some small differences
are inevitable.
@@ -284,7 +299,7 @@ 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
-wxWindows reference manual will be opened at that topic.
+wxWidgets reference manual will be opened at that topic.
\begin{comment}
\chapter{Getting started: a step-by-step guide}\label{gettingstarted}%
@@ -371,6 +386,8 @@ with files.
\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}
@@ -397,6 +414,9 @@ item in the tree control and select one of the paste commands.}
\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}
@@ -419,9 +439,9 @@ 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 wxWindows Help Contents}}{Invokes the on-line wxWindows reference manual, 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 wxWindows reference manual at the topic for the selected option (if a topic
+\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}}
@@ -476,7 +496,9 @@ commands.
\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{}{help.png}{\bf Help}}{Shows the wxWindows manual topic for the
+\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.}
@@ -524,7 +546,7 @@ The Location Settings Dialog allows you to choose various locations.
\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf wxWindows hierarchy}}{This determines where \ctshortname will look
+\twocolitem{{\bf wxWidgets hierarchy}}{This determines where \ctshortname will look
when prompting for filenames.}
\twocolitem{{\bf Use WXWIN environment variable}}{Check this to use
the value of the WXWIN variable instead of the path entered in the text field.}
@@ -585,7 +607,12 @@ group and its children is considered to be a virtual
taken into account if the option is a radio option
or group. For each radio option, all other mutually
exclusive options need to be listed. See the
-{\bf Platform} group for an example of this.
+{\bf Target} group for an example of this.
+
+The results of these dependencies can be overridden by
+indeterminate-if, which is done last of all and can
+make the option user-selectable when otherwise it
+would be constrained to be enabled or disabled.
\section{How \ctshortname generates the configure commands}
@@ -614,7 +641,7 @@ by using the {\bf value} custom string property.
\section{How \ctshortname generates the setup.h file}
-The {\bf Platforms} group is ignored. In all other
+The {\bf Target} group is ignored. In all other
cases, if the setting is prefixed by wxUSE_...
and it's a boolean setting, \ctshortname will
output 1 or 0 depending on the setting state.
@@ -639,8 +666,8 @@ if the option is constrained to always be disabled
or enabled in the current context, then it is greyed out
(deactivated) to prevent the user from changing the state.
-There are four kinds of dependencies: requires, precludes,
-enabled-if, and enabled-if-not. Each one represents a
+There are five kinds of dependencies: requires, precludes,
+enabled-if, enabled-if-not, and indeterminate-if. Each one represents a
relationship between the current option (a) and one
or more named options (b). For the sake of argument
we will consider only one other option, but multiple
@@ -697,6 +724,24 @@ For example, wxUSE_TOOLBAR_SIMPLE enabled-if-not wxUSE_TOOLBAR_NATIVE.
1 1
\end{verbatim}
+5. a {\bf indeterminate-if} b
+
+For example, wxUSE_UNICODE indeterminate-if Custom.
+
+\begin{verbatim}
+ a b
+
+ ? 1
+\end{verbatim}
+
+This overrides all the other dependencies, and allows you
+to make an option user-choosable in some circumstances,
+when otherwise it would be constrained to be either enabled or
+disabled. You may need to use an intermediate option to
+make sensible use of this: for example make the intermediate
+option dependent on a number of factors, such as Unicode not being
+available on some platforms.
+
\section{How to specify platform-specific dependencies}\label{platformdependencies}
You can associate one or more options as part of the