wxVector<T> is header-based, use @nolibrary

[wxWidgets.git] / docs / doxygen / overviews / grid.h

diff --git a/docs/doxygen/overviews/grid.h b/docs/doxygen/overviews/grid.h
index 2acf6dfa5235c416156243c5d49f7f821a23f94f..144692dc001edaa6e1f870e4b513dca7bd573925 100644 (file)
--- a/docs/doxygen/overviews/grid.h
+++ b/docs/doxygen/overviews/grid.h
@@ -1,83 +1,89 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        grid
+// Name:        grid.h

 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-/*!
- 
- @page grid_overview wxGrid classes overview
- 
- Classes: #wxGrid
- #Introduction
- @ref simplewxgridexample_overview
- @ref complexwxgridexample_overview
- @ref gridclassesrelations_overview
- @ref keyboardandmouseinwxgrid_overview
- 
- 
- @section introductiontowxgrid Introduction
- 
+/**
+
+ @page overview_grid wxGrid Overview
+
+ Classes: wxGrid
+
+ @li @ref overview_grid_intro
+ @li @ref overview_grid_simpleexample
+ @li @ref overview_grid_complexexample
+ @li @ref overview_grid_classrelations
+ @li @ref overview_grid_keyboardmouse
+
+
+ <hr>
+
+
+ @section overview_grid_intro Introduction
+

  wxGrid and its related classes are used for displaying and editing tabular data.
  wxGrid and its related classes are used for displaying and editing tabular data.

- 
- @section simplewxgridexample Getting started: a simple example
- 
+
+
+ @section overview_grid_simpleexample Getting started: a simple example
+

  For simple applications you need only refer to the wxGrid class in your
  For simple applications you need only refer to the wxGrid class in your

- code.  This example shows how you might create a grid in a frame or
- dialog constructor and illustrates some of the formatting functions. 
- 
+ code. This example shows how you might create a grid in a frame or
+ dialog constructor and illustrates some of the formatting functions.
+

  @code
  @code

- // Create a wxGrid object
-     
+     // Create a wxGrid object
+

      grid = new wxGrid( this,
                         -1,
                         wxPoint( 0, 0 ),
                         wxSize( 400, 300 ) );
      grid = new wxGrid( this,
                         -1,
                         wxPoint( 0, 0 ),
                         wxSize( 400, 300 ) );

- 
+

      // Then we call CreateGrid to set the dimensions of the grid
      // (100 rows and 10 columns in this example)
      // Then we call CreateGrid to set the dimensions of the grid
      // (100 rows and 10 columns in this example)

-     grid-CreateGrid( 100, 10 );
- 
+     grid->CreateGrid( 100, 10 );
+

      // We can set the sizes of individual rows and columns
      // in pixels
      // We can set the sizes of individual rows and columns
      // in pixels

-     grid-SetRowSize( 0, 60 );
-     grid-SetColSize( 0, 120 );
-     
+     grid->SetRowSize( 0, 60 );
+     grid->SetColSize( 0, 120 );
+

      // And set grid cell contents as strings
      // And set grid cell contents as strings

-     grid-SetCellValue( 0, 0, "wxGrid is good" );
- 
-     // We can specify that some cells are read-only
-     grid-SetCellValue( 0, 3, "This is read-only" );
-     grid-SetReadOnly( 0, 3 );
- 
+     grid->SetCellValue( 0, 0, "wxGrid is good" );
+
+     // We can specify that some cells are read->only
+     grid->SetCellValue( 0, 3, "This is read->only" );
+     grid->SetReadOnly( 0, 3 );
+

      // Colours can be specified for grid cell contents
      // Colours can be specified for grid cell contents

-     grid-SetCellValue(3, 3, "green on grey");
-     grid-SetCellTextColour(3, 3, *wxGREEN);
-     grid-SetCellBackgroundColour(3, 3, *wxLIGHT_GREY);
- 
-     // We can specify the some cells will store numeric 
-     // values rather than strings. Here we set grid column 5 
-     // to hold floating point values displayed with width of 6 
+     grid->SetCellValue(3, 3, "green on grey");
+     grid->SetCellTextColour(3, 3, *wxGREEN);
+     grid->SetCellBackgroundColour(3, 3, *wxLIGHT_GREY);
+
+     // We can specify the some cells will store numeric
+     // values rather than strings. Here we set grid column 5
+     // to hold floating point values displayed with width of 6

      // and precision of 2
      // and precision of 2

-     grid-SetColFormatFloat(5, 6, 2);
-     grid-SetCellValue(0, 6, "3.1415");
+     grid->SetColFormatFloat(5, 6, 2);
+     grid->SetCellValue(0, 6, "3.1415");

  @endcode
  @endcode

- 
- 
- @section complexwxgridexample A more complex example
- 
+
+
+ @section overview_grid_complexexample A more complex example
+

  Yet to be written
  Yet to be written

- 
- @section wxgridclassesrelations How the wxGrid classes relate to each other
- 
+
+
+ @section overview_grid_classrelations How the wxGrid classes relate to each other
+

  Yet to be written
  Yet to be written

- 
- @section keyboardandmouseinwxgrid Keyboard and mouse actions
- 
+
+
+ @section overview_grid_keyboardmouse Keyboard and mouse actions
+

  Yet to be written
  Yet to be written

- 
- */
- 
- 
+
+*/
+