]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/accel.h
Add a link to Microsoft guidelines from wxICON_QUESTION documentation.
[wxWidgets.git] / interface / wx / accel.h
index 616f2b047aa059efe87568922971848667c63601..22002f33ecc222665693bbe23d5c1eb15975a059 100644 (file)
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxAccelerator* classes
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
@@ -29,13 +29,12 @@ enum wxAcceleratorEntryFlags
 
 /**
     @class wxAcceleratorEntry
-    @wxheader{accel.h}
 
     An object used by an application wishing to create an accelerator table
     (see wxAcceleratorTable).
 
     @library{wxcore}
-    @category{misc}
+    @category{data}
 
     @see wxAcceleratorTable, wxWindow::SetAcceleratorTable
 */
@@ -46,10 +45,10 @@ public:
         Constructor.
 
         @param flags
-            A combination of the wxAcceleratorEntryFlags values, which
+            A combination of the ::wxAcceleratorEntryFlags values, which
             indicates which modifier keys are held down.
         @param keyCode
-            The keycode to be detected. See @ref page_keycodes for a full list of keycodes.
+            The keycode to be detected. See ::wxKeyCode for a full list of keycodes.
         @param cmd
             The menu or control command identifier (ID).
         @param item
@@ -87,10 +86,10 @@ public:
         Sets the accelerator entry parameters.
 
         @param flags
-            A combination of the wxAcceleratorEntryFlags values, which
+            A combination of the ::wxAcceleratorEntryFlags values, which
             indicates which modifier keys are held down.
         @param keyCode
-            The keycode to be detected. See @ref page_keycodes for a full list of keycodes.
+            The keycode to be detected. See ::wxKeyCode for a full list of keycodes.
         @param cmd
             The menu or control command identifier (ID).
         @param item
@@ -105,6 +104,7 @@ public:
 
     /**
         Returns a wxString for this accelerator.
+
         This function formats it using the @c "flags-keycode" format
         where @c flags maybe a hyphen-separed list of @c "shift|alt|ctrl".
     */
@@ -130,7 +130,6 @@ public:
 
 /**
     @class wxAcceleratorTable
-    @wxheader{accel.h}
 
     An accelerator table allows the application to specify a table of keyboard
     shortcuts for menu or button commands.
@@ -158,7 +157,7 @@ public:
     'OK'.
 
     @library{wxcore}
-    @category{misc}
+    @category{data}
 
     @stdobjects
     ::wxNullAcceleratorTable
@@ -180,6 +179,13 @@ public:
             Number of accelerator entries.
         @param entries
             The array of entries.
+
+        @beginWxPerlOnly
+        The wxPerl constructor accepts a list of either
+        Wx::AcceleratorEntry objects or references to 3-element arrays
+        [flags, keyCode, cmd] , like the parameters of
+        Wx::AcceleratorEntry::new.
+        @endWxPerlOnly
     */
     wxAcceleratorTable(int n, const wxAcceleratorEntry entries[]);