Missing standard ids

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index 08564bb8ff268938024ff8b1a4b4d55f153f42e8..3edf6e0a2408f1bdc218cab828a5cf288cc229a9 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -173,6 +173,13 @@ called by the user code.
 \docparam{child}{Child window to add.}
 
 
 \docparam{child}{Child window to add.}
 
 

+\membersection{wxWindow::CacheBestSize}\label{wxwindowcachebestsize}
+
+\constfunc{void}{CacheBestSize}{\param{const wxSize\& }{size}}
+
+Sets the cached best size value.
+
+

 \membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse}
 
 \func{virtual void}{CaptureMouse}{\void}
 \membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse}
 
 \func{virtual void}{CaptureMouse}{\void}


@@ -470,6 +477,15 @@ Returns {\tt true} if the window has been disabled, {\tt false} if it had been
 already disabled before the call to this function.
 
 
 already disabled before the call to this function.
 
 

+\membersection{wxWindow::DoGetBestSize}\label{wxwindowdogetbestsize}
+
+\constfunc{virtual wxSize}{DoGetBestSize}{\void}
+
+Gets the size which best suits the window: for a control, it would be
+the minimal size which doesn't truncate the control, for a panel - the
+same size as it would have after a call to \helpref{Fit()}{wxwindowfit}.
+
+

 \membersection{wxWindow::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui}
 
 \func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}}
 \membersection{wxWindow::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui}
 
 \func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}}


@@ -554,11 +570,11 @@ Note that this is a static function, so it can be called without needing a wxWin
 
 \membersection{wxWindow::FindWindow}\label{wxwindowfindwindow}
 
 
 \membersection{wxWindow::FindWindow}\label{wxwindowfindwindow}
 

-\func{wxWindow*}{FindWindow}{\param{long}{ id}}
+\constfunc{wxWindow*}{FindWindow}{\param{long}{ id}}

 
 Find a child of this window, by identifier.
 
 
 Find a child of this window, by identifier.
 

-\func{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}}
+\constfunc{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}}

 
 Find a child of this window, by name.
 
 
 Find a child of this window, by name.
 


@@ -655,8 +671,8 @@ be called to reenable window redrawing. Calls to these two functions may be
 nested.
 
 This method is useful for visual appearance optimization (for example, it
 nested.
 
 This method is useful for visual appearance optimization (for example, it

-is a good idea to use it before inserting large amount of text into a
-wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
+is a good idea to use it before doing many large text insertions in a row into
+a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all

 controls so it is mostly just a hint to wxWidgets and not a mandatory
 directive.
 
 controls so it is mostly just a hint to wxWidgets and not a mandatory
 directive.
 


@@ -1103,17 +1119,6 @@ method:\par
 Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
 
 
 Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
 
 

-\membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
-
-\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
-
-Returns the built-in scrollbar thumb size.
-
-\wxheading{See also}
-
-\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
-
-

 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
 
 \func{virtual int}{GetScrollPos}{\param{int }{orientation}}
 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
 
 \func{virtual int}{GetScrollPos}{\param{int }{orientation}}


@@ -1136,6 +1141,17 @@ Returns the built-in scrollbar range.
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
 
 
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
 
 

+\membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
+
+\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
+
+Returns the built-in scrollbar thumb size.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
+
+

 \membersection{wxWindow::GetSize}\label{wxwindowgetsize}
 
 \constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
 \membersection{wxWindow::GetSize}\label{wxwindowgetsize}
 
 \constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}


@@ -1297,7 +1313,7 @@ Returns the value previous passed to
 
 \constfunc{virtual bool}{HasCapture}{\void}
 
 
 \constfunc{virtual bool}{HasCapture}{\void}
 

-Returns true if this window has the current mouse capture.
+Returns {\tt true} if this window has the current mouse capture.

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


@@ -1306,6 +1322,29 @@ Returns true if this window has the current mouse capture.
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 

+\membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar}
+
+\constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}}
+
+Returns {\tt true} if this window has a scroll bar for this orientation.
+
+\wxheading{Parameters}
+
+\docparam{orient}{Orientation to check, either {\tt wxHORIZONTAL} or {\tt wxVERTICAL}.}
+
+
+\membersection{wxWindow::HasTransparentBackground}\label{wxwindowhastransparentbackground}
+
+\constfunc{virtual bool}{HasTransparentBackground}{\void}
+
+Returns \true if this window background is transparent (as, for example, for
+wxStaticText) and should show the parent window background.
+
+This method is mostly used internally by the library itself and you normally
+shouldn't have to call it. You may, however, have to override it in your
+wxWindow-derived class to ensure that background is painted correctly.
+
+

 \membersection{wxWindow::Hide}\label{wxwindowhide}
 
 \func{bool}{Hide}{\void}
 \membersection{wxWindow::Hide}\label{wxwindowhide}
 
 \func{bool}{Hide}{\void}


@@ -1350,6 +1389,13 @@ Sends an {\tt wxEVT\_INIT\_DIALOG} event, whose handler usually transfers data
 to the dialog via validators.
 
 
 to the dialog via validators.
 
 

+\membersection{wxWindow::InvalidateBestSize}\label{wxwindowinvalidatebestsize}
+
+\func{void}{InvalidateBestSize}{\void}
+
+Resets the cached best size value so it will be recalculated the next time it is needed.
+
+

 \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled}
 
 \constfunc{virtual bool}{IsEnabled}{\void}
 \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled}
 
 \constfunc{virtual bool}{IsEnabled}{\void}


@@ -2182,12 +2228,14 @@ be treated as damaged.}
 
 \membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect}
 
 
 \membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect}
 

-\func{void}{RefreshRect}{\param{const wxRect\& }{rect}}
+\func{void}{RefreshRect}{\param{const wxRect\& }{rect}, \param{bool }{eraseBackground = \true}}

 
 

-Redraws the contents of the given rectangle: the area inside it will be
+Redraws the contents of the given rectangle: only the area inside it will be

 repainted.
 
 repainted.
 

-This is the same as \helpref{Refresh}{wxwindowrefresh} but has a nicer syntax.
+This is the same as \helpref{Refresh}{wxwindowrefresh} but has a nicer syntax
+as it can be called with a temporary wxRect object as argument like this 
+\texttt{RefreshRect(wxRect(x, y, w, h))}.

 
 
 \membersection{wxWindow::RegisterHotKey}\label{wxwindowregisterhotkey}
 
 
 \membersection{wxWindow::RegisterHotKey}\label{wxwindowregisterhotkey}


@@ -2585,6 +2633,13 @@ the constraints automatically in OnSize; otherwise, you must override OnSize and
 explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the
 sizer will have effect.
 
 explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the
 sizer will have effect.
 

+\membersection{wxWindow::SetInitialBestSize}\label{wxwindowsetinitialbestsize}
+
+\func{virtual void}{SetInitialBestSize}{\param{const wxSize\& }{size}}
+
+Sets the initial window size if none is given (i.e. at least one of the
+components of the size passed to ctor/Create() is wxDefaultCoord).
+

 \membersection{wxWindow::SetMaxSize}\label{wxwindowsetmaxsize}
 
 \func{void}{SetMaxSize}{\param{const wxSize\& }{size}}
 \membersection{wxWindow::SetMaxSize}\label{wxwindowsetmaxsize}
 
 \func{void}{SetMaxSize}{\param{const wxSize\& }{size}}


@@ -2616,7 +2671,7 @@ by the children of this window.
 
 \membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont}
 
 
 \membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont}
 

-\func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}}
+\func{void}{SetOwnFont}{\param{const wxFont\& }{font}}

 
 Sets the font of the window but prevents it from being inherited by the
 children of this window.
 
 Sets the font of the window but prevents it from being inherited by the
 children of this window.


@@ -2732,6 +2787,8 @@ This sets the window to receive keyboard input.
 \wxheading{See also}
 
 \helpref{wxFocusEvent}{wxfocusevent}
 \wxheading{See also}
 
 \helpref{wxFocusEvent}{wxfocusevent}

+\helpref{wxPanel::SetFocus}{wxpanelsetfocus}
+\helpref{wxPanel::SetFocusIgnoringChildren}{wxpanelsetfocusignoringchildren}

 
 
 \membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd}
 
 
 \membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd}


@@ -2832,6 +2889,21 @@ on creation and should not be modified subsequently.
 
 
 
 
 
 

+\membersection{wxWindow::SetLabel}\label{wxwindowsetlabel}
+
+\func{virtual void}{SetLabel}{\param{const wxString\& }{label}}
+
+Sets the window's label.
+
+\wxheading{Parameters}
+
+\docparam{label}{The window label.}
+
+\wxheading{See also}
+
+\helpref{wxWindow::GetLabel}{wxwindowgetlabel}
+
+

 \membersection{wxWindow::SetName}\label{wxwindowsetname}
 
 \func{virtual void}{SetName}{\param{const wxString\& }{name}}
 \membersection{wxWindow::SetName}\label{wxwindowsetname}
 
 \func{virtual void}{SetName}{\param{const wxString\& }{name}}


@@ -2940,8 +3012,8 @@ handling of pages and ranges.
 \wxheading{See also}
 
 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
 \wxheading{See also}
 
 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp

-\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
-\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp
+\helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp
+\helpref{wxWindow::GetScrollPage}{wxwindowgetscrollpage},\rtfsp

 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 \end{comment}
 
 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 \end{comment}
 


@@ -2968,7 +3040,7 @@ application to take note of scrollbar attributes and redraw contents accordingly
 \wxheading{See also}
 
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar},\rtfsp
 \wxheading{See also}
 
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar},\rtfsp

-\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
+\helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp

 \helpref{wxWindow::GetScrollThumb}{wxwindowgetscrollthumb},\rtfsp
 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 
 \helpref{wxWindow::GetScrollThumb}{wxwindowgetscrollthumb},\rtfsp
 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 


@@ -3001,8 +3073,8 @@ and usually the scrollbar will be automatically hidden.
 
 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
 \helpref{wxWindow::SetScrollPage}{wxwindowsetscrollpage},\rtfsp
 
 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
 \helpref{wxWindow::SetScrollPage}{wxwindowsetscrollpage},\rtfsp

-\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
-\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp
+\helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp
+\helpref{wxWindow::GetScrollPage}{wxwindowgetscrollpage},\rtfsp

 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 \end{comment}
 
 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 \end{comment}
 


@@ -3471,7 +3543,7 @@ Returns {\tt false} if any of the validations failed.
 \wxheading{See also}
 
 \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
 \wxheading{See also}
 
 \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp

-\helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
+\helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp

 \helpref{wxValidator}{wxvalidator}
 
 
 \helpref{wxValidator}{wxvalidator}