Removed old classes and functions

[wxWidgets.git] / contrib / docs / latex / fl / body.tex

diff --git a/contrib/docs/latex/fl/body.tex b/contrib/docs/latex/fl/body.tex
index 402c7e9cf8f80c075a61e327c5e4e37561371d51..0d3cac65f157500e920d95cdb0bf53e0cc20f7c3 100644 (file)
--- a/contrib/docs/latex/fl/body.tex
+++ b/contrib/docs/latex/fl/body.tex
@@ -12,6 +12,12 @@ and customized. FL handles many decoration and dragging
 issues, giving applications the kind of docking facilities
 that Visual C++ and Netscape Navigator possess.
 
 issues, giving applications the kind of docking facilities
 that Visual C++ and Netscape Navigator possess.
 

+FL was written by Aleksandras Gluchovas, and is heavily used in
+wxWorkshop which he also wrote the bulk of.
+
+{\bf Please note} that this guide is in its infancy, and contributions
+from FL users are very welcome.
+

 The following screenshot (from fl\_demo1) shows a frame with a number of
 bars that can be dragged around. The vertical grippers with
 two lines allow a bar to be dragged in that row, changing the
 The following screenshot (from fl\_demo1) shows a frame with a number of
 bars that can be dragged around. The vertical grippers with
 two lines allow a bar to be dragged in that row, changing the


@@ -30,7 +36,7 @@ to it when required.
 A close button (x) hides a bar completely. You can get it back again
 by right-clicking and selecting the appropriate menu item.
 
 A close button (x) hides a bar completely. You can get it back again
 by right-clicking and selecting the appropriate menu item.
 

-A left or right pointing arrow button expands the pane in that direction.
+A left, right, up or down arrow button expands the pane in that direction.

 
 \center{\image{}{screen01.bmp}}
 
 
 \center{\image{}{screen01.bmp}}
 


@@ -42,7 +48,7 @@ FL can be found under the 'contrib' hierarchy, in the following directories:
   contrib/src/fl
   contrib/include/wx/fl
   contrib/samples/fl
   contrib/src/fl
   contrib/include/wx/fl
   contrib/samples/fl

-  contrib/docs/latex/wx
+  contrib/docs/latex/fl

   docs/html/fl
   docs/htmlhelp/fl.chm
   docs/pdf/fl.pdf
   docs/html/fl
   docs/htmlhelp/fl.chm
   docs/pdf/fl.pdf


@@ -56,7 +62,9 @@ To compile FL:
 and compile.
 \item Under Unix, FL should be configured when you configured
 wxWindows. Make FL by changing directory to contrib/src/fl and
 and compile.
 \item Under Unix, FL should be configured when you configured
 wxWindows. Make FL by changing directory to contrib/src/fl and

-type 'make'.
+type 'make'. {\bf Note:} there is currently a
+problem with the wxWindows build system that means that
+only the static version of library can be built at present.

 \end{itemize}
 
 To use FL:
 \end{itemize}
 
 To use FL:


@@ -68,21 +76,38 @@ To use FL:
 
 \section{FL concepts}
 
 
 \section{FL concepts}
 

-The following is taken from fl\_demo1 and shows the main code implementing the
-user interface as illustrated in \helpref{What is FL?}{whatisfl}.
-
-Notable points in the code:
+These are typical steps when adding FL functionality to your application.

 
 \begin{itemize}\itemsep=0pt
 
 \begin{itemize}\itemsep=0pt

-\item creating a new \helpref{wxFrameLayout}{wxframelayout} passing the top-level frame and the window that
+\item include the appropriate header files;
+\item create a new \helpref{wxFrameLayout}{wxframelayout} passing the top-level frame and the window that

 is interpreted as the main 'client' window;
 is interpreted as the main 'client' window;

-\item setting an updates manager for optimizing drag operations;
-\item adding plugins for implementing various features;
-\item adding bars;
-\item enabling floating mode.
+\item set an updates manager for optimizing drag operations;
+\item add plugins for implementing various features;
+\item add bars;
+\item enable floating mode for the layout if required;
+\item delete the frame layout in the main frame's destructor.

 \end{itemize}
 
 \end{itemize}
 

+The following is taken from fl\_demo1 and shows the main code implementing the
+user interface as illustrated in \helpref{What is FL?}{whatisfl}.
+

 \begin{verbatim}
 \begin{verbatim}

+// fl headers
+#include "wx/fl/controlbar.h"     // core API
+
+// extra plugins
+#include "wx/fl/barhintspl.h"    // bevel for bars with "X"s and grooves
+#include "wx/fl/rowdragpl.h"     // NC-look with draggable rows
+#include "wx/fl/cbcustom.h"      // customization plugin
+#include "wx/fl/hintanimpl.h"
+
+// beauty-care
+#include "wx/fl/gcupdatesmgr.h"  // smooth d&d
+#include "wx/fl/antiflickpl.h"   // double-buffered repaint of decorations
+#include "wx/fl/dyntbar.h"       // auto-layout toolbar
+#include "wx/fl/dyntbarhnd.h"    // control-bar dimension handler for it
+

 MyFrame::MyFrame(wxFrame *frame)
     : wxFrame( frame, -1, "wxWindows 2.0 wxFrameLayout Test Application", wxDefaultPosition, 
           wxSize( 700, 500 ), 
 MyFrame::MyFrame(wxFrame *frame)
     : wxFrame( frame, -1, "wxWindows 2.0 wxFrameLayout Test Application", wxDefaultPosition, 
           wxSize( 700, 500 ), 


@@ -135,7 +160,7 @@ MyFrame::MyFrame(wxFrame *frame)
                       sizes0, FL_ALIGN_TOP,     // alignment ( 0-top,1-bottom, etc)
                       0,                        // insert into 0th row (vert. position)
                       0,                        // offset from the start of row (in pixels)
                       sizes0, FL_ALIGN_TOP,     // alignment ( 0-top,1-bottom, etc)
                       0,                        // insert into 0th row (vert. position)
                       0,                        // offset from the start of row (in pixels)

-                      "InfoViewer1",            // name to refere in customization pop-ups
+                      "InfoViewer1",            // name for reference in customization pop-ups

                       TRUE
                     );
     
                       TRUE
                     );
     


@@ -143,7 +168,7 @@ MyFrame::MyFrame(wxFrame *frame)
                       sizes0, FL_ALIGN_TOP,     // alignment ( 0-top,1-bottom, etc)
                       1,                        // insert into 0th row (vert. position)
                       0,                        // offset from the start of row (in pixels)
                       sizes0, FL_ALIGN_TOP,     // alignment ( 0-top,1-bottom, etc)
                       1,                        // insert into 0th row (vert. position)
                       0,                        // offset from the start of row (in pixels)

-                      "InfoViewer2",            // name to refere in customization pop-ups
+                      "InfoViewer2",            // name for reference in customization pop-ups

                       TRUE
                     );
     
                       TRUE
                     );
     


@@ -151,7 +176,7 @@ MyFrame::MyFrame(wxFrame *frame)
                       sizes1, FL_ALIGN_TOP,     // alignment ( 0-top,1-bottom, etc)
                       0,                        // insert into 0th row (vert. position)
                       0,                        // offset from the start of row (in pixels)
                       sizes1, FL_ALIGN_TOP,     // alignment ( 0-top,1-bottom, etc)
                       0,                        // insert into 0th row (vert. position)
                       0,                        // offset from the start of row (in pixels)

-                      "ToolBar1",               // name to refer in customization pop-ups
+                      "ToolBar1",               // name for reference in customization pop-ups

                       TRUE
                     );
     
                       TRUE
                     );
     


@@ -173,13 +198,62 @@ MyFrame::MyFrame(wxFrame *frame)
                       sizes2, FL_ALIGN_TOP, // alignment ( 0-top,1-bottom, etc)
                       0,                    // insert into 0th row (vert. position)
                       0,                    // offset from the start of row (in pixels)
                       sizes2, FL_ALIGN_TOP, // alignment ( 0-top,1-bottom, etc)
                       0,                    // insert into 0th row (vert. position)
                       0,                    // offset from the start of row (in pixels)

-                      "ToolBar2",           // name to refere in customization pop-ups
+                      "ToolBar2",           // name for reference in customization pop-ups

                       FALSE
                     );
     
     mpLayout->EnableFloating( TRUE ); // off, thinking about wxGtk...
 }
                       FALSE
                     );
     
     mpLayout->EnableFloating( TRUE ); // off, thinking about wxGtk...
 }

+
+MyFrame::~MyFrame()
+{
+    if ( mpLayout) 
+        delete mpLayout; // should be destroyed manually
+}
+\end{verbatim}
+
+\section{Controlling dragging behaviour}\label{controllingdragbehav}
+
+Various pane-dragging behaviours are supported. FL can
+show an outline of where the window would be docked
+if you stopped dragging at that point.
+
+This is a list of properties of interest in the cbCommonPaneProperties
+structure:
+
+\begin{verbatim}
+    bool mRealTimeUpdatesOn;     // default: ON
+    bool mOutOfPaneDragOn;       // default: ON
+    bool mExactDockPredictionOn; // default: OFF
+    bool mNonDestructFrictionOn; // default: OFF
+\end{verbatim}
+
+To get behaviour similar to Microsoft's DevStudio drag-ghost behaviour,
+mRealTimeUpdatesOn have to be set to FALSE, for example:
+
+\begin{verbatim}
+    cbCommonPaneProperties props;
+    ....
+    ....
+    props.mRealTimeUpdatesOn = FALSE;
+    fl->SetPaneProperties( props, wxALL_PANES );

 \end{verbatim}
 
 \end{verbatim}
 

+{\it mOutOfPaneDragOn} specifies whether bars can be dragged
+away from this pane. (Note: this may not currently be working.)
+
+{\it mExactDockPredictionOn} is only relevant when {\it mRealTimeUpdatesOn} is FALSE,
+and then the hint rectangle behaves a little jumpily. It tries to show
+exatly how the bar would look and where it would be docked if the dragging finished right
+now, i.e. the final position, with all the 'friction-physics' calculated.
+Otherwise the hint flies smothly above the surface only hinting whether the bar
+will be docked vertically or horizontally if dropped now.
+This is a feature you won't find anywhere else!

 
 

+{\it mNonDestructFirctionOn} causes the bars not being dragged
+to stay where they are, while the currently dragged one is 'diving'
+through the underlaying panes, docking itself in and out in real time.
+Otherwise the stationary bars would be pushed around messing up the composition permanently.
+This flag is irelevant when {\it mRealTimeUpdatesOn} is FALSE, as the ghost-rect
+does not do any docking until the drag finishes.