Applied Patch #1502804: wx*PickerCtrl documentation fixes

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

diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex
index 738f5b2eddbc9f9f4cc773a958d2274ea6cc4b88..b1376b4f21947ff3089f836057882ce1520b9532 100644 (file)
--- a/docs/latex/wx/size.tex
+++ b/docs/latex/wx/size.tex
@@ -3,7 +3,7 @@
 A {\bf wxSize} is a useful data structure for graphics operations.
 It simply contains integer {\it width} and {\it height} members.
 
 A {\bf wxSize} is a useful data structure for graphics operations.
 It simply contains integer {\it width} and {\it height} members.
 

-wxSize is used throughout wxWindows as well as wxPoint which, although almost
+wxSize is used throughout wxWidgets as well as wxPoint which, although almost

 equivalent to wxSize, has a different meaning: wxPoint represents a position
 while wxSize - the size.
 
 equivalent to wxSize, has a different meaning: wxPoint represents a position
 while wxSize - the size.
 


@@ -26,7 +26,8 @@ None
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxSize::wxSize}
+
+\membersection{wxSize::wxSize}\label{wxsizector}

 
 \func{}{wxSize}{\void}
 
 
 \func{}{wxSize}{\void}
 


@@ -35,9 +36,10 @@ None
 Creates a size object.
 
 
 Creates a size object.
 
 

+

 \membersection{wxSize::DecTo}\label{wxsizedecto}
 
 \membersection{wxSize::DecTo}\label{wxsizedecto}
 

-\func{wxSize\&}{DecTo}{\param{const wxSize\& }{size}}
+\func{void}{DecTo}{\param{const wxSize\& }{size}}

 
 Decrements this object so that both of its dimensions are not greater than the
 corresponding dimensions of the \arg{size}.
 
 Decrements this object so that both of its dimensions are not greater than the
 corresponding dimensions of the \arg{size}.


@@ -47,12 +49,25 @@ corresponding dimensions of the \arg{size}.
 \helpref{IncTo}{wxsizeincto}
 
 
 \helpref{IncTo}{wxsizeincto}
 
 

+\membersection{wxSize::IsFullySpecified}\label{wxsizeisfullyspecified}
+
+\constfunc{bool}{IsFullySpecified}{\void}
+
+Returns \true if neither of the size object components is equal to $-1$, which
+is used as default for the size values in wxWidgets (hence the predefined 
+\texttt{wxDefaultSize} has both of its components equal to $-1$).
+
+This method is typically used before calling 
+\helpref{SetDefaults}{wxsizesetdefaults}.
+
+

 \membersection{wxSize::GetWidth}\label{wxsizegetwidth}
 
 \constfunc{int}{GetWidth}{\void}
 
 Gets the width member.
 
 \membersection{wxSize::GetWidth}\label{wxsizegetwidth}
 
 \constfunc{int}{GetWidth}{\void}
 
 Gets the width member.
 

+

 \membersection{wxSize::GetHeight}\label{wxsizegetheight}
 
 \constfunc{int}{GetHeight}{\void}
 \membersection{wxSize::GetHeight}\label{wxsizegetheight}
 
 \constfunc{int}{GetHeight}{\void}


@@ -60,9 +75,10 @@ Gets the width member.
 Gets the height member.
 
 
 Gets the height member.
 
 

+

 \membersection{wxSize::IncTo}\label{wxsizeincto}
 
 \membersection{wxSize::IncTo}\label{wxsizeincto}
 

-\func{wxSize\&}{IncTo}{\param{const wxSize\& }{size}}
+\func{void}{IncTo}{\param{const wxSize\& }{size}}

 
 Increments this object so that both of its dimensions are not less than the
 corresponding dimensions of the \arg{size}.
 
 Increments this object so that both of its dimensions are not less than the
 corresponding dimensions of the \arg{size}.


@@ -72,25 +88,48 @@ corresponding dimensions of the \arg{size}.
 \helpref{DecTo}{wxsizedecto}
 
 
 \helpref{DecTo}{wxsizedecto}
 
 

+

 \membersection{wxSize::Set}\label{wxsizeset}
 
 \func{void}{Set}{\param{int}{ width}, \param{int}{ height}}
 
 Sets the width and height members.
 
 \membersection{wxSize::Set}\label{wxsizeset}
 
 \func{void}{Set}{\param{int}{ width}, \param{int}{ height}}
 
 Sets the width and height members.
 

+
+\membersection{wxSize::SetDefaults}\label{wxsizesetdefaults}
+
+\func{void}{SetDefaults}{\param{const wxSize\& }{sizeDefault}}
+
+Combine this size object with another one replacing the default (i.e. equal
+to $-1$) components of this object with those of the other. It is typically
+used like this:
+\begin{verbatim}
+    if ( !size.IsFullySpecified() )
+    {
+        size.SetDefaults(GetDefaultSize());
+    }
+\end{verbatim}
+
+\wxheading{See also}
+
+\helpref{IsFullySpecified}{wxsizeisfullyspecified}
+
+

 \membersection{wxSize::SetHeight}\label{wxsizesetheight}
 
 \func{void}{SetHeight}{\param{int}{ height}}
 
 Sets the height.
 
 \membersection{wxSize::SetHeight}\label{wxsizesetheight}
 
 \func{void}{SetHeight}{\param{int}{ height}}
 
 Sets the height.
 

+

 \membersection{wxSize::SetWidth}\label{wxsizesetwidth}
 
 \func{void}{SetWidth}{\param{int}{ width}}
 
 Sets the width.
 
 \membersection{wxSize::SetWidth}\label{wxsizesetwidth}
 
 \func{void}{SetWidth}{\param{int}{ width}}
 
 Sets the width.
 

-\membersection{wxSize::operator $=$}
+
+\membersection{wxSize::operator $=$}\label{wxsizeassign}

 
 \func{void}{operator $=$}{\param{const wxSize\& }{sz}}
 
 
 \func{void}{operator $=$}{\param{const wxSize\& }{sz}}