Spacing corrections

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25668 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2004-02-08 22:01:36 +00:00
parent 07b87e8d9b
commit 5a30d45018
5 changed files with 23 additions and 81 deletions

View File

@@ -14,7 +14,6 @@ No base class
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxGBPosition::wxGBPosition}\label{wxgbpositionwxgbposition} \membersection{wxGBPosition::wxGBPosition}\label{wxgbpositionwxgbposition}
\func{}{wxGBPosition}{\void} \func{}{wxGBPosition}{\void}
@@ -24,7 +23,6 @@ No base class
Construct a new wxGBPosition, optionally setting the row and column. Construct a new wxGBPosition, optionally setting the row and column.
The default is (0,0). The default is (0,0).
\membersection{wxGBPosition::GetCol}\label{wxgbpositiongetcol} \membersection{wxGBPosition::GetCol}\label{wxgbpositiongetcol}
\constfunc{int}{GetCol}{\void} \constfunc{int}{GetCol}{\void}
@@ -55,7 +53,6 @@ Set a new row value.
Is the wxGBPosition valid? (An invalid wxGBPosition is (-1,-1). ) Is the wxGBPosition valid? (An invalid wxGBPosition is (-1,-1). )
\membersection{wxGBPosition::operator==}\label{wxgbpositionoperatorequal} \membersection{wxGBPosition::operator==}\label{wxgbpositionoperatorequal}
\constfunc{bool operator}{operator==}{\param{const wxGBPosition\& }{p}} \constfunc{bool operator}{operator==}{\param{const wxGBPosition\& }{p}}

View File

@@ -10,7 +10,6 @@ attrbibutes. Most of the time you will not need to use a
wxGBSizerItem directly in your code, but there are a couple of cases wxGBSizerItem directly in your code, but there are a couple of cases
where it is handy. where it is handy.
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxSizerItem}{wxsizeritem} \helpref{wxSizerItem}{wxsizeritem}
@@ -19,37 +18,28 @@ where it is handy.
<wx/gbsizer.h> <wx/gbsizer.h>
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxGBSizerItem::wxGBSizerItem}\label{wxgbsizeritemwxgbsizeritem} \membersection{wxGBSizerItem::wxGBSizerItem}\label{wxgbsizeritemwxgbsizeritem}
\func{}{wxGBSizerItem}{\param{int }{width}, \param{int }{height}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}} \func{}{wxGBSizerItem}{\param{int }{width}, \param{int }{height}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
Construct a sizer item for tracking a spacer. Construct a sizer item for tracking a spacer.
\func{}{wxGBSizerItem}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}} \func{}{wxGBSizerItem}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
Construct a sizer item for tracking a window. Construct a sizer item for tracking a window.
\func{}{wxGBSizerItem}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}} \func{}{wxGBSizerItem}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
Construct a sizer item for tracking a subsizer. Construct a sizer item for tracking a subsizer.
\membersection{wxGBSizerItem::GetEndPos}\label{wxgbsizeritemgetendpos} \membersection{wxGBSizerItem::GetEndPos}\label{wxgbsizeritemgetendpos}
\func{void}{GetEndPos}{\param{int\& }{row}, \param{int\& }{col}} \func{void}{GetEndPos}{\param{int\& }{row}, \param{int\& }{col}}
Get the row and column of the endpoint of this item Get the row and column of the endpoint of this item
\membersection{wxGBSizerItem::GetPos}\label{wxgbsizeritemgetpos} \membersection{wxGBSizerItem::GetPos}\label{wxgbsizeritemgetpos}
\constfunc{wxGBPosition}{GetPos}{\void} \constfunc{wxGBPosition}{GetPos}{\void}
@@ -58,8 +48,6 @@ Get the row and column of the endpoint of this item
Get the grid position of the item. Get the grid position of the item.
\membersection{wxGBSizerItem::GetSpan}\label{wxgbsizeritemgetspan} \membersection{wxGBSizerItem::GetSpan}\label{wxgbsizeritemgetspan}
\constfunc{wxGBSpan}{GetSpan}{\void} \constfunc{wxGBSpan}{GetSpan}{\void}
@@ -68,20 +56,16 @@ Get the grid position of the item.
Get the row and column spanning of the item. Get the row and column spanning of the item.
\membersection{wxGBSizerItem::Intersects}\label{wxgbsizeritemintersects} \membersection{wxGBSizerItem::Intersects}\label{wxgbsizeritemintersects}
\func{bool}{Intersects}{\param{const wxGBSizerItem\& }{other}} \func{bool}{Intersects}{\param{const wxGBSizerItem\& }{other}}
Returns true if this item and the other item instersect Returns true if this item and the other item instersect
\func{bool}{Intersects}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}} \func{bool}{Intersects}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}}
Returns true if the given pos/span would intersect with this item. Returns true if the given pos/span would intersect with this item.
\membersection{wxGBSizerItem::SetPos}\label{wxgbsizeritemsetpos} \membersection{wxGBSizerItem::SetPos}\label{wxgbsizeritemsetpos}
\func{bool}{SetPos}{\param{const wxGBPosition\& }{pos}} \func{bool}{SetPos}{\param{const wxGBPosition\& }{pos}}
@@ -91,7 +75,6 @@ there is no other item that would intersect with this one at the new
position, then set the new position. Returns true if the change is position, then set the new position. Returns true if the change is
successful and after the next Layout the item will be moved. successful and after the next Layout the item will be moved.
\membersection{wxGBSizerItem::SetSpan}\label{wxgbsizeritemsetspan} \membersection{wxGBSizerItem::SetSpan}\label{wxgbsizeritemsetspan}
\func{bool}{SetSpan}{\param{const wxGBSpan\& }{span}} \func{bool}{SetSpan}{\param{const wxGBSpan\& }{span}}
@@ -100,3 +83,4 @@ If the item is already a member of a sizer then first ensure that
there is no other item that would intersect with this one with its new there is no other item that would intersect with this one with its new
spanning size, then set the new spanning. Returns true if the change spanning size, then set the new spanning. Returns true if the change
is successful and after the next Layout the item will be resized. is successful and after the next Layout the item will be resized.

View File

@@ -14,7 +14,6 @@ No base class
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxGBSpan::wxGBSpan}\label{wxgbspanwxgbspan} \membersection{wxGBSpan::wxGBSpan}\label{wxgbspanwxgbspan}
\func{}{wxGBSpan}{\void} \func{}{wxGBSpan}{\void}
@@ -25,44 +24,39 @@ Construct a new wxGBSpan, optionally setting the rowspan and colspan.
The default is (1,1). (Meaning that the item occupies one cell in The default is (1,1). (Meaning that the item occupies one cell in
each direction. each direction.
\membersection{wxGBSpan::GetColspan}\label{wxgbspangetcolspan} \membersection{wxGBSpan::GetColspan}\label{wxgbspangetcolspan}
\constfunc{int}{GetColspan}{\void} \constfunc{int}{GetColspan}{\void}
Get the current colspan value. Get the current colspan value.
\membersection{wxGBSpan::GetRowspan}\label{wxgbspangetrowspan} \membersection{wxGBSpan::GetRowspan}\label{wxgbspangetrowspan}
\constfunc{int}{GetRowspan}{\void} \constfunc{int}{GetRowspan}{\void}
Get the current rowspan value. Get the current rowspan value.
\membersection{wxGBSpan::SetColspan}\label{wxgbspansetcolspan} \membersection{wxGBSpan::SetColspan}\label{wxgbspansetcolspan}
\func{void}{SetColspan}{\param{int }{colspan}} \func{void}{SetColspan}{\param{int }{colspan}}
Set a new colspan value. Set a new colspan value.
\membersection{wxGBSpan::SetRowspan}\label{wxgbspansetrowspan} \membersection{wxGBSpan::SetRowspan}\label{wxgbspansetrowspan}
\func{void}{SetRowspan}{\param{int }{rowspan}} \func{void}{SetRowspan}{\param{int }{rowspan}}
Set a new rowspan value. Set a new rowspan value.
\membersection{wxGBSpan::operator!}\label{wxgbspanoperatorunknown} \membersection{wxGBSpan::operator!}\label{wxgbspanoperatorunknown}
\constfunc{bool}{operator!}{\param{const wxGBSpan\& }{o}} \constfunc{bool}{operator!}{\param{const wxGBSpan\& }{o}}
Is the wxGBSpan valid? (An invalid wxGBPosition is (-1,-1). ) Is the wxGBSpan valid? (An invalid wxGBPosition is (-1,-1). )
\membersection{wxGBSpan::operator==}\label{wxgbspanoperatorequal} \membersection{wxGBSpan::operator==}\label{wxgbspanoperatorequal}
\constfunc{bool operator}{operator==}{\param{const wxGBSpan\& }{o}} \constfunc{bool operator}{operator==}{\param{const wxGBSpan\& }{o}}
Compare equality of two wxGBSpans. Compare equality of two wxGBSpans.

View File

@@ -7,7 +7,6 @@ explicit positioning of the items is allowed using
\helpref{wxGBPosition}{wxgbposition}, and items can optionally span \helpref{wxGBPosition}{wxgbposition}, and items can optionally span
more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}. more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}.
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxFlexGridSizer}{wxflexgridsizer}\\ \helpref{wxFlexGridSizer}{wxflexgridsizer}\\
@@ -15,15 +14,12 @@ more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}.
\helpref{wxSizer}{wxsizer}\\ \helpref{wxSizer}{wxsizer}\\
\helpref{wxObject}{wxobject} \helpref{wxObject}{wxobject}
\wxheading{Include files} \wxheading{Include files}
<wx/gbsizer.h> <wx/gbsizer.h>
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxGridBagSizer::wxGridBagSizer}\label{wxgridbagsizerwxgridbagsizer} \membersection{wxGridBagSizer::wxGridBagSizer}\label{wxgridbagsizerwxgridbagsizer}
\func{}{wxGridBagSizer}{\param{int }{vgap = 0}, \param{int }{hgap = 0}} \func{}{wxGridBagSizer}{\param{int }{vgap = 0}, \param{int }{hgap = 0}}
@@ -31,7 +27,6 @@ more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}.
Constructor, with optional parameters to specify the gap between the Constructor, with optional parameters to specify the gap between the
rows and columns. 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{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}}
@@ -45,9 +40,6 @@ rows and columns.
The Add methods return true if the item was successfully placed at the The Add methods return true if the item was successfully placed at the
given position, false if something was already there. given position, false if something was already there.
\membersection{wxGridBagSizer::CalcMin}\label{wxgridbagsizercalcmin} \membersection{wxGridBagSizer::CalcMin}\label{wxgridbagsizercalcmin}
\func{wxSize}{CalcMin}{\void} \func{wxSize}{CalcMin}{\void}
@@ -55,7 +47,6 @@ given position, false if something was already there.
Called when the managed size of the sizer is needed or when layout Called when the managed size of the sizer is needed or when layout
needs done. needs done.
\membersection{wxGridBagSizer::CheckForIntersection}\label{wxgridbagsizercheckforintersection} \membersection{wxGridBagSizer::CheckForIntersection}\label{wxgridbagsizercheckforintersection}
\func{bool}{CheckForIntersection}{\param{wxGBSizerItem* }{item}, \param{wxGBSizerItem* }{excludeItem = NULL}} \func{bool}{CheckForIntersection}{\param{wxGBSizerItem* }{item}, \param{wxGBSizerItem* }{excludeItem = NULL}}
@@ -67,8 +58,6 @@ 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 excludeItem is given then it will not be checked for intersection, for
example it may be the item we are checking the position of. example it may be the item we are checking the position of.
\membersection{wxGridBagSizer::FindItem}\label{wxgridbagsizerfinditem} \membersection{wxGridBagSizer::FindItem}\label{wxgridbagsizerfinditem}
\func{wxGBSizerItem*}{FindItem}{\param{wxWindow* }{window}} \func{wxGBSizerItem*}{FindItem}{\param{wxWindow* }{window}}
@@ -78,8 +67,6 @@ 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 Find the sizer item for the given window or subsizer, returns NULL if
not found. (non-recursive) not found. (non-recursive)
\membersection{wxGridBagSizer::FindItemAtPoint}\label{wxgridbagsizerfinditematpoint} \membersection{wxGridBagSizer::FindItemAtPoint}\label{wxgridbagsizerfinditematpoint}
\func{wxGBSizerItem*}{FindItemAtPoint}{\param{const wxPoint\& }{pt}} \func{wxGBSizerItem*}{FindItemAtPoint}{\param{const wxPoint\& }{pt}}
@@ -89,8 +76,6 @@ 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 to the client coordinates of the window using the sizer for
layout. (non-recursive) layout. (non-recursive)
\membersection{wxGridBagSizer::FindItemAtPosition}\label{wxgridbagsizerfinditematposition} \membersection{wxGridBagSizer::FindItemAtPosition}\label{wxgridbagsizerfinditematposition}
\func{wxGBSizerItem*}{FindItemAtPosition}{\param{const wxGBPosition\& }{pos}} \func{wxGBSizerItem*}{FindItemAtPosition}{\param{const wxGBPosition\& }{pos}}
@@ -98,8 +83,6 @@ layout. (non-recursive)
Return the sizer item for the given grid cell, or NULL if there is no Return the sizer item for the given grid cell, or NULL if there is no
item at that position. (non-recursive) item at that position. (non-recursive)
\membersection{wxGridBagSizer::FindItemWithData}\label{wxgridbagsizerfinditemwithdata} \membersection{wxGridBagSizer::FindItemWithData}\label{wxgridbagsizerfinditemwithdata}
\func{wxGBSizerItem*}{FindItemWithData}{\param{const wxObject* }{userData}} \func{wxGBSizerItem*}{FindItemWithData}{\param{const wxObject* }{userData}}
@@ -107,8 +90,6 @@ item at that position. (non-recursive)
Return the sizer item that has a matching user data (it only compares Return the sizer item that has a matching user data (it only compares
pointer values) or NULL if not found. (non-recursive) pointer values) or NULL if not found. (non-recursive)
\membersection{wxGridBagSizer::GetCellSize}\label{wxgridbagsizergetcellsize} \membersection{wxGridBagSizer::GetCellSize}\label{wxgridbagsizergetcellsize}
\constfunc{wxSize}{GetCellSize}{\param{int }{row}, \param{int }{col}} \constfunc{wxSize}{GetCellSize}{\param{int }{row}, \param{int }{col}}
@@ -116,16 +97,12 @@ pointer values) or NULL if not found. (non-recursive)
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} \membersection{wxGridBagSizer::GetEmptyCellSize}\label{wxgridbagsizergetemptycellsize}
\constfunc{wxSize}{GetEmptyCellSize}{\void} \constfunc{wxSize}{GetEmptyCellSize}{\void}
Get the size used for cells in the grid with no item. Get the size used for cells in the grid with no item.
\membersection{wxGridBagSizer::GetItemPosition}\label{wxgridbagsizergetitemposition} \membersection{wxGridBagSizer::GetItemPosition}\label{wxgridbagsizergetitemposition}
\func{wxGBPosition}{GetItemPosition}{\param{wxWindow* }{window}} \func{wxGBPosition}{GetItemPosition}{\param{wxWindow* }{window}}
@@ -136,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} \membersection{wxGridBagSizer::GetItemSpan}\label{wxgridbagsizergetitemspan}
\func{wxGBSpan}{GetItemSpan}{\param{wxWindow* }{window}} \func{wxGBSpan}{GetItemSpan}{\param{wxWindow* }{window}}
@@ -148,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} \membersection{wxGridBagSizer::RecalcSizes}\label{wxgridbagsizerrecalcsizes}
\func{void}{RecalcSizes}{\void} \func{void}{RecalcSizes}{\void}
@@ -157,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 Called when the managed size of the sizer is needed or when layout
needs done. needs done.
\membersection{wxGridBagSizer::SetEmptyCellSize}\label{wxgridbagsizersetemptycellsize} \membersection{wxGridBagSizer::SetEmptyCellSize}\label{wxgridbagsizersetemptycellsize}
\func{void}{SetEmptyCellSize}{\param{const wxSize\& }{sz}} \func{void}{SetEmptyCellSize}{\param{const wxSize\& }{sz}}
Set the size used for cells in the grid with no item. Set the size used for cells in the grid with no item.
\membersection{wxGridBagSizer::SetItemPosition}\label{wxgridbagsizersetitemposition} \membersection{wxGridBagSizer::SetItemPosition}\label{wxgridbagsizersetitemposition}
\func{bool}{SetItemPosition}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}} \func{bool}{SetItemPosition}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}}
@@ -178,8 +148,6 @@ 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}
\func{bool}{SetItemSpan}{\param{wxWindow* }{window}, \param{const wxGBSpan\& }{span}} \func{bool}{SetItemSpan}{\param{wxWindow* }{window}, \param{const wxGBSpan\& }{span}}
@@ -192,5 +160,3 @@ 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.

View File

@@ -98,3 +98,4 @@ wxSound(filename).Play(flags);
\func{static void}{Stop}{\void} \func{static void}{Stop}{\void}
If a sound is played, this function stops it. If a sound is played, this function stops it.