wxPython/src/_menu.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _menu.i
   3 // Purpose:     SWIG interface defs for wxMenuBar, wxMenu and wxMenuItem
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     24-June-1997
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 %newgroup
  18
  19
  20 MustHaveApp(wxMenu);
  21
  22 class wxMenu : public wxEvtHandler
  23 {
  24 public:
  25     %pythonAppend wxMenu         "self._setOORInfo(self)"
  26     %typemap(out) wxMenu*;    // turn off this typemap
  27
  28     wxMenu(const wxString& title = wxPyEmptyString, long style = 0);
  29
  30     // Turn it back on again
  31     %typemap(out) wxMenu* { $result = wxPyMake_wxObject($1, $owner); }
  32
  33
  34     // append any kind of item (normal/check/radio/separator)
  35     wxMenuItem* Append(int id,
  36                        const wxString& text = wxPyEmptyString,
  37                        const wxString& help = wxPyEmptyString,
  38                        wxItemKind kind = wxITEM_NORMAL);
  39
  40     // append a separator to the menu
  41     wxMenuItem* AppendSeparator();
  42
  43     // append a check item
  44     wxMenuItem* AppendCheckItem(int id,
  45                                 const wxString& text,
  46                                 const wxString& help = wxPyEmptyString);
  47
  48     // append a radio item
  49     wxMenuItem* AppendRadioItem(int id,
  50                                 const wxString& text,
  51                                 const wxString& help = wxPyEmptyString);
  52     // append a submenu
  53     %Rename(AppendMenu, wxMenuItem*, Append(int id,
  54                                            const wxString& text,
  55                                            wxMenu *submenu,
  56                                            const wxString& help = wxPyEmptyString));
  57
  58     wxMenuItem* AppendSubMenu(wxMenu *submenu,
  59                               const wxString& text,
  60                               const wxString& help = wxPyEmptyString);
  61
  62     %disownarg(wxMenuItem*);
  63     // the most generic form of Append() - append anything
  64     %Rename(AppendItem, wxMenuItem*, Append(wxMenuItem *item));
  65     // insert an item before given position
  66     %Rename(InsertItem, wxMenuItem*, Insert(size_t pos, wxMenuItem *item));
  67     // prepend an item to the menu
  68     %Rename(PrependItem,  wxMenuItem*, Prepend(wxMenuItem *item));
  69     %cleardisown(wxMenuItem*);
  70
  71
  72     // insert a break in the menu (only works when appending the items, not
  73     // inserting them)
  74     virtual void Break();
  75
  76     // insert an item before given position
  77     wxMenuItem* Insert(size_t pos,
  78                        int id,
  79                        const wxString& text = wxPyEmptyString,
  80                        const wxString& help = wxPyEmptyString,
  81                        wxItemKind kind = wxITEM_NORMAL);
  82
  83     // insert a separator
  84     wxMenuItem* InsertSeparator(size_t pos);
  85
  86     // insert a check item
  87     wxMenuItem* InsertCheckItem(size_t pos,
  88                                 int id,
  89                                 const wxString& text,
  90                                 const wxString& help = wxPyEmptyString);
  91
  92     // insert a radio item
  93     wxMenuItem* InsertRadioItem(size_t pos,
  94                                 int id,
  95                                 const wxString& text,
  96                                 const wxString& help = wxPyEmptyString);
  97
  98     // insert a submenu
  99     %Rename(InsertMenu, wxMenuItem*, Insert(size_t pos,
 100                                          int id,
 101                                          const wxString& text,
 102                                          wxMenu *submenu,
 103                                          const wxString& help = wxPyEmptyString));
 104
 105     // prepend any item to the menu
 106     wxMenuItem* Prepend(int id,
 107                         const wxString& text = wxPyEmptyString,
 108                         const wxString& help = wxPyEmptyString,
 109                         wxItemKind kind = wxITEM_NORMAL);
 110
 111     // prepend a separator
 112     wxMenuItem*  PrependSeparator();
 113
 114     // prepend a check item
 115     wxMenuItem* PrependCheckItem(int id,
 116                                  const wxString& text,
 117                                  const wxString& help = wxPyEmptyString);
 118
 119     // prepend a radio item
 120     wxMenuItem*  PrependRadioItem(int id,
 121                                   const wxString& text,
 122                                   const wxString& help = wxPyEmptyString);
 123
 124     // prepend a submenu
 125     %Rename(PrependMenu,  wxMenuItem*, Prepend(int id,
 126                                            const wxString& text,
 127                                            wxMenu *submenu,
 128                                            const wxString& help = wxPyEmptyString));
 129
 130
 131     // detach an item from the menu, but don't delete it so that it can be
 132     // added back later (but if it's not, the caller is responsible for
 133     // deleting it!)
 134     %newobject Remove;
 135     wxMenuItem *Remove(int id);
 136     %Rename(RemoveItem,  wxMenuItem*, Remove(wxMenuItem *item));
 137
 138     // delete an item from the menu (submenus are not destroyed by this
 139     // function, see Destroy)
 140     bool Delete(int id);
 141     %Rename(DeleteItem,  bool, Delete(wxMenuItem *item));
 142
 143     %pythonAppend Destroy "args[0].thisown = 0"
 144     %extend { void Destroy() { delete self; } }
 145
 146     // delete the item from menu and destroy it (if it's a submenu)
 147     %Rename(DestroyId,  bool, Destroy(int id));
 148     %Rename(DestroyItem,  bool, Destroy(wxMenuItem *item));
 149
 150
 151     // get the items
 152     size_t GetMenuItemCount() const;
 153     %extend {
 154         PyObject* GetMenuItems() {
 155             wxMenuItemList& list = self->GetMenuItems();
 156             return wxPy_ConvertList(&list);
 157         }
 158     }
 159
 160     // search
 161     int FindItem(const wxString& item) const;
 162     %Rename(FindItemById, wxMenuItem*, FindItem(int id /*, wxMenu **menu = NULL*/) const);
 163
 164     // find by position
 165     wxMenuItem* FindItemByPosition(size_t position) const;
 166
 167     // get/set items attributes
 168     void Enable(int id, bool enable);
 169     bool IsEnabled(int id) const;
 170
 171     void Check(int id, bool check);
 172     bool IsChecked(int id) const;
 173
 174     void SetLabel(int id, const wxString& label);
 175     wxString GetLabel(int id) const;
 176
 177     virtual void SetHelpString(int id, const wxString& helpString);
 178     virtual wxString GetHelpString(int id) const;
 179
 180
 181     // the title
 182     virtual void SetTitle(const wxString& title);
 183     const wxString GetTitle() const;
 184
 185     // event handler
 186     void SetEventHandler(wxEvtHandler *handler);
 187     wxEvtHandler *GetEventHandler() const;
 188
 189     // invoking window
 190     void SetInvokingWindow(wxWindow *win);
 191     wxWindow *GetInvokingWindow() const;
 192
 193     // style
 194     long GetStyle() const { return m_style; }
 195
 196
 197     // Updates the UI for a menu and all submenus recursively. source is the
 198     // object that has the update event handlers defined for it. If NULL, the
 199     // menu or associated window will be used.
 200     void UpdateUI(wxEvtHandler* source = NULL);
 201
 202     // get the menu bar this menu is attached to (may be NULL, always NULL for
 203     // popup menus)
 204     wxMenuBar *GetMenuBar() const;
 205
 206 // TODO:  Should these be exposed?
 207     // called when the menu is attached/detached to/from a menu bar
 208     virtual void Attach(wxMenuBarBase *menubar);
 209     virtual void Detach();
 210
 211     // is the menu attached to a menu bar (or is it a popup one)?
 212     bool IsAttached() const;
 213
 214     // set/get the parent of this menu
 215     void SetParent(wxMenu *parent);
 216     wxMenu *GetParent() const;
 217
 218     %property(EventHandler, GetEventHandler, SetEventHandler, doc="See `GetEventHandler` and `SetEventHandler`");
 219     %property(HelpString, GetHelpString, SetHelpString, doc="See `GetHelpString` and `SetHelpString`");
 220     %property(InvokingWindow, GetInvokingWindow, SetInvokingWindow, doc="See `GetInvokingWindow` and `SetInvokingWindow`");
 221     %property(MenuBar, GetMenuBar, doc="See `GetMenuBar`");
 222     %property(MenuItemCount, GetMenuItemCount, doc="See `GetMenuItemCount`");
 223     %property(MenuItems, GetMenuItems, doc="See `GetMenuItems`");
 224     %property(Parent, GetParent, SetParent, doc="See `GetParent` and `SetParent`");
 225     %property(Style, GetStyle, doc="See `GetStyle`");
 226     %property(Title, GetTitle, SetTitle, doc="See `GetTitle` and `SetTitle`");
 227
 228 };
 229
 230 //---------------------------------------------------------------------------
 231 %newgroup
 232
 233 MustHaveApp(wxMenuBar);
 234
 235 class wxMenuBar : public wxWindow
 236 {
 237 public:
 238     %pythonAppend wxMenuBar         "self._setOORInfo(self)"
 239     %typemap(out) wxMenuBar*;    // turn off this typemap
 240
 241     wxMenuBar(long style = 0);
 242
 243     // Turn it back on again
 244     %typemap(out) wxMenuBar* { $result = wxPyMake_wxObject($1, $owner); }
 245
 246     // append a menu to the end of menubar, return True if ok
 247     virtual bool Append(wxMenu *menu, const wxString& title);
 248
 249     // insert a menu before the given position into the menubar, return True
 250     // if inserted ok
 251     virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
 252
 253
 254     // get the number of menus in the menu bar
 255     size_t GetMenuCount() const;
 256
 257     // get the menu at given position
 258     wxMenu *GetMenu(size_t pos) const;
 259
 260     // replace the menu at given position with another one, returns the
 261     // previous menu (which should be deleted by the caller)
 262     virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
 263
 264     // delete the menu at given position from the menu bar, return the pointer
 265     // to the menu (which should be  deleted by the caller)
 266     virtual wxMenu *Remove(size_t pos);
 267
 268     // enable or disable a submenu
 269     virtual void EnableTop(size_t pos, bool enable);
 270
 271     // is the menu enabled?
 272     virtual bool IsEnabledTop(size_t pos) const;
 273
 274     // get or change the label of the menu at given position
 275     virtual void SetLabelTop(size_t pos, const wxString& label);
 276     virtual wxString GetLabelTop(size_t pos) const;
 277
 278
 279     // by menu and item names, returns wxNOT_FOUND if not found or id of the
 280     // found item
 281     virtual int FindMenuItem(const wxString& menu, const wxString& item) const;
 282
 283     // find item by id (in any menu), returns NULL if not found
 284     //
 285     // if menu is !NULL, it will be filled with wxMenu this item belongs to
 286     %Rename(FindItemById, virtual wxMenuItem*, FindItem(int id /*, wxMenu **menu = NULL*/) const);
 287
 288     // find menu by its caption, return wxNOT_FOUND on failure
 289     int FindMenu(const wxString& title);
 290
 291
 292     // all these functions just use FindItem() and then call an appropriate
 293     // method on it
 294     //
 295     // NB: under MSW, these methods can only be used after the menubar had
 296     //     been attached to the frame
 297
 298     void Enable(int id, bool enable);
 299     void Check(int id, bool check);
 300     bool IsChecked(int id) const;
 301     bool IsEnabled(int id) const;
 302     // TODO: bool IsEnabled() const;
 303
 304     void SetLabel(int id, const wxString &label);
 305     wxString GetLabel(int id) const;
 306
 307     void SetHelpString(int id, const wxString& helpString);
 308     wxString GetHelpString(int id) const;
 309
 310
 311     // get the frame we are attached to (may return NULL)
 312     wxFrame *GetFrame() const;
 313
 314     // returns True if we're attached to a frame
 315     bool IsAttached() const;
 316
 317     // associate the menubar with the frame
 318     virtual void Attach(wxFrame *frame);
 319
 320     // called before deleting the menubar normally
 321     virtual void Detach();
 322
 323     // update all menu item states in all menus
 324     virtual void UpdateMenus();
 325
 326 #ifdef __WXMAC__
 327     static void SetAutoWindowMenu( bool enable );
 328     static bool GetAutoWindowMenu();
 329 #else
 330     %extend {
 331         static void SetAutoWindowMenu( bool enable ) {}
 332         static bool GetAutoWindowMenu() { return false; }
 333     }
 334 #endif
 335
 336     %pythoncode {
 337         def GetMenus(self):
 338             """Return a list of (menu, label) items for the menus in the MenuBar. """
 339             return [(self.GetMenu(i), self.GetLabelTop(i))
 340                     for i in range(self.GetMenuCount())]
 341
 342         def SetMenus(self, items):
 343             """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
 344             for i in range(self.GetMenuCount()-1, -1, -1):
 345                 self.Remove(i)
 346             for m, l in items:
 347                 self.Append(m, l)
 348     }
 349
 350     %property(Frame, GetFrame, doc="See `GetFrame`");
 351     %property(Menu, GetMenu, doc="See `GetMenu`");
 352     %property(MenuCount, GetMenuCount, doc="See `GetMenuCount`");
 353     %property(Menus, GetMenus, SetMenus, doc="See `GetMenus` and `SetMenus`");
 354 };
 355
 356 //---------------------------------------------------------------------------
 357 %newgroup
 358
 359 class wxMenuItem : public wxObject {
 360 public:
 361     wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_ANY,
 362                const wxString& text = wxPyEmptyString,
 363                const wxString& help = wxPyEmptyString,
 364                wxItemKind kind = wxITEM_NORMAL,
 365                wxMenu* subMenu = NULL);
 366     ~wxMenuItem();
 367
 368     // the menu we're in
 369     wxMenu *GetMenu() const;
 370     void SetMenu(wxMenu* menu);
 371
 372     // get/set id
 373     void SetId(int id);
 374     int  GetId() const;
 375     bool IsSeparator() const;
 376
 377     // the item's text (or name)
 378     //
 379     // NB: the item's text includes the accelerators and mnemonics info (if
 380     //     any), i.e. it may contain '&' or '_' or "\t..." and thus is
 381     //     different from the item's label which only contains the text shown
 382     //     in the menu
 383     virtual void SetText(const wxString& str);
 384     wxString GetLabel() const;
 385     const wxString& GetText() const;
 386
 387     // get the label from text
 388     static wxString GetLabelFromText(const wxString& text);
 389
 390     // what kind of menu item we are
 391     wxItemKind GetKind() const;
 392     void SetKind(wxItemKind kind);
 393
 394     virtual void SetCheckable(bool checkable);
 395     bool IsCheckable() const;
 396
 397     bool IsSubMenu() const;
 398     void SetSubMenu(wxMenu *menu);
 399     wxMenu *GetSubMenu() const;
 400
 401     // state
 402     virtual void Enable(bool enable = true);
 403     virtual bool IsEnabled() const;
 404
 405     virtual void Check(bool check = true);
 406     virtual bool IsChecked() const;
 407     void Toggle();
 408
 409     // help string (displayed in the status bar by default)
 410     void SetHelp(const wxString& str);
 411     const wxString& GetHelp() const;
 412
 413     // get our accelerator or NULL (caller must delete the pointer)
 414     virtual wxAcceleratorEntry *GetAccel() const;
 415
 416     // set the accel for this item - this may also be done indirectly with
 417     // SetText()
 418     virtual void SetAccel(wxAcceleratorEntry *accel);
 419
 420     void SetBitmap(const wxBitmap& bitmap);
 421     const wxBitmap& GetBitmap();
 422
 423     // wxOwnerDrawn methods
 424 #ifdef __WXMSW__
 425     void SetFont(const wxFont& font);
 426     wxFont GetFont();
 427     void SetTextColour(const wxColour& colText);
 428     wxColour GetTextColour();
 429     void SetBackgroundColour(const wxColour& colBack);
 430     wxColour GetBackgroundColour();
 431     void SetBitmaps(const wxBitmap& bmpChecked,
 432                     const wxBitmap& bmpUnchecked = wxNullBitmap);
 433
 434     void SetDisabledBitmap( const wxBitmap& bmpDisabled );
 435     const wxBitmap& GetDisabledBitmap() const;
 436
 437     void SetMarginWidth(int nWidth);
 438     int GetMarginWidth();
 439     static int GetDefaultMarginWidth();
 440     bool IsOwnerDrawn();
 441
 442     // switch on/off owner-drawing the item
 443     void SetOwnerDrawn(bool ownerDrawn = true);
 444     void ResetOwnerDrawn();
 445 #else
 446     %extend {
 447         void SetFont(const wxFont& font) {}
 448         wxFont GetFont() { return wxNullFont; }
 449         void SetTextColour(const wxColour& colText) {}
 450         wxColour GetTextColour() { return wxNullColour; }
 451         void SetBackgroundColour(const wxColour& colBack) {}
 452         wxColour GetBackgroundColour() { return wxNullColour; }
 453
 454         void SetBitmaps(const wxBitmap& bmpChecked,
 455                         const wxBitmap& bmpUnchecked = wxNullBitmap)
 456             { self->SetBitmap( bmpChecked ); }
 457
 458         void SetDisabledBitmap( const wxBitmap& bmpDisabled ) {}
 459         const wxBitmap& GetDisabledBitmap() const { return wxNullBitmap; }
 460
 461         void SetMarginWidth(int nWidth) {}
 462         int GetMarginWidth() { return 0; }
 463         static int GetDefaultMarginWidth() { return 0; }
 464         bool IsOwnerDrawn() { return false; }
 465         void SetOwnerDrawn(bool ownerDrawn = true) {}
 466         void ResetOwnerDrawn() {}
 467     }
 468 #endif
 469
 470     %property(Accel, GetAccel, SetAccel, doc="See `GetAccel` and `SetAccel`");
 471     %property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
 472     %property(Bitmap, GetBitmap, SetBitmap, doc="See `GetBitmap` and `SetBitmap`");
 473     %property(DisabledBitmap, GetDisabledBitmap, SetDisabledBitmap, doc="See `GetDisabledBitmap` and `SetDisabledBitmap`");
 474     %property(Font, GetFont, SetFont, doc="See `GetFont` and `SetFont`");
 475     %property(Help, GetHelp, SetHelp, doc="See `GetHelp` and `SetHelp`");
 476     %property(Id, GetId, SetId, doc="See `GetId` and `SetId`");
 477     %property(Kind, GetKind, SetKind, doc="See `GetKind` and `SetKind`");
 478     %property(Label, GetLabel, doc="See `GetLabel`");
 479     %property(MarginWidth, GetMarginWidth, SetMarginWidth, doc="See `GetMarginWidth` and `SetMarginWidth`");
 480     %property(Menu, GetMenu, SetMenu, doc="See `GetMenu` and `SetMenu`");
 481     %property(SubMenu, GetSubMenu, SetSubMenu, doc="See `GetSubMenu` and `SetSubMenu`");
 482     %property(Text, GetText, SetText, doc="See `GetText` and `SetText`");
 483     %property(TextColour, GetTextColour, SetTextColour, doc="See `GetTextColour` and `SetTextColour`");
 484
 485 };
 486
 487 //---------------------------------------------------------------------------
 488 //---------------------------------------------------------------------------