Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Spacing corrections

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/latex/wx/gbposition.tex
View File

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

28
docs/latex/wx/gbsizeritem.tex
View File

@@ -1,16 +1,15 @@
\section{\class{wxGBSizerItem}}\label{wxgbsizeritem}
The wxGBSizerItem class is used by the
The wxGBSizerItem class is used by the
\helpref{wxGridBagSizer}{wxgridbagsizer} for tracking the items in the
sizer. It adds grid position and spanning information to the normal
sizer. It adds grid position and spanning information to the normal
\helpref{wxSizerItem}{wxsizeritem} by adding
\helpref{wxGBPosition}{wxgbposition} and \helpref{wxGBSpan}{wxgbspan}
attrbibutes. Most of the time you will not need to use a
attrbibutes. Most of the time you will not need to use a
wxGBSizerItem directly in your code, but there are a couple of cases
where it is handy.
\wxheading{Derived from}
\helpref{wxSizerItem}{wxsizeritem}
@@ -19,37 +18,28 @@ where it is handy.
<wx/gbsizer.h>
\latexignore{\rtfignore{\wxheading{Members}}}
\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}}
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}}
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}}
Construct a sizer item for tracking a subsizer.
\membersection{wxGBSizerItem::GetEndPos}\label{wxgbsizeritemgetendpos}
\func{void}{GetEndPos}{\param{int\& }{row}, \param{int\& }{col}}
Get the row and column of the endpoint of this item
\membersection{wxGBSizerItem::GetPos}\label{wxgbsizeritemgetpos}
\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.
\membersection{wxGBSizerItem::GetSpan}\label{wxgbsizeritemgetspan}
\constfunc{wxGBSpan}{GetSpan}{\void}
@@ -68,35 +56,31 @@ Get the grid position of the item.
Get the row and column spanning of the item.
\membersection{wxGBSizerItem::Intersects}\label{wxgbsizeritemintersects}
\func{bool}{Intersects}{\param{const wxGBSizerItem\& }{other}}
Returns true if this item and the other item instersect
\func{bool}{Intersects}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}}
Returns true if the given pos/span would intersect with this item.
\membersection{wxGBSizerItem::SetPos}\label{wxgbsizeritemsetpos}
\func{bool}{SetPos}{\param{const wxGBPosition\& }{pos}}
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 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.
\membersection{wxGBSizerItem::SetSpan}\label{wxgbsizeritemsetspan}
\func{bool}{SetSpan}{\param{const wxGBSpan\& }{span}}
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
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.

8
docs/latex/wx/gbspan.tex
View File

@@ -14,7 +14,6 @@ No base class
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxGBSpan::wxGBSpan}\label{wxgbspanwxgbspan}
\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
each direction.
\membersection{wxGBSpan::GetColspan}\label{wxgbspangetcolspan}
\constfunc{int}{GetColspan}{\void}
Get the current colspan value.
\membersection{wxGBSpan::GetRowspan}\label{wxgbspangetrowspan}
\constfunc{int}{GetRowspan}{\void}
Get the current rowspan value.
\membersection{wxGBSpan::SetColspan}\label{wxgbspansetcolspan}
\func{void}{SetColspan}{\param{int }{colspan}}
Set a new colspan value.
\membersection{wxGBSpan::SetRowspan}\label{wxgbspansetrowspan}
\func{void}{SetRowspan}{\param{int }{rowspan}}
Set a new rowspan value.
\membersection{wxGBSpan::operator!}\label{wxgbspanoperatorunknown}
\constfunc{bool}{operator!}{\param{const wxGBSpan\& }{o}}
Is the wxGBSpan valid? (An invalid wxGBPosition is (-1,-1). )
\membersection{wxGBSpan::operator==}\label{wxgbspanoperatorequal}
\constfunc{bool operator}{operator==}{\param{const wxGBSpan\& }{o}}
Compare equality of two wxGBSpans.

46
docs/latex/wx/gridbagsizer.tex
View File

@@ -3,11 +3,10 @@
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}.
\wxheading{Derived from}
\helpref{wxFlexGridSizer}{wxflexgridsizer}\\
@@ -15,15 +14,12 @@ more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}.
\helpref{wxSizer}{wxsizer}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/gbsizer.h>
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxGridBagSizer::wxGridBagSizer}\label{wxgridbagsizerwxgridbagsizer}
\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
rows and columns.
\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}}
@@ -45,9 +40,6 @@ rows and columns.
The Add methods return true if the item was successfully placed at the
given position, false if something was already there.
\membersection{wxGridBagSizer::CalcMin}\label{wxgridbagsizercalcmin}
\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
needs done.
\membersection{wxGridBagSizer::CheckForIntersection}\label{wxgridbagsizercheckforintersection}
\func{bool}{CheckForIntersection}{\param{wxGBSizerItem* }{item}, \param{wxGBSizerItem* }{excludeItem = NULL}}
@@ -63,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
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.
\membersection{wxGridBagSizer::FindItem}\label{wxgridbagsizerfinditem}
\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
not found. (non-recursive)
\membersection{wxGridBagSizer::FindItemAtPoint}\label{wxgridbagsizerfinditematpoint}
\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
layout. (non-recursive)
\membersection{wxGridBagSizer::FindItemAtPosition}\label{wxgridbagsizerfinditematposition}
\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
item at that position. (non-recursive)
\membersection{wxGridBagSizer::FindItemWithData}\label{wxgridbagsizerfinditemwithdata}
\func{wxGBSizerItem*}{FindItemWithData}{\param{const wxObject* }{userData}}
@@ -107,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)
\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.
\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}}
@@ -136,8 +113,6 @@ Get the size used for cells in the grid with no item.
Get the grid position of the specified item.
\membersection{wxGridBagSizer::GetItemSpan}\label{wxgridbagsizergetitemspan}
\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
\membersection{wxGridBagSizer::RecalcSizes}\label{wxgridbagsizerrecalcsizes}
\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
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::SetItemPosition}\label{wxgridbagsizersetitemposition}
\func{bool}{SetItemPosition}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}}
@@ -174,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}}
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
false is returned.
false is returned.
\membersection{wxGridBagSizer::SetItemSpan}\label{wxgridbagsizersetitemspan}
@@ -189,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
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.

19
docs/latex/wx/sound.tex
View File

@@ -2,8 +2,8 @@
This class represents a short sound (loaded from Windows WAV file), that
can be stored in memory and played. Currently this class is implemented
on Windows and Unix (and uses either
\urlref{Open Sound System}{http://www.opensound.com/oss.html} or
on Windows and Unix (and uses either
\urlref{Open Sound System}{http://www.opensound.com/oss.html} or
\urlref{Simple DirectMedia Layer}{http://www.libsdl.org/}).
\wxheading{Derived from}
@@ -79,13 +79,13 @@ Returns \true on success, \false otherwise.
The possible values for \arg{flags} are:
\begin{twocollist}
\twocolitem{wxSOUND\_SYNC}{{\tt Play} will block and wait until the sound is
replayed.}
\twocolitem{wxSOUND\_ASYNC}{Sound is played asynchronously,
{\tt Play} returns immediately}
\twocolitem{wxSOUND\_ASYNC | wxSOUND\_LOOP}{Sound is played asynchronously
and loops until another sound is played,
\helpref{wxSound::Stop}{wxsoundstop} is called or the program terminates.}
\twocolitem{wxSOUND\_SYNC}{{\tt Play} will block and wait until the sound is
replayed.}
\twocolitem{wxSOUND\_ASYNC}{Sound is played asynchronously,
{\tt Play} returns immediately}
\twocolitem{wxSOUND\_ASYNC | wxSOUND\_LOOP}{Sound is played asynchronously
and loops until another sound is played,
\helpref{wxSound::Stop}{wxsoundstop} is called or the program terminates.}
\end{twocollist}
The static form is shorthand for this code:
@@ -98,3 +98,4 @@ wxSound(filename).Play(flags);
\func{static void}{Stop}{\void}
If a sound is played, this function stops it.