Updated OGL documentation and tidied up some code

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@714 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

utils/ogl/docs/changes.tex

@@ -2,8 +2,18 @@
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}
 
+Version 3.0, September 8th 1998
+
+\begin{itemize}\itemsep=0pt
+\item Version for wxWindows 2.0.
+\item Various enhancements especially to wxDrawnShape
+(multiple metafiles, for different orientations).
+\item More ability to override functions e.g. OnSizeDragLeft, so events can be
+intercepted for Do/Undo.
+\end{itemize}
+
 Version 2.0, June 1st 1996
 
 \begin{itemize}\itemsep=0pt
-\item First publically released version.
+\item First publicly released version.
 \end{itemize}

utils/ogl/docs/intro.tex

@@ -21,8 +21,8 @@ These are the files that comprise the \ogl\ library.
 \item[basic.h] Header for basic objects such as wxShape and wxRectangleShape.
 \item[basic.cpp] Basic objects implementation (1).
 \item[basic2.cpp] Basic objects implementation (2).
-\item[bitmap.cpp] wxBitmapShape class header.
-\item[bitmap.cpp] wxBitmapShape implementation.
+\item[bmpshape.h] wxBitmapShape class header.
+\item[bmpshape.cpp] wxBitmapShape implementation.
 \item[canvas.h] wxShapeCanvas class header.
 \item[canvas.cpp] wxShapeCanvas class implementation.
 \item[composit.h] Composite object class header.
@@ -40,6 +40,8 @@ These are the files that comprise the \ogl\ library.
 \item[misc.cpp] Miscellaneous graphics functions implementation.
 \item[ogldiag.h] wxDiagram class header.
 \item[ogldiag.cpp] wxDiagram implementation.
+\item[mfutils.h] Metafile utilities header.
+\item[mfutils.cpp] Metafile utilities implementation.
 \end{description}
 
 

utils/ogl/docs/ogl.tex

@@ -1,11 +1,19 @@
 \documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}
-\newcommand{\ogl}[0]{{OGL}}
+\newcommand{\ogl}[0]{{OGL}}%
+\definecolour{black}{0}{0}{0}%
+\definecolour{cyan}{0}{255}{255}%
+\definecolour{green}{0}{255}{0}%
+\definecolour{magenta}{255}{0}{255}%
+\definecolour{red}{255}{0}{0}%
+\definecolour{blue}{0}{0}{200}%
+\definecolour{yellow}{255}{255}{0}%
+\definecolour{white}{255}{255}{255}%
 \input psbox.tex
 \parindent 0pt
 \parskip 11pt
 \title{Manual for Object Graphics Library 3.0}
 \author{Julian Smart}
-\date{July 1998}
+\date{September 1998}
 
 \makeindex
 \begin{document}

utils/ogl/docs/sample.tex

@@ -14,47 +14,6 @@ housekeeping logic required to get it up and running. OGLEdit also provides
 a demonstration of the Undo/Redo capability supported by the document/view classes,
 and how a typical application might implement this feature.
 
-{\it Note:} A bug in the wxWindows document/view implementation before
-version 1.66C may cause Do/Undo to misbehave and get out of sync. If this is the case,
-please replace wxCommandProcessor::Submit with the following in wx\_doc.cpp.
-
-{\small
-\begin{verbatim}
-  Bool wxCommandProcessor::Submit(wxCommand *command, Bool storeIt)
-  {
-    Bool success = command->Do();
-    if (success && storeIt)
-    {
-      if (commands.Number() == maxNoCommands)
-      {
-        wxNode *firstNode = commands.First();
-        wxCommand *firstCommand = (wxCommand *)firstNode->Data();
-        delete firstCommand;
-        delete firstNode;
-      }
-
-      // Correct a bug: we must chop off the current 'branch'
-      // so that we're at the end of the command list.
-      if (currentCommand)
-      {
-        wxNode *node = currentCommand->Next();
-        while (node)
-        {
-          wxNode *next = node->Next();
-          delete node;
-          node = next;
-        }
-      }
-    
-      commands.Append(command);
-      currentCommand = commands.Last();
-      SetMenuStrings();
-    }
-    return success;
-  }
-\end{verbatim}
-}
-
 \section{OGLEdit files}
 
 OGLEdit comprises the following source files.

utils/ogl/docs/tex2rtf.ini

@@ -1,3 +1,4 @@
+;    Last change:  JS    8 Sep 98    2:54 pm
 runTwice = yes
 titleFontSize = 12
 authorFontSize = 10
@@ -15,6 +16,11 @@ winHelpContents = yes
 winHelpTitle = "OGL Manual"
 truncateFilenames = yes
 combineSubSections = yes
-\overview [2] {\rtfonly{See also }\sethotspotcolour{off}\sethotspotunderline{on}\winhelponly{\image{}{books.bmp}}
+\overview [2] {\rtfonly{See also }\settransparency{on}\sethotspotcolour{off}\sethotspotunderline{on}\winhelponly{\image{}{books.bmp}\settransparency{off}}
 \htmlonly{\image{}{books.gif}}\helpref{#1}{#2}
 \sethotspotcolour{on}\sethotspotunderline{on}}
+\docparam [2]{\parskip{0}{\it #1}\htmlignore{\par}\parskip{10}\indented{1cm}{#2}}
+\wxheading [1]{{\bf \htmlignore{\fcol{blue}{#1}}\htmlonly{\fcol{red}{#1}}}}
+\const [0] {{\bf const}}
+\constfunc [3] {{\bf #1} {\bf #2}(#3) {\bf const}\index{#2}}
+\windowstyle [1] {{\bf #1}\index{#1}}

utils/ogl/docs/topics.tex

@@ -43,7 +43,6 @@ new shapes from wxShape.
 Instances of a class called \helpref{wxDiagram}{wxdiagram} organise collections of
 shapes, providing default file input and output behaviour.
 
-
 \section{wxDividedShape overview}\label{dividedshapeoverview}
 
 Classes: \helpref{wxDividedShape}{wxdividedshape}
@@ -112,10 +111,9 @@ Here are examples of creating wxDividedShape objects:
 \end{verbatim}
 }
 
-
 \section{wxCompositeShape overview}\label{compositeshapeoverview}
 
-Classes: \helpref{wxCompositeShape}{wxcompositeshape}, \helpref{OGLConstraint}{oglconstraint}
+Classes: \helpref{wxCompositeShape}{wxcompositeshape}, \helpref{wxOGLConstraint}{wxoglconstraint}
 
 The wxCompositeShape allows fairly complex shapes to be created, and maintains
 a set of constraints which specify the layout and proportions of child shapes.
@@ -143,12 +141,12 @@ To specify a constraint, you need three things:
 The constraining shape can be either the parent of the constrained shapes, or a sibling. The
 constrained shapes must all be siblings of each other.
 
-For an exhaustive list and description of the available constraint types, see the \helpref{OGLConstraint constructor}{oglconstraintconstr}.
+For an exhaustive list and description of the available constraint types, see the \helpref{wxOGLConstraint constructor}{wxoglconstraintconstr}.
 Note that most constraints operate in one dimension only (vertically or horizontally), so you will
 usually need to specify constraints in pairs.
 
 You can set the spacing between constraining and constrained shapes by
-calling \helpref{OGLConstraint::SetSpacing}{oglconstraintsetspacing}.
+calling \helpref{wxOGLConstraint::SetSpacing}{wxoglconstraintsetspacing}.
 
 Finally, a wxCompositeShape can have {\it divisions}, which are special child shapes of class
 wxDivisionShape (not to be confused with wxDividedShape). The purpose of this is to allow