wxColour source cleaning. Corrections to 'const unsigned char' within wxColour docs.

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

diff --git a/docs/latex/wx/gridbagsizer.tex b/docs/latex/wx/gridbagsizer.tex
index a0d1e0ff4f246eab71c400cc2a516b6aca719f81..887791cd4702401f1f4bac97426be67309ca00f6 100644 (file)
--- a/docs/latex/wx/gridbagsizer.tex
+++ b/docs/latex/wx/gridbagsizer.tex
@@ -3,23 +3,23 @@
 
 A \helpref{wxSizer}{wxsizer} that can lay out items in a virtual grid
 like a \helpref{wxFlexGridSizer}{wxflexgridsizer} but in this case
 
 A \helpref{wxSizer}{wxsizer} that can lay out items in a virtual grid
 like a \helpref{wxFlexGridSizer}{wxflexgridsizer} but in this case

-explicit positioning of the items is allowed using
+explicit positioning of the items is allowed using 

 \helpref{wxGBPosition}{wxgbposition}, and items can optionally span
 more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}.
 
 \helpref{wxGBPosition}{wxgbposition}, and items can optionally span
 more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}.
 

-

 \wxheading{Derived from}
 
 \wxheading{Derived from}
 

-\helpref{wxFlexGridSizer}{wxflexgridsizer}
+\helpref{wxFlexGridSizer}{wxflexgridsizer}\\
+\helpref{wxGridSizer}{wxgridsizer}\\
+\helpref{wxSizer}{wxsizer}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/gbsizer.h>
 
 
 \wxheading{Include files}
 
 <wx/gbsizer.h>
 

-

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-

 \membersection{wxGridBagSizer::wxGridBagSizer}\label{wxgridbagsizerwxgridbagsizer}
 
 \func{}{wxGridBagSizer}{\param{int }{vgap = 0}, \param{int }{hgap = 0}}
 \membersection{wxGridBagSizer::wxGridBagSizer}\label{wxgridbagsizerwxgridbagsizer}
 
 \func{}{wxGridBagSizer}{\param{int }{vgap = 0}, \param{int }{hgap = 0}}


@@ -27,22 +27,18 @@ more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}.
 Constructor, with optional parameters to specify the gap between the
 rows and columns.
 
 Constructor, with optional parameters to specify the gap between the
 rows and columns.
 

-

 \membersection{wxGridBagSizer::Add}\label{wxgridbagsizeradd}
 
 \membersection{wxGridBagSizer::Add}\label{wxgridbagsizeradd}
 

-\func{bool}{Add}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+\func{wxSizerItem*}{Add}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}

 
 

-\func{bool}{Add}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
-
-\func{bool}{Add}{\param{int }{width}, \param{int }{height}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
-
-\func{bool}{Add}{\param{wxGBSizerItem* }{item}}
-
-The Add methods return true if the item was successfully placed at the
-given position, false if something was already there.
+\func{wxSizerItem*}{Add}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}

 
 

+\func{wxSizerItem*}{Add}{\param{int }{width}, \param{int }{height}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}

 
 

+\func{wxSizerItem*}{Add}{\param{wxGBSizerItem* }{item}}

 
 

+The Add methods return a valid pointer if the item was successfully placed at the
+given position, NULL if something was already there.

 
 \membersection{wxGridBagSizer::CalcMin}\label{wxgridbagsizercalcmin}
 
 
 \membersection{wxGridBagSizer::CalcMin}\label{wxgridbagsizercalcmin}
 


@@ -51,7 +47,6 @@ given position, false if something was already there.
 Called when the managed size of the sizer is needed or when layout
 needs done.
 
 Called when the managed size of the sizer is needed or when layout
 needs done.
 

-

 \membersection{wxGridBagSizer::CheckForIntersection}\label{wxgridbagsizercheckforintersection}
 
 \func{bool}{CheckForIntersection}{\param{wxGBSizerItem* }{item}, \param{wxGBSizerItem* }{excludeItem = NULL}}
 \membersection{wxGridBagSizer::CheckForIntersection}\label{wxgridbagsizercheckforintersection}
 
 \func{bool}{CheckForIntersection}{\param{wxGBSizerItem* }{item}, \param{wxGBSizerItem* }{excludeItem = NULL}}


@@ -59,12 +54,10 @@ needs done.
 \func{bool}{CheckForIntersection}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{wxGBSizerItem* }{excludeItem = NULL}}
 
 Look at all items and see if any intersect (or would overlap) the given
 \func{bool}{CheckForIntersection}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{wxGBSizerItem* }{excludeItem = NULL}}
 
 Look at all items and see if any intersect (or would overlap) the given

-item.  Returns true if so, false if there would be no overlap.  If an
+item. Returns true if so, false if there would be no overlap. If an

 excludeItem is given then it will not be checked for intersection, for
 example it may be the item we are checking the position of.
 
 excludeItem is given then it will not be checked for intersection, for
 example it may be the item we are checking the position of.
 

-
-

 \membersection{wxGridBagSizer::FindItem}\label{wxgridbagsizerfinditem}
 
 \func{wxGBSizerItem*}{FindItem}{\param{wxWindow* }{window}}
 \membersection{wxGridBagSizer::FindItem}\label{wxgridbagsizerfinditem}
 
 \func{wxGBSizerItem*}{FindItem}{\param{wxWindow* }{window}}


@@ -74,7 +67,14 @@ example it may be the item we are checking the position of.
 Find the sizer item for the given window or subsizer, returns NULL if
 not found. (non-recursive)
 
 Find the sizer item for the given window or subsizer, returns NULL if
 not found. (non-recursive)
 

+\membersection{wxGridBagSizer::FindItemAtPoint}\label{wxgridbagsizerfinditematpoint}

 
 

+\func{wxGBSizerItem*}{FindItemAtPoint}{\param{const wxPoint\& }{pt}}
+
+Return the sizer item located at the point given in pt, or NULL if
+there is no item at that point. The (x,y) coordinates in pt correspond
+to the client coordinates of the window using the sizer for
+layout. (non-recursive)

 
 \membersection{wxGridBagSizer::FindItemAtPosition}\label{wxgridbagsizerfinditematposition}
 
 
 \membersection{wxGridBagSizer::FindItemAtPosition}\label{wxgridbagsizerfinditematposition}
 


@@ -83,8 +83,6 @@ not found. (non-recursive)
 Return the sizer item for the given grid cell, or NULL if there is no
 item at that position. (non-recursive)
 
 Return the sizer item for the given grid cell, or NULL if there is no
 item at that position. (non-recursive)
 

-
-

 \membersection{wxGridBagSizer::FindItemWithData}\label{wxgridbagsizerfinditemwithdata}
 
 \func{wxGBSizerItem*}{FindItemWithData}{\param{const wxObject* }{userData}}
 \membersection{wxGridBagSizer::FindItemWithData}\label{wxgridbagsizerfinditemwithdata}
 
 \func{wxGBSizerItem*}{FindItemWithData}{\param{const wxObject* }{userData}}


@@ -92,25 +90,19 @@ item at that position. (non-recursive)
 Return the sizer item that has a matching user data (it only compares
 pointer values) or NULL if not found. (non-recursive)
 
 Return the sizer item that has a matching user data (it only compares
 pointer values) or NULL if not found. (non-recursive)
 

-
-

 \membersection{wxGridBagSizer::GetCellSize}\label{wxgridbagsizergetcellsize}
 
 \constfunc{wxSize}{GetCellSize}{\param{int }{row}, \param{int }{col}}
 
 \membersection{wxGridBagSizer::GetCellSize}\label{wxgridbagsizergetcellsize}
 
 \constfunc{wxSize}{GetCellSize}{\param{int }{row}, \param{int }{col}}
 

-Get the size of the specified cell, including hgap and vgap.  Only
+Get the size of the specified cell, including hgap and vgap. Only

 valid after a Layout.
 
 valid after a Layout.
 

-
-

 \membersection{wxGridBagSizer::GetEmptyCellSize}\label{wxgridbagsizergetemptycellsize}
 
 \constfunc{wxSize}{GetEmptyCellSize}{\void}
 
 Get the size used for cells in the grid with no item.
 
 \membersection{wxGridBagSizer::GetEmptyCellSize}\label{wxgridbagsizergetemptycellsize}
 
 \constfunc{wxSize}{GetEmptyCellSize}{\void}
 
 Get the size used for cells in the grid with no item.
 

-
-

 \membersection{wxGridBagSizer::GetItemPosition}\label{wxgridbagsizergetitemposition}
 
 \func{wxGBPosition}{GetItemPosition}{\param{wxWindow* }{window}}
 \membersection{wxGridBagSizer::GetItemPosition}\label{wxgridbagsizergetitemposition}
 
 \func{wxGBPosition}{GetItemPosition}{\param{wxWindow* }{window}}


@@ -121,8 +113,6 @@ Get the size used for cells in the grid with no item.
 
 Get the grid position of the specified item.
 
 
 Get the grid position of the specified item.
 

-
-

 \membersection{wxGridBagSizer::GetItemSpan}\label{wxgridbagsizergetitemspan}
 
 \func{wxGBSpan}{GetItemSpan}{\param{wxWindow* }{window}}
 \membersection{wxGridBagSizer::GetItemSpan}\label{wxgridbagsizergetitemspan}
 
 \func{wxGBSpan}{GetItemSpan}{\param{wxWindow* }{window}}


@@ -133,8 +123,6 @@ Get the grid position of the specified item.
 
 Get the row/col spanning of the specified item
 
 
 Get the row/col spanning of the specified item
 

-
-

 \membersection{wxGridBagSizer::RecalcSizes}\label{wxgridbagsizerrecalcsizes}
 
 \func{void}{RecalcSizes}{\void}
 \membersection{wxGridBagSizer::RecalcSizes}\label{wxgridbagsizerrecalcsizes}
 
 \func{void}{RecalcSizes}{\void}


@@ -142,15 +130,12 @@ Get the row/col spanning of the specified item
 Called when the managed size of the sizer is needed or when layout
 needs done.
 
 Called when the managed size of the sizer is needed or when layout
 needs done.
 

-

 \membersection{wxGridBagSizer::SetEmptyCellSize}\label{wxgridbagsizersetemptycellsize}
 
 \func{void}{SetEmptyCellSize}{\param{const wxSize\& }{sz}}
 
 Set the size used for cells in the grid with no item.
 
 \membersection{wxGridBagSizer::SetEmptyCellSize}\label{wxgridbagsizersetemptycellsize}
 
 \func{void}{SetEmptyCellSize}{\param{const wxSize\& }{sz}}
 
 Set the size used for cells in the grid with no item.
 

-
-

 \membersection{wxGridBagSizer::SetItemPosition}\label{wxgridbagsizersetitemposition}
 
 \func{bool}{SetItemPosition}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}}
 \membersection{wxGridBagSizer::SetItemPosition}\label{wxgridbagsizersetitemposition}
 
 \func{bool}{SetItemPosition}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}}


@@ -159,11 +144,9 @@ Set the size used for cells in the grid with no item.
 
 \func{bool}{SetItemPosition}{\param{size\_t }{index}, \param{const wxGBPosition\& }{pos}}
 
 
 \func{bool}{SetItemPosition}{\param{size\_t }{index}, \param{const wxGBPosition\& }{pos}}
 

-Set the grid position of the specified item.  Returns true on success.
+Set the grid position of the specified item. Returns true on success.

 If the move is not allowed (because an item is already there) then
 If the move is not allowed (because an item is already there) then

-false is returned.  
-
-
+false is returned. 

 
 \membersection{wxGridBagSizer::SetItemSpan}\label{wxgridbagsizersetitemspan}
 
 
 \membersection{wxGridBagSizer::SetItemSpan}\label{wxgridbagsizersetitemspan}
 


@@ -174,8 +157,6 @@ false is returned.
 \func{bool}{SetItemSpan}{\param{size\_t }{index}, \param{const wxGBSpan\& }{span}}
 
 Set the row/col spanning of the specified item. Returns true on
 \func{bool}{SetItemSpan}{\param{size\_t }{index}, \param{const wxGBSpan\& }{span}}
 
 Set the row/col spanning of the specified item. Returns true on

-success.  If the move is not allowed (because an item is already there)
+success. If the move is not allowed (because an item is already there)

 then false is returned.
 
 then false is returned.
 

-
-