added wxRadioBox::IsItemEnabled/Shown() (for MSW only for now, other platforms to...

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index e61faddd2aaa7a7b7f713a7180c8723cf1199856..e81083f2aa5a0ac4131d9c0c2f66d20c07ba40d5 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -3,7 +3,7 @@
 %% Purpose:     wxWindow documentation
 %% Author:      wxWidgets Team
 %% Modified by:
 %% Purpose:     wxWindow documentation
 %% Author:      wxWidgets Team
 %% Modified by:

-%% Created:     
+%% Created:

 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets Team
 %% License:     wxWindows license
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets Team
 %% License:     wxWindows license


@@ -138,13 +138,13 @@ Constructs a window, which can be a child of a frame, dialog or any other non-co
 
 \docparam{parent}{Pointer to a parent window.}
 
 
 \docparam{parent}{Pointer to a parent window.}
 

-\docparam{id}{Window identifier. If -1, will automatically create an identifier.}
+\docparam{id}{Window identifier. If wxID\_ANY, will automatically create an identifier.}

 
 

-\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWidgets
+\docparam{pos}{Window position. wxDefaultPosition indicates that wxWidgets

 should generate a default position for the window. If using the wxWindow class directly, supply
 an actual position.}
 
 should generate a default position for the window. If using the wxWindow class directly, supply
 an actual position.}
 

-\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets
+\docparam{size}{Window size. wxDefaultSize indicates that wxWidgets

 should generate a default size for the window. If no suitable size can  be found, the
 window will be sized to 20x20 pixels so that the window is visible but obviously not
 correctly sized. }
 should generate a default size for the window. If no suitable size can  be found, the
 window will be sized to 20x20 pixels so that the window is visible but obviously not
 correctly sized. }


@@ -1031,7 +1031,7 @@ Returns the identifier of the window.
 \wxheading{Remarks}
 
 Each window has an integer identifier. If the application has not provided one
 \wxheading{Remarks}
 
 Each window has an integer identifier. If the application has not provided one

-(or the default Id -1) an unique identifier with a negative value will be generated.
+(or the default wxID\_ANY) an unique identifier with a negative value will be generated.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -1250,17 +1250,6 @@ implements the following methods:\par
  {\tt ( x, y, descent, externalLeading )}.}
 
 
  {\tt ( x, y, descent, externalLeading )}.}
 
 

-\membersection{wxWindow::GetTitle}\label{wxwindowgettitle}
-
-\func{virtual wxString}{GetTitle}{\void}
-
-Gets the window's title. Applicable only to frames and dialogs.
-
-\wxheading{See also}
-
-\helpref{wxWindow::SetTitle}{wxwindowsettitle}
-
-

 \membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
 
 \constfunc{wxToolTip*}{GetToolTip}{\void}
 \membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
 
 \constfunc{wxToolTip*}{GetToolTip}{\void}


@@ -1338,6 +1327,13 @@ Returns {\tt true} if this window has the current mouse capture.
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 

+\membersection{wxWindow::HasFlag}\label{wxwindowhasflag}
+
+\constfunc{bool}{HasFlag}{\param{int }{flag}}
+
+Returns \texttt{true} if the window has the given \arg{flag} bit set.
+
+

 \membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar}
 
 \constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}}
 \membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar}
 
 \constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}}


@@ -1541,7 +1537,7 @@ wxWindow::Move function, which is defined in the base wxWindow class
 as the call:
 
 \begin{verbatim}
 as the call:
 
 \begin{verbatim}

-  SetSize(x, y, -1, -1, wxSIZE_USE_EXISTING);
+  SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING);

 \end{verbatim}
 
 \wxheading{See also}
 \end{verbatim}
 
 \wxheading{See also}


@@ -1826,28 +1822,6 @@ and not navigate to the next control.
 %%
 %% \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}
 %%
 %%
 %% \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}
 %%

-%% \membersection{wxWindow::OnMenuCommand}\label{wxwindowonmenucommand}
-%%
-%% \func{void}{OnMenuCommand}{\param{wxCommandEvent\& }{event}}
-%%
-%% Called when a menu command is received from a menu bar.
-%%
-%% \wxheading{Parameters}
-%%
-%% \docparam{event}{The menu command event. For more information, see \helpref{wxCommandEvent}{wxcommandevent}.}
-%%
-%% \wxheading{Remarks}
-%%
-%% A function with this name doesn't actually exist; you can choose any member function to receive
-%% menu command events, using the EVT\_COMMAND macro for individual commands or EVT\_COMMAND\_RANGE for
-%% a range of commands.
-%%
-%% \wxheading{See also}
-%%
-%% \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
-%% \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight},\rtfsp
-%% \helpref{Event handling overview}{eventhandlingoverview}
-%%

 %% \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight}
 %%
 %% \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}}
 %% \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight}
 %%
 %% \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}}


@@ -1875,7 +1849,6 @@ and not navigate to the next control.
 %% \wxheading{See also}
 %%
 %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp
 %% \wxheading{See also}
 %%
 %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp

-%% \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand},\rtfsp

 %% \helpref{Event handling overview}{eventhandlingoverview}
 %%
 %%
 %% \helpref{Event handling overview}{eventhandlingoverview}
 %%
 %%


@@ -2236,7 +2209,7 @@ In current version of wxWidgets this works both for manage and child windows.
 Causes this window, and all of its children recursively (except under wxGTK1
 where this is not implemented), to be repainted. Note that repainting doesn't
 happen immediately but only during the next event loop iteration, if you need
 Causes this window, and all of its children recursively (except under wxGTK1
 where this is not implemented), to be repainted. Note that repainting doesn't
 happen immediately but only during the next event loop iteration, if you need

-to update the window immediately you should use \helpref{Update}{wxwindowupdate} 
+to update the window immediately you should use \helpref{Update}{wxwindowupdate}

 instead.
 
 \wxheading{Parameters}
 instead.
 
 \wxheading{Parameters}


@@ -2454,7 +2427,7 @@ parameter)}
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Note that you can often use \helpref{wxScrolledWindow}{wxscrolledwindow} 
+Note that you can often use \helpref{wxScrolledWindow}{wxscrolledwindow}

 instead of using this function directly.
 
 
 instead of using this function directly.
 
 


@@ -3123,16 +3096,16 @@ Sets the size of the window in pixels.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{x}{Required x position in pixels, or -1 to indicate that the existing
+\docparam{x}{Required x position in pixels, or wxDefaultCoord to indicate that the existing

 value should be used.}
 
 value should be used.}
 

-\docparam{y}{Required y position in pixels, or -1 to indicate that the existing
+\docparam{y}{Required y position in pixels, or wxDefaultCoord to indicate that the existing

 value should be used.}
 
 value should be used.}
 

-\docparam{width}{Required width in pixels, or -1 to indicate that the existing
+\docparam{width}{Required width in pixels, or wxDefaultCoord to indicate that the existing

 value should be used.}
 
 value should be used.}
 

-\docparam{height}{Required height position in pixels, or -1 to indicate that the existing
+\docparam{height}{Required height position in pixels, or wxDefaultCoord to indicate that the existing

 value should be used.}
 
 \docparam{size}{\helpref{wxSize}{wxsize} object for setting the size.}
 value should be used.}
 
 \docparam{size}{\helpref{wxSize}{wxsize} object for setting the size.}


@@ -3141,15 +3114,15 @@ value should be used.}
 
 \docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following:
 
 
 \docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following:
 

-{\bf wxSIZE\_AUTO\_WIDTH}: a $-1$ width value is taken to indicate
+{\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate

 a wxWidgets-supplied default width.\\
 a wxWidgets-supplied default width.\\

-{\bf wxSIZE\_AUTO\_HEIGHT}: a $-1$ height value is taken to indicate
+{\bf wxSIZE\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate

 a wxWidgets-supplied default width.\\
 a wxWidgets-supplied default width.\\

-{\bf wxSIZE\_AUTO}: -1 size values are taken to indicate
+{\bf wxSIZE\_AUTO}: $wxDefaultCoord$ size values are taken to indicate

 a wxWidgets-supplied default size.\\
 {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used
 a wxWidgets-supplied default size.\\
 {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used

-if -1 values are supplied.\\
-{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow dimensions of $-1$ and less to be interpreted
+if $wxDefaultCoord$ values are supplied.\\
+{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow negative dimensions (ie. value of $wxDefaultCoord$) to be interpreted

 as real dimensions, not default values.
 {\bf wxSIZE\_FORCE}: normally, if the position and the size of the window are
 already the same as the parameters of this function, nothing is done. but with
 as real dimensions, not default values.
 {\bf wxSIZE\_FORCE}: normally, if the position and the size of the window are
 already the same as the parameters of this function, nothing is done. but with


@@ -3163,7 +3136,7 @@ The second form is a convenience for calling the first form with default
 x and y parameters, and must be used with non-default width and height values.
 
 The first form sets the position and optionally size, of the window.
 x and y parameters, and must be used with non-default width and height values.
 
 The first form sets the position and optionally size, of the window.

-Parameters may be -1 to indicate either that a default should be supplied
+Parameters may be $wxDefaultCoord$ to indicate either that a default should be supplied

 by wxWidgets, or that the current value of the dimension should be used.
 
 \wxheading{See also}
 by wxWidgets, or that the current value of the dimension should be used.
 
 \wxheading{See also}


@@ -3275,21 +3248,6 @@ Dialogs, notebook pages and the status bar have this flag set to true
 by default so that the default look and feel is simulated best.
 
 
 by default so that the default look and feel is simulated best.
 
 

-\membersection{wxWindow::SetTitle}\label{wxwindowsettitle}
-
-\func{virtual void}{SetTitle}{\param{const wxString\& }{title}}
-
-Sets the window's title. Applicable only to frames and dialogs.
-
-\wxheading{Parameters}
-
-\docparam{title}{The window's title.}
-
-\wxheading{See also}
-
-\helpref{wxWindow::GetTitle}{wxwindowgettitle}
-
-

 \membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip}
 
 \func{void}{SetToolTip}{\param{const wxString\& }{tip}}
 \membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip}
 
 \func{void}{SetToolTip}{\param{const wxString\& }{tip}}


@@ -3593,4 +3551,3 @@ Interface Guidelines forbid moving the mouse cursor programmatically.
 \docparam{x}{The new x position for the cursor.}
 
 \docparam{y}{The new y position for the cursor.}
 \docparam{x}{The new x position for the cursor.}
 
 \docparam{y}{The new y position for the cursor.}

-