X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c0ed460c2e7802793d591c84f3cfdbff159c5549..82540ef2327daaf6ae78189139a669afc9edf9d9:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index b5ef3bc1e0..f086ccca6a 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -20,7 +20,7 @@ window class. for this style.} \twocolitem{\windowstyle{wxDOUBLE\_BORDER}}{Displays a double border. Windows only.} \twocolitem{\windowstyle{wxSUNKEN\_BORDER}}{Displays a sunken border.} -\twocolitem{\windowstyle{wxRAISED\_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.} \twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint events. Windows only.} @@ -410,6 +410,17 @@ Returns a pointer to the window's layout constraints, or NULL if there are none. Returns a pointer to the button which is the default for this window, or NULL. +\membersection{wxWindow::GetDropTarget}\label{wxwindowgetdroptarget} + +\constfunc{wxDropTarget*}{GetDropTarget}{\void} + +Returns the associated drop target, which may be NULL. + +\wxheading{See also} + +\helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget}, +\helpref{Drag and drop overview}{wxdndoverview} + \membersection{wxWindow::GetEventHandler}\label{wxwindowgeteventhandler} \constfunc{wxEvtHandler*}{GetEventHandler}{\void} @@ -796,7 +807,7 @@ otherwise it returns FALSE (it is being deactivated). \func{void}{OnChar}{\param{wxKeyEvent\&}{ event}} -Called when the user has pressed a key. +Called when the user has pressed a key, which has been translated into an ASCII value. \wxheading{Parameters} @@ -812,10 +823,15 @@ default function to achieve default keypress functionality. Note that the ASCII values do not have explicit key codes: they are passed as ASCII values. +Note that not all keypresses can be intercepted this way. If you wish to intercept special +keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or +\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}. + Most, but not all, windows allow keypresses to be intercepted. \wxheading{See also} +\helpref{wxWindow::OnKeyDown}{wxwindowonkeydown}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp \helpref{Event handling overview}{eventhandlingoverview} @@ -988,6 +1004,65 @@ To intercept this event, use the EVT\_ERASE\_BACKGROUND macro in an event table \helpref{wxEraseEvent}{wxeraseevent}, \helpref{Event handling overview}{eventhandlingoverview} +\membersection{wxWindow::OnKeyDown}\label{wxwindowonkeydown} + +\func{void}{OnKeyDown}{\param{wxKeyEvent\&}{ event}} + +Called when the user has pressed a key, before it is translated into an ASCII value using other +modifier keys that might be pressed at the same time. + +\wxheading{Parameters} + +\docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for +details about this class.} + +\wxheading{Remarks} + +This member function is called in response to a key down event. To intercept this event, +use the EVT\_KEY\_DOWN macro in an event table definition. Your {\bf OnKeyDown} handler may call this +default function to achieve default keypress functionality. + +Note that not all keypresses can be intercepted this way. If you wish to intercept special +keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or +\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}. + +Most, but not all, windows allow keypresses to be intercepted. + +\wxheading{See also} + +\helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp +\helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp +\helpref{Event handling overview}{eventhandlingoverview} + +\membersection{wxWindow::OnKeyUp}\label{wxwindowonkeyup} + +\func{void}{OnKeyUp}{\param{wxKeyEvent\&}{ event}} + +Called when the user has released a key. + +\wxheading{Parameters} + +\docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for +details about this class.} + +\wxheading{Remarks} + +This member function is called in response to a key up event. To intercept this event, +use the EVT\_KEY\_UP macro in an event table definition. Your {\bf OnKeyUp} handler may call this +default function to achieve default keypress functionality. + +Note that not all keypresses can be intercepted this way. If you wish to intercept special +keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or +\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}. + +Most, but not all, windows allow key up events to be intercepted. + +\wxheading{See also} + +\helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},\rtfsp +\helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp +\helpref{Event handling overview}{eventhandlingoverview} + \membersection{wxWindow::OnKillFocus}\label{wxwindowonkillfocus} \func{void}{OnKillFocus}{\param{wxFocusEvent\& }{event}} @@ -1011,7 +1086,7 @@ Most, but not all, windows respond to this event. \membersection{wxWindow::OnIdle}\label{wxwindowonidle} -\func{void}{Onidle}{\param{wxIdleEvent\& }{event}} +\func{void}{OnIdle}{\param{wxIdleEvent\& }{event}} Provide this member function for any processing which needs to be done when the application is idle. @@ -1217,6 +1292,8 @@ void MyWindow::OnPaint(wxPaintEvent& event) \helpref{wxPaintDC}{wxpaintdc},\rtfsp \helpref{Event handling overview}{eventhandlingoverview} +\membersection{wxWindow::OnScroll}\label{wxwindowonscroll} + \func{void}{OnScroll}{\param{wxScrollEvent\& }{event}} Called when a scroll event is received from one of the window's built-in scrollbars. @@ -1516,6 +1593,19 @@ You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout explicitly. +\membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget} + +\func{void}{SetDropTarget}{\param{wxDropTarget*}{ target}} + +Associates a drop target with this window. + +If the window already has a drop target, it is deleted. + +\wxheading{See also} + +\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget}, +\helpref{Drag and drop overview}{wxdndoverview} + \membersection{wxWindow::SetFocus}\label{wxwindowsetfocus} \func{virtual void}{SetFocus}{\void}