rename UpdatePulse() to Pulse() (forgot to commit with the rest of the changes)

[wxWidgets.git] / docs / latex / wx / ttoolbar.tex

diff --git a/docs/latex/wx/ttoolbar.tex b/docs/latex/wx/ttoolbar.tex
index 2401877bca489437a5311b5384032cd66402c947..3e55e28dbdabf0bdb171cd3316297af2874eb5a3 100644 (file)
--- a/docs/latex/wx/ttoolbar.tex
+++ b/docs/latex/wx/ttoolbar.tex
@@ -10,11 +10,10 @@ buttons or toggles. A toolbar gives faster access to an application's facilities
 menus, which have to be popped up and selected rather laboriously.
 
 Instead of supplying one toolbar class with a number
 menus, which have to be popped up and selected rather laboriously.
 
 Instead of supplying one toolbar class with a number

-of different implementations depending on platform, wxWindows separates
+of different implementations depending on platform, wxWidgets separates

 out the classes. This is because there are a number of different toolbar
 styles that you may wish to use simultaneously, and also, future
 out the classes. This is because there are a number of different toolbar
 styles that you may wish to use simultaneously, and also, future

-toolbar implementations will emerge (for example, using the
-new-style Windows `coolbar' as seen in Microsoft applications) which
+toolbar implementations will emerge which

 cannot all be shoe-horned into the one class.
 
 For each platform, the symbol {\bf wxToolBar} is defined to be one of the
 cannot all be shoe-horned into the one class.
 
 For each platform, the symbol {\bf wxToolBar} is defined to be one of the


@@ -25,8 +24,8 @@ The following is a summary of the toolbar classes and their differences.
 \begin{itemize}\itemsep=0pt
 \item {\bf wxToolBarBase.} This is a base class with pure virtual functions,
 and should not be used directly.
 \begin{itemize}\itemsep=0pt
 \item {\bf wxToolBarBase.} This is a base class with pure virtual functions,
 and should not be used directly.

-\item {\bf wxToolBarSimple.} A simple toolbar class written entirely with generic wxWindows
-functionality. A simply 3D effect for buttons is possible, but it is not consistent
+\item {\bf wxToolBarSimple.} A simple toolbar class written entirely with generic wxWidgets
+functionality. A simple 3D effect for buttons is possible, but it is not consistent

 with the Windows look and feel. This toolbar can scroll, and you can have arbitrary
 numbers of rows and columns.
 \item {\bf wxToolBarMSW.} This class implements an old-style Windows toolbar, only on
 with the Windows look and feel. This toolbar can scroll, and you can have arbitrary
 numbers of rows and columns.
 \item {\bf wxToolBarMSW.} This class implements an old-style Windows toolbar, only on


@@ -39,7 +38,8 @@ CreateTools must be called after the tools have been added.
 No absolute positioning is supported but you can specify the number
 of rows, and add tool separators with {\bf AddSeparator}.
 Tooltips are supported. {\bf OnRightClick} is not supported. This is the default wxToolBar
 No absolute positioning is supported but you can specify the number
 of rows, and add tool separators with {\bf AddSeparator}.
 Tooltips are supported. {\bf OnRightClick} is not supported. This is the default wxToolBar

-on Windows 95, Windows NT 4 and above.
+on Windows 95, Windows NT 4 and above. With the style wxTB\_FLAT, the flat toolbar
+look is used, with a border that is highlighted when the cursor moves over the buttons.

 \end{itemize}
 
 A toolbar might appear as a single row of images under
 \end{itemize}
 
 A toolbar might appear as a single row of images under


@@ -61,9 +61,7 @@ as the demo shows, before adding tools to the button bar. Don't supply more than
 one bitmap for each tool, because the toolbar generates all three images (normal,
 depressed and checked) from the single bitmap you give it.
 
 one bitmap for each tool, because the toolbar generates all three images (normal,
 depressed and checked) from the single bitmap you give it.
 

-To intercept
-
-\subsection{Using the toolbar library}
+\subsection{Using the toolbar library}\label{usingtoolbarlibrary}

 
 Include {\tt "wx/toolbar.h"}, or if using a class directly, one of:
 
 
 Include {\tt "wx/toolbar.h"}, or if using a class directly, one of:
 


@@ -74,7 +72,9 @@ Include {\tt "wx/toolbar.h"}, or if using a class directly, one of:
 \end{itemize}
 
 Example of toolbar use are given in the sample program ``toolbar''. The
 \end{itemize}
 
 Example of toolbar use are given in the sample program ``toolbar''. The

-source is given below.
+source is given below. In fact it is out of date because recommended
+practise is to use event handlers (using EVT\_MENU or EVT\_TOOL) instead of
+overriding OnLeftClick.

 
 {\small
 \begin{verbatim}
 
 {\small
 \begin{verbatim}


@@ -86,7 +86,7 @@ source is given below.
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart

-// Licence:    wxWindows licence
+// License:    wxWindows license

 /////////////////////////////////////////////////////////////////////////////
 
 // For compilers that support precompilation, includes "wx/wx.h".
 /////////////////////////////////////////////////////////////////////////////
 
 // For compilers that support precompilation, includes "wx/wx.h".


@@ -159,13 +159,13 @@ bool MyApp::OnInit(void)
   // function that lays out default decorations and the remaining content window.
   wxSizeEvent event(wxSize(-1, -1), frame->GetId());
   frame->OnSize(event);
   // function that lays out default decorations and the remaining content window.
   wxSizeEvent event(wxSize(-1, -1), frame->GetId());
   frame->OnSize(event);

-  frame->Show(TRUE);
+  frame->Show(true);

 
 

-  frame->SetStatusText("Hello, wxWindows");
+  frame->SetStatusText("Hello, wxWidgets");

   
   SetTopWindow(frame);
 
   
   SetTopWindow(frame);
 

-  return TRUE;
+  return true;

 }
 
 bool MyApp::InitToolbar(wxToolBar* toolBar)
 }
 
 bool MyApp::InitToolbar(wxToolBar* toolBar)


@@ -200,24 +200,24 @@ bool MyApp::InitToolbar(wxToolBar* toolBar)
 #endif
   int currentX = 5;
 
 #endif
   int currentX = 5;
 

-  toolBar->AddTool(wxID_NEW, *(toolBarBitmaps[0]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "New file");
+  toolBar->AddTool(wxID_NEW, *(toolBarBitmaps[0]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "New file");

   currentX += width + 5;
   currentX += width + 5;

-  toolBar->AddTool(wxID_OPEN, *(toolBarBitmaps[1]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Open file");
+  toolBar->AddTool(wxID_OPEN, *(toolBarBitmaps[1]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Open file");

   currentX += width + 5;
   currentX += width + 5;

-  toolBar->AddTool(wxID_SAVE, *(toolBarBitmaps[2]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Save file");
+  toolBar->AddTool(wxID_SAVE, *(toolBarBitmaps[2]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Save file");

   currentX += width + 5;
   toolBar->AddSeparator();
   currentX += width + 5;
   toolBar->AddSeparator();

-  toolBar->AddTool(wxID_COPY, *(toolBarBitmaps[3]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Copy");
+  toolBar->AddTool(wxID_COPY, *(toolBarBitmaps[3]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Copy");

   currentX += width + 5;
   currentX += width + 5;

-  toolBar->AddTool(wxID_CUT, *(toolBarBitmaps[4]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Cut");
+  toolBar->AddTool(wxID_CUT, *(toolBarBitmaps[4]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Cut");

   currentX += width + 5;
   currentX += width + 5;

-  toolBar->AddTool(wxID_PASTE, *(toolBarBitmaps[5]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Paste");
+  toolBar->AddTool(wxID_PASTE, *(toolBarBitmaps[5]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Paste");

   currentX += width + 5;
   toolBar->AddSeparator();
   currentX += width + 5;
   toolBar->AddSeparator();

-  toolBar->AddTool(wxID_PRINT, *(toolBarBitmaps[6]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Print");
+  toolBar->AddTool(wxID_PRINT, *(toolBarBitmaps[6]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Print");

   currentX += width + 5;
   toolBar->AddSeparator();
   currentX += width + 5;
   toolBar->AddSeparator();

-  toolBar->AddTool(wxID_HELP, *(toolBarBitmaps[7]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Help");
+  toolBar->AddTool(wxID_HELP, *(toolBarBitmaps[7]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Help");

 
   toolBar->Realize();
 
 
   toolBar->Realize();
 


@@ -226,7 +226,7 @@ bool MyApp::InitToolbar(wxToolBar* toolBar)
   for (i = 0; i < 8; i++)
     delete toolBarBitmaps[i];
 
   for (i = 0; i < 8; i++)
     delete toolBarBitmaps[i];
 

-  return TRUE;
+  return true;

 }
 
 // wxID_HELP will be processed for the 'About' menu and the toolbar help button.
 }
 
 // wxID_HELP will be processed for the 'About' menu and the toolbar help button.


@@ -249,12 +249,12 @@ MyFrame::MyFrame(wxFrame* parent, wxWindowID id, const wxString& title, const wx
 
 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 {
 
 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 {

-    Close(TRUE);
+    Close(true);

 }
 
 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 {
 }
 
 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 {

-    (void)wxMessageBox("wxWindows toolbar sample", "About wxToolBar");
+    (void)wxMessageBox("wxWidgets toolbar sample", "About wxToolBar");

 }
 
 // Define the behaviour for the frame closing
 }
 
 // Define the behaviour for the frame closing