Allow showing the print preview frame non modally.

[wxWidgets.git] / interface / wx / event.h

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 863ee56c239fec34ac919ba251469742095878f7..a3d00229787b10b0d0d026abc754deda3433e30e 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -473,7 +473,7 @@ public:
            that it didn't handle the event in which case the search continues.
         -# Static events table of the handlers bound using event table
            macros is searched for this event handler. If this fails, the base
            that it didn't handle the event in which case the search continues.
         -# Static events table of the handlers bound using event table
            macros is searched for this event handler. If this fails, the base

-           class event table table is tried, and so on until no more tables
+           class event table is tried, and so on until no more tables

            exist or an appropriate function was found. If a handler is found,
            the same logic as in the previous step applies.
         -# The search is applied down the entire chain of event handlers (usually the
            exist or an appropriate function was found. If a handler is found,
            the same logic as in the previous step applies.
         -# The search is applied down the entire chain of event handlers (usually the


@@ -779,7 +779,7 @@ public:
         more flexible as it also allows you to use ordinary functions and
         arbitrary functors as event handlers. It is also less restrictive then
         Connect() because you can use an arbitrary method as an event handler,
         more flexible as it also allows you to use ordinary functions and
         arbitrary functors as event handlers. It is also less restrictive then
         Connect() because you can use an arbitrary method as an event handler,

-        where as Connect() requires a wxEvtHandler derived handler.
+        whereas Connect() requires a wxEvtHandler derived handler.

 
         See @ref overview_events_bind for more detailed explanation
         of this function and the @ref page_samples_event sample for usage
 
         See @ref overview_events_bind for more detailed explanation
         of this function and the @ref page_samples_event sample for usage


@@ -1252,6 +1252,8 @@ enum wxKeyCategoryFlags
     Notice that currently no translation is done for the presses of @c [, @c
     \\, @c ], @c ^ and @c _ keys which might be mapped to ASCII values from 27
     to 31.
     Notice that currently no translation is done for the presses of @c [, @c
     \\, @c ], @c ^ and @c _ keys which might be mapped to ASCII values from 27
     to 31.

+    Since version 2.9.2, the enum values @c WXK_CONTROL_A - @c WXK_CONTROL_Z
+    can be used instead of the non-descriptive constant values 1-26.

 
     Finally, modifier keys only generate key events but no char events at all.
     The modifiers keys are @c WXK_SHIFT, @c WXK_CONTROL, @c WXK_ALT and various
 
     Finally, modifier keys only generate key events but no char events at all.
     The modifiers keys are @c WXK_SHIFT, @c WXK_CONTROL, @c WXK_ALT and various


@@ -1310,8 +1312,11 @@ enum wxKeyCategoryFlags
         keyboard events are generated giving the parent window the opportunity
         to intercept all the keyboard entry. If the event is handled, i.e. the
         handler doesn't call wxEvent::Skip(), no further keyboard events are
         keyboard events are generated giving the parent window the opportunity
         to intercept all the keyboard entry. If the event is handled, i.e. the
         handler doesn't call wxEvent::Skip(), no further keyboard events are

-        generated. Notice that this event is currently not generated by
-        wxOSX/Cocoa port.
+        generated. Notice that this event is not generated when the mouse is
+        captured as it is considered that the window which has the capture
+        should receive all the keyboard events too without allowing its parent
+        wxTopLevelWindow to interfere with their processing. Also please note
+        that currently this event is not generated by wxOSX/Cocoa port.

     @endEventTable
 
     @see wxKeyboardState
     @endEventTable
 
     @see wxKeyboardState


@@ -1698,7 +1703,7 @@ public:
     */
     wxWindowCreateEvent(wxWindow* win = NULL);
 
     */
     wxWindowCreateEvent(wxWindow* win = NULL);
 

-    /// Retutn the window being created.
+    /// Return the window being created.

     wxWindow *GetWindow() const;
 };
 
     wxWindow *GetWindow() const;
 };
 


@@ -2626,7 +2631,7 @@ public:
         For the menu events, this method indicates if the menu item just has become
         checked or unchecked (and thus only makes sense for checkable menu items).
 
         For the menu events, this method indicates if the menu item just has become
         checked or unchecked (and thus only makes sense for checkable menu items).
 

-        Notice that this method can not be used with wxCheckListBox currently.
+        Notice that this method cannot be used with wxCheckListBox currently.

     */
     bool IsChecked() const;
 
     */
     bool IsChecked() const;
 


@@ -2865,7 +2870,7 @@ public:
     child if it loses it now and regains later.
 
     Notice that child window is the direct child of the window receiving event.
     child if it loses it now and regains later.
 
     Notice that child window is the direct child of the window receiving event.

-    Use wxWindow::FindFocus() to retreive the window which is actually getting focus.
+    Use wxWindow::FindFocus() to retrieve the window which is actually getting focus.

 
     @beginEventTable{wxChildFocusEvent}
     @event{EVT_CHILD_FOCUS(func)}
 
     @beginEventTable{wxChildFocusEvent}
     @event{EVT_CHILD_FOCUS(func)}


@@ -2903,11 +2908,11 @@ public:
 /**
     @class wxMouseCaptureLostEvent
 
 /**
     @class wxMouseCaptureLostEvent
 

-    An mouse capture lost event is sent to a window that obtained mouse capture,
-    which was subsequently loss due to "external" event, for example when a dialog
-    box is shown or if another application captures the mouse.
+    A mouse capture lost event is sent to a window that had obtained mouse capture,
+    which was subsequently lost due to an "external" event (for example, when a dialog
+    box is shown or if another application captures the mouse).

 
 

-    If this happens, this event is sent to all windows that are on capture stack
+    If this happens, this event is sent to all windows that are on the capture stack

     (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
     not sent if the capture changes because of a call to CaptureMouse or
     ReleaseMouse.
     (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
     not sent if the capture changes because of a call to CaptureMouse or
     ReleaseMouse.


@@ -3018,7 +3023,7 @@ public:
 /**
     @class wxThreadEvent
 
 /**
     @class wxThreadEvent
 

-    This class adds some simple functionalities to wxCommandEvent coinceived
+    This class adds some simple functionalities to wxCommandEvent conceived

     for inter-threads communications.
 
     This event is not natively emitted by any control/class: this is just
     for inter-threads communications.
 
     This event is not natively emitted by any control/class: this is just


@@ -3446,7 +3451,7 @@ public:
     */
     wxWindowDestroyEvent(wxWindow* win = NULL);
 
     */
     wxWindowDestroyEvent(wxWindow* win = NULL);
 

-    /// Retutn the window being destroyed.
+    /// Return the window being destroyed.

     wxWindow *GetWindow() const;
 };
 
     wxWindow *GetWindow() const;
 };