No animate contrib anymore

[wxWidgets.git] / wxPython / src / _accel.i

diff --git a/wxPython/src/_accel.i b/wxPython/src/_accel.i
index 40eade94d61673a6e06d423dea95b9774559dd4d..0cf237d15260eb954032449a89897543d5cbce62 100644 (file)
--- a/wxPython/src/_accel.i
+++ b/wxPython/src/_accel.i
@@ -30,25 +30,33 @@
 //---------------------------------------------------------------------------
 %newgroup;
 
 //---------------------------------------------------------------------------
 %newgroup;
 

+enum {
+    wxACCEL_ALT,
+    wxACCEL_CTRL,
+    wxACCEL_SHIFT,
+    wxACCEL_NORMAL,
+    wxACCEL_CMD,
+};
+

 DocStr(wxAcceleratorEntry,
 "A class used to define items in an `wx.AcceleratorTable`.  wxPython
 programs can choose to use wx.AcceleratorEntry objects, but using a
 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
 as well.  See `__init__` for details of the tuple values.
 
 DocStr(wxAcceleratorEntry,
 "A class used to define items in an `wx.AcceleratorTable`.  wxPython
 programs can choose to use wx.AcceleratorEntry objects, but using a
 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
 as well.  See `__init__` for details of the tuple values.
 

-:see: `wx.AcceleratorTable`");
+:see: `wx.AcceleratorTable`", "");

 
 class wxAcceleratorEntry {
 public:
     DocCtorStr(
         wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmdID = 0/*, wxMenuItem *menuitem = NULL*/),
 
 class wxAcceleratorEntry {
 public:
     DocCtorStr(
         wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmdID = 0/*, wxMenuItem *menuitem = NULL*/),

-        "Construct a wx.AcceleratorEntry.
-
-  :param flags: A bitmask of wx.ACCEL_ALT, wx.ACCEL_SHIFT,
-                wx.ACCEL_CTRL or wx.ACCEL_NORMAL used to specify
-                which modifier keys are held down.
-  :param keyCode: The keycode to be detected
-  :param cmdID: The menu or control command ID to use for the
+        "Construct a wx.AcceleratorEntry.",
+        "
+    :param flags: A bitmask of wx.ACCEL_ALT, wx.ACCEL_SHIFT,
+                wx.ACCEL_CTRL, wx.ACCEL_CMD,  or wx.ACCEL_NORMAL
+                used to specify which modifier keys are held down.
+    :param keyCode: The keycode to be detected
+    :param cmdID: The menu or control command ID to use for the

                 accellerator event.
 ");
     ~wxAcceleratorEntry();
                 accellerator event.
 ");
     ~wxAcceleratorEntry();


@@ -56,23 +64,52 @@ public:
     DocDeclStr(
         void , Set(int flags, int keyCode, int cmd/*, wxMenuItem *menuItem = NULL*/),
         "(Re)set the attributes of a wx.AcceleratorEntry.
     DocDeclStr(
         void , Set(int flags, int keyCode, int cmd/*, wxMenuItem *menuItem = NULL*/),
         "(Re)set the attributes of a wx.AcceleratorEntry.

-:see `__init__`");
+:see `__init__`", "");

     
 
 //     void SetMenuItem(wxMenuItem *item);
 //     wxMenuItem *GetMenuItem() const;
 
     
 
 //     void SetMenuItem(wxMenuItem *item);
 //     wxMenuItem *GetMenuItem() const;
 

+    %newobject Create;
+    DocDeclStr(
+        static wxAcceleratorEntry *, Create(const wxString& str),
+        "Create accelerator corresponding to the specified string, or None if
+it coulnd't be parsed.", "");
+    

     DocDeclStr(
         int , GetFlags(),
     DocDeclStr(
         int , GetFlags(),

-        "Get the AcceleratorEntry's flags.");
+        "Get the AcceleratorEntry's flags.", "");

     
     DocDeclStr(
         int , GetKeyCode(),
     
     DocDeclStr(
         int , GetKeyCode(),

-        "Get the AcceleratorEntry's keycode.");
+        "Get the AcceleratorEntry's keycode.", "");

     
     DocDeclStr(
         int , GetCommand(),
     
     DocDeclStr(
         int , GetCommand(),

-        "Get the AcceleratorEntry's command ID.");
+        "Get the AcceleratorEntry's command ID.", "");
+    
+    DocDeclStr(
+        bool , IsOk() const,
+        "", "");
+    
+    
+    DocDeclStr(
+        wxString , ToString() const,
+        "Returns a string representation for the this accelerator.  The string
+is formatted using the <flags>-<keycode> format where <flags> maybe a
+hyphen-separed list of \"shift|alt|ctrl\"
+", "");
+    
+
+    DocDeclStr(
+        bool , FromString(const wxString &str),
+        "Returns true if the given string correctly initialized this object.", "");
+    
+    
+    %property(Command, GetCommand, doc="See `GetCommand`");
+    %property(Flags, GetFlags, doc="See `GetFlags`");
+    %property(KeyCode, GetKeyCode, doc="See `GetKeyCode`");
+    

 };
 
 
 };
 
 


@@ -83,7 +120,7 @@ DocStr(wxAcceleratorTable,
 "An accelerator table allows the application to specify a table of
 keyboard shortcuts for menus or other commands. On Windows, menu or
 button commands are supported; on GTK, only menu commands are
 "An accelerator table allows the application to specify a table of
 keyboard shortcuts for menus or other commands. On Windows, menu or
 button commands are supported; on GTK, only menu commands are

-supported.
+supported.", "

 
 The object ``wx.NullAcceleratorTable`` is defined to be a table with
 no data, and is the initial accelerator table for a window.
 
 The object ``wx.NullAcceleratorTable`` is defined to be a table with
 no data, and is the initial accelerator table for a window.


@@ -93,7 +130,7 @@ convenient way to program some event handling. For example, you can
 use an accelerator table to make a hotkey generate an event no matter
 which window within a frame has the focus.
 
 use an accelerator table to make a hotkey generate an event no matter
 which window within a frame has the focus.
 

-Foe example::
+For example::

 
     aTable = wx.AcceleratorTable([(wx.ACCEL_ALT,  ord('X'), exitID),
                                   (wx.ACCEL_CTRL, ord('H'), helpID),
 
     aTable = wx.AcceleratorTable([(wx.ACCEL_ALT,  ord('X'), exitID),
                                   (wx.ACCEL_CTRL, ord('H'), helpID),


@@ -113,17 +150,17 @@ public:
             "Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
 items or or of 3-tuples (flags, keyCode, cmdID)
 
             "Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
 items or or of 3-tuples (flags, keyCode, cmdID)
 

-:see: `wx.AcceleratorEntry`");
+:see: `wx.AcceleratorEntry`", "");

     wxAcceleratorTable(int n, const wxAcceleratorEntry* entries);
     ~wxAcceleratorTable();
 
     wxAcceleratorTable(int n, const wxAcceleratorEntry* entries);
     ~wxAcceleratorTable();
 

-    bool Ok() const;
+    bool IsOk() const;
+    %pythoncode { Ok = IsOk }

 };
 
 
  
 %immutable;
 };
 
 
  
 %immutable;

-// See also wxPy_ReinitStockObjects in helpers.cpp

 const wxAcceleratorTable wxNullAcceleratorTable;
 %mutable;
 
 const wxAcceleratorTable wxNullAcceleratorTable;
 %mutable;