X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/420455b510fc71f73d1ddfc02dbaf0dfcc8bce1c..9bf6a1b80cb856903e15387ebecc926142e73010:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index eab626d510..d19f545197 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -41,6 +41,10 @@ changes the behaviour of the latter. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} The following styles can apply to all windows, although they will not always make sense for a particular @@ -48,13 +52,16 @@ window class or on all platforms. \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name +\twocolitem{\windowstyle{wxBORDER\_DEFAULT}}{The window class will decide the kind of border to show, if any.} +\twocolitem{\windowstyle{wxBORDER\_SIMPLE}}{Displays a thin border around the window. wxSIMPLE\_BORDER is the old name for this style. } -\twocolitem{\windowstyle{wxDOUBLE\_BORDER}}{Displays a double border. Windows and Mac only.} -\twocolitem{\windowstyle{wxSUNKEN\_BORDER}}{Displays a sunken border.} -\twocolitem{\windowstyle{wxRAISED\_BORDER}}{Displays a raised border.} -\twocolitem{\windowstyle{wxSTATIC\_BORDER}}{Displays a border suitable for a static control. Windows only. } -\twocolitem{\windowstyle{wxNO\_BORDER}}{Displays no border, overriding the default border style for the window.} +\twocolitem{\windowstyle{wxBORDER\_SUNKEN}}{Displays a sunken border. wxSUNKEN\_BORDER is the old name for this style.} +\twocolitem{\windowstyle{wxBORDER\_RAISED}}{Displays a raised border. wxRAISED\_BORDER is the old name for this style. } +\twocolitem{\windowstyle{wxBORDER\_STATIC}}{Displays a border suitable for a static control. wxSTATIC\_BORDER is the old name for this style. Windows only. } +\twocolitem{\windowstyle{wxBORDER\_THEME}}{Displays a native border suitable for a control, on the current platform. On Windows XP or Vista, this will be a themed border; on most other platforms +a sunken border will be used. For more information for themed borders on Windows, please see \helpref{Themed borders on Windows}{wxmswthemedborders}.} +\twocolitem{\windowstyle{wxBORDER\_NONE}}{Displays no border, overriding the default border style for the window. wxNO\_BORDER is the old name for this style.} +\twocolitem{\windowstyle{wxBORDER\_DOUBLE}}{This style is obsolete and should not be used.} \twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint events. Windows only.} \twocolitem{\windowstyle{wxTAB\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.} @@ -1154,6 +1161,33 @@ name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetnam Returns the parent of the window, or NULL if there is no parent. +\membersection{wxWindow::GetPopupMenuSelectionFromUser}\label{wxwindowgetpopupmenuselectionfromuser} + +\func{int}{GetPopupMenuSelectionFromUser}{\param{wxMenu\&}{ menu}, \param{const wxPoint\&}{ pos}} + +\func{int}{GetPopupMenuSelectionFromUser}{\param{wxMenu\&}{ menu}, \param{int}{ x}, \param{int}{ y}} + +This function shows a popup menu at the given position in this window and +returns the selected id. It can be more convenient than the general purpose +\helpref{PopupMenu}{wxwindowpopupmenu} function for simple menus proposing a +choice in a list of strings to the user. + +\wxheading{Parameters} + +\docparam{menu}{The menu to show} + +\docparam{pos}{The position at which to show the menu in client coordinates} + +\docparam{x}{The horizontal position of the menu} + +\docparam{y}{The vertical position of the menu} + +\wxheading{Return value} + +The selected menu item id or \texttt{wxID\_NONE} if none selected or an error +occurred. + + \membersection{wxWindow::GetPosition}\label{wxwindowgetposition} \constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}} @@ -1804,7 +1838,7 @@ changed. You may wish to call this from a text control custom keypress handler to do the default navigation behaviour for the tab key, since the standard default behaviour for a multiline text control with the wxTE\_PROCESS\_TAB style is to insert a tab -and not navigate to the next control. +and not navigate to the next control. See also \helpref{wxNavigationKeyEvent}{wxnavigationkeyevent}. \membersection{wxWindow::NavigateIn}\label{wxwindownavigatein} @@ -2774,26 +2808,23 @@ background, such as a tiled bitmap. Currently the style has no effect on other p \helpref{wxWindow::GetBackgroundStyle}{wxwindowgetbackgroundstyle} -\membersection{wxWindow::SetInitialSize}\label{wxwindowsetinitialsize} -\func{void}{SetInitialSize}{\param{const wxSize\& }{size = wxDefaultSize}} +\membersection{wxWindow::SetCanFocus}\label{wxwindowsetcanfocus} -A {\it smart} SetSize that will fill in default size components with the -window's {\it best} size values. Also sets the window's minsize to -the value passed in for use with sizers. This means that if a full or -partial size is passed to this function then the sizers will use that -size instead of the results of GetBestSize to determine the minimum -needs of the window for layout. - -Most controls will use this to set their initial size, and their min -size to the passed in value (if any.) +\func{virtual void}{SetCanFocus}{\param{bool}{ canFocus}} +This method is only implemented by ports which have support for +native TAB traversal (such as GTK+ 2.0). It is called by wxWidgets' +container control code to give the native system a hint when +doing TAB traversal. A call to this does not disable or change +the effect of programmatically calling +\helpref{wxWindow::SetFocus}{wxwindowsetfocus}. \wxheading{See also} -\helpref{wxWindow::SetSize}{wxwindowsetsize},\rtfsp -\helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp -\helpref{wxWindow::GetEffectiveMinSize}{wxwindowgeteffectiveminsize} +\helpref{wxFocusEvent}{wxfocusevent} +\helpref{wxPanel::SetFocus}{wxpanelsetfocus} +\helpref{wxPanel::SetFocusIgnoringChildren}{wxpanelsetfocusignoringchildren} \membersection{wxWindow::SetCaret}\label{wxwindowsetcaret} @@ -2897,13 +2928,6 @@ If the window already has a drop target, it is deleted. -\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::SetEventHandler}\label{wxwindowseteventhandler} \func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}} @@ -2922,9 +2946,9 @@ an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. -It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} since -this sets up a chain of event handlers, where an event not handled by one event handler is -handed to the next one in the chain. +It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} +since this sets up a chain of event handlers, where an event not handled by +one event handler is handed to the next one in the chain. \wxheading{See also} @@ -3092,6 +3116,36 @@ on creation and should not be modified subsequently. +\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::SetInitialSize}\label{wxwindowsetinitialsize} + +\func{void}{SetInitialSize}{\param{const wxSize\& }{size = wxDefaultSize}} + +A {\it smart} SetSize that will fill in default size components with the +window's {\it best} size values. Also sets the window's minsize to +the value passed in for use with sizers. This means that if a full or +partial size is passed to this function then the sizers will use that +size instead of the results of GetBestSize to determine the minimum +needs of the window for layout. + +Most controls will use this to set their initial size, and their min +size to the passed in value (if any.) + + +\wxheading{See also} + +\helpref{wxWindow::SetSize}{wxwindowsetsize},\rtfsp +\helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp +\helpref{wxWindow::GetEffectiveMinSize}{wxwindowgeteffectiveminsize} + + \membersection{wxWindow::SetLabel}\label{wxwindowsetlabel} \func{virtual void}{SetLabel}{\param{const wxString\& }{label}}