]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/controls2.i
added support for polygons to wxRegion
[wxWidgets.git] / wxPython / src / controls2.i
index bb24d596599d531964b8ae71cc4ab56c15463586..9f1f91c662d145029a74bd03ecf28c42b0313b96 100644 (file)
 
 %pragma(python) code = "import wx"
 
+
+//----------------------------------------------------------------------
 //----------------------------------------------------------------------
 
+enum {
+    /* List control event types */
+    wxEVT_COMMAND_LIST_BEGIN_DRAG,
+    wxEVT_COMMAND_LIST_BEGIN_RDRAG,
+    wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT,
+    wxEVT_COMMAND_LIST_END_LABEL_EDIT,
+    wxEVT_COMMAND_LIST_DELETE_ITEM,
+    wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS,
+    wxEVT_COMMAND_LIST_GET_INFO,
+    wxEVT_COMMAND_LIST_SET_INFO,
+    wxEVT_COMMAND_LIST_ITEM_SELECTED,
+    wxEVT_COMMAND_LIST_ITEM_DESELECTED,
+    wxEVT_COMMAND_LIST_KEY_DOWN,
+    wxEVT_COMMAND_LIST_INSERT_ITEM,
+    wxEVT_COMMAND_LIST_COL_CLICK,
+    wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK,
+    wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK,
+    wxEVT_COMMAND_LIST_ITEM_ACTIVATED,
+    wxEVT_COMMAND_LIST_CACHE_HINT,
+};
+
+
+%pragma(python) code = "
+def EVT_LIST_BEGIN_DRAG(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_DRAG, func)
+
+def EVT_LIST_BEGIN_RDRAG(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_RDRAG, func)
+
+def EVT_LIST_BEGIN_LABEL_EDIT(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, func)
+
+def EVT_LIST_END_LABEL_EDIT(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_END_LABEL_EDIT, func)
+
+def EVT_LIST_DELETE_ITEM(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ITEM, func)
+
+def EVT_LIST_DELETE_ALL_ITEMS(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, func)
+
+def EVT_LIST_GET_INFO(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_GET_INFO, func)
+
+def EVT_LIST_SET_INFO(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_SET_INFO, func)
+
+def EVT_LIST_ITEM_SELECTED(win, id, func):
+    win.Connect(id, -1,  wxEVT_COMMAND_LIST_ITEM_SELECTED, func)
+
+def EVT_LIST_ITEM_DESELECTED(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_DESELECTED, func)
+
+def EVT_LIST_KEY_DOWN(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_KEY_DOWN, func)
+
+def EVT_LIST_INSERT_ITEM(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_INSERT_ITEM, func)
+
+def EVT_LIST_COL_CLICK(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_CLICK, func)
+
+def EVT_LIST_ITEM_RIGHT_CLICK(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, func)
+
+def EVT_LIST_ITEM_MIDDLE_CLICK(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, func)
+
+def EVT_LIST_ITEM_ACTIVATED(win, id, func):
+    win.Connect(id, -1,  wxEVT_COMMAND_LIST_ITEM_ACTIVATED, func)
+
+def EVT_LIST_CACHE_HINT(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LIST_CACHE_HINT, func)
+"
+
+
+enum {
+    /* Style flags */
+    wxLC_VRULES,
+    wxLC_HRULES,
+
+    wxLC_ICON,
+    wxLC_SMALL_ICON,
+    wxLC_LIST,
+    wxLC_REPORT,
+
+    wxLC_ALIGN_TOP,
+    wxLC_ALIGN_LEFT,
+    wxLC_AUTOARRANGE,
+    wxLC_VIRTUAL,
+    wxLC_EDIT_LABELS,
+    wxLC_NO_HEADER,
+    wxLC_NO_SORT_HEADER,
+    wxLC_SINGLE_SEL,
+    wxLC_SORT_ASCENDING,
+    wxLC_SORT_DESCENDING,
+
+    wxLC_MASK_TYPE,
+    wxLC_MASK_ALIGN,
+    wxLC_MASK_SORT,
+
+};
+
 
 enum {
+    // Mask flags
+    wxLIST_MASK_STATE,
     wxLIST_MASK_TEXT,
     wxLIST_MASK_IMAGE,
     wxLIST_MASK_DATA,
+    wxLIST_SET_ITEM,
     wxLIST_MASK_WIDTH,
     wxLIST_MASK_FORMAT,
-    wxLIST_MASK_STATE,
+
+    // State flags
     wxLIST_STATE_DONTCARE,
     wxLIST_STATE_DROPHILITED,
     wxLIST_STATE_FOCUSED,
     wxLIST_STATE_SELECTED,
     wxLIST_STATE_CUT,
+
+    // Hit test flags
     wxLIST_HITTEST_ABOVE,
     wxLIST_HITTEST_BELOW,
     wxLIST_HITTEST_NOWHERE,
@@ -62,27 +173,40 @@ enum {
     wxLIST_HITTEST_TOLEFT,
     wxLIST_HITTEST_TORIGHT,
     wxLIST_HITTEST_ONITEM,
+
+    // Flags for GetNextItem
     wxLIST_NEXT_ABOVE,
     wxLIST_NEXT_ALL,
     wxLIST_NEXT_BELOW,
     wxLIST_NEXT_LEFT,
     wxLIST_NEXT_RIGHT,
+
+    // Alignment flags
     wxLIST_ALIGN_DEFAULT,
     wxLIST_ALIGN_LEFT,
     wxLIST_ALIGN_TOP,
     wxLIST_ALIGN_SNAP_TO_GRID,
-    wxLIST_AUTOSIZE,
-    wxLIST_AUTOSIZE_USEHEADER,
+
+    // Autosize values for SetColumnWidth
+    wxLIST_AUTOSIZE = -1,
+    wxLIST_AUTOSIZE_USEHEADER = -2,
+
+    // Flag values for GetItemRect
     wxLIST_RECT_BOUNDS,
     wxLIST_RECT_ICON,
     wxLIST_RECT_LABEL,
+
+    // Flag values for FindItem (MSW only)
     wxLIST_FIND_UP,
     wxLIST_FIND_DOWN,
     wxLIST_FIND_LEFT,
     wxLIST_FIND_RIGHT,
+
+
 };
 
 
+
 enum wxListColumnFormat
 {
     wxLIST_FORMAT_LEFT,
@@ -92,37 +216,17 @@ enum wxListColumnFormat
 };
 
 
-enum {
-    /* List control event types */
-    wxEVT_COMMAND_LIST_BEGIN_DRAG,
-    wxEVT_COMMAND_LIST_BEGIN_RDRAG,
-    wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT,
-    wxEVT_COMMAND_LIST_END_LABEL_EDIT,
-    wxEVT_COMMAND_LIST_DELETE_ITEM,
-    wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS,
-    wxEVT_COMMAND_LIST_GET_INFO,
-    wxEVT_COMMAND_LIST_SET_INFO,
-    wxEVT_COMMAND_LIST_ITEM_SELECTED,
-    wxEVT_COMMAND_LIST_ITEM_DESELECTED,
-    wxEVT_COMMAND_LIST_KEY_DOWN,
-    wxEVT_COMMAND_LIST_INSERT_ITEM,
-    wxEVT_COMMAND_LIST_COL_CLICK,
-    wxEVT_COMMAND_LIST_ITEM_ACTIVATED,
-    wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK,
-    wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK,
-};
-
 
 
 class wxListItemAttr
 {
 public:
     // ctors
-    wxListItemAttr();
-    //wxListItemAttr(const wxColour& colText,
-    //               const wxColour& colBack,
-    //               const wxFont& font)
-    //    : m_colText(colText), m_colBack(colBack), m_font(font) { }
+    //wxListItemAttr();
+    wxListItemAttr(const wxColour& colText = wxNullColour,
+                   const wxColour& colBack = wxNullColour,
+                   const wxFont& font = wxNullFont);
+
 
     // setters
     void SetTextColour(const wxColour& colText);
@@ -228,45 +332,77 @@ public:
 };
 
 
+%{
+class wxPyListCtrl : public wxListCtrl {
+    DECLARE_ABSTRACT_CLASS(wxPyListCtrl);
+public:
+    wxPyListCtrl(wxWindow* parent, wxWindowID id,
+                 const wxPoint& pos,
+                 const wxSize& size,
+                 long style,
+                 const wxValidator& validator,
+                 char* name) :
+        wxListCtrl(parent, id, pos, size, style, validator, name) {}
+
+    DEC_PYCALLBACK_STRING_LONGLONG(OnGetItemText);
+    DEC_PYCALLBACK_INT_LONG(OnGetItemImage);
+    DEC_PYCALLBACK_LISTATTR_LONG(OnGetItemAttr);
+
+    PYPRIVATE;
+};
+
+IMPLEMENT_ABSTRACT_CLASS(wxPyListCtrl, wxListCtrl);
+
+IMP_PYCALLBACK_STRING_LONGLONG(wxPyListCtrl, wxListCtrl, OnGetItemText);
+IMP_PYCALLBACK_INT_LONG(wxPyListCtrl, wxListCtrl, OnGetItemImage);
+IMP_PYCALLBACK_LISTATTR_LONG(wxPyListCtrl, wxListCtrl, OnGetItemAttr);
+%}
+
 
-class wxListCtrl : public wxControl {
+%name(wxListCtrl)class wxPyListCtrl : public wxControl {
 public:
-    wxListCtrl(wxWindow* parent, wxWindowID id,
-               const wxPoint& pos = wxDefaultPosition,
-               const wxSize& size = wxDefaultSize,
-               long style = wxLC_ICON,
-               const wxValidator& validator = wxDefaultValidator,
-               char* name = "listCtrl");
+    wxPyListCtrl(wxWindow* parent, wxWindowID id = -1,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 long style = wxLC_ICON,
+                 const wxValidator& validator = wxDefaultValidator,
+                 char* name = "listCtrl");
 
+    void _setSelf(PyObject* self, PyObject* _class);
     %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
+    %pragma(python) addtomethod = "__init__:self._setSelf(self, wxListCtrl)"
+
+
+    // Set the control colours
+    bool SetForegroundColour(const wxColour& col);
+    bool SetBackgroundColour(const wxColour& col);
+
+    // Gets information about this column
+    bool GetColumn(int col, wxListItem& item) const;
+
+    // Sets information about this column
+    bool SetColumn(int col, wxListItem& item) ;
+
+    // Gets the column width
+    int GetColumnWidth(int col) const;
+
+    // Sets the column width
+    bool SetColumnWidth(int col, int width) ;
+
+    // Gets the number of items that can fit vertically in the
+    // visible area of the list control (list or report view)
+    // or the total number of items in the list control (icon
+    // or small icon view)
+    int GetCountPerPage() const;
 
-    bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
-    void AssignImageList(wxImageList* imageList, int which);
-    %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
-    bool DeleteItem(long item);
-    bool DeleteAllItems();
-    bool DeleteColumn(int col);
-    bool DeleteAllColumns(void);
-    void ClearAll(void);
 #ifdef __WXMSW__
-    wxTextCtrl* EditLabel(long item);
-    bool EndEditLabel(bool cancel);
-    wxTextCtrl* GetEditControl();
-#else
-    void EditLabel(long item);
+    // Gets the edit control for editing labels.
+    wxTextCtrl* GetEditControl() const;
 #endif
-    bool EnsureVisible(long item);
-    long FindItem(long start, const wxString& str, bool partial = FALSE);
-    %name(FindItemData)long FindItem(long start, long data);
-    %name(FindItemAtPos)long FindItem(long start, const wxPoint& pt,
-                                      int direction);
-    bool GetColumn(int col, wxListItem& item);
-    int GetColumnWidth(int col);
-    int GetCountPerPage();
-    wxImageList* GetImageList(int which);
-    long GetItemData(long item);
 
+    //bool GetItem(wxListItem& info) const ;
     %addmethods {
+        // Gets information about the item
         %new wxListItem* GetItem(long itemId, int col=0) {
             wxListItem* info = new wxListItem;
             info->m_itemId = itemId;
@@ -275,11 +411,53 @@ public:
             self->GetItem(*info);
             return info;
         }
+    }  // The OOR typemaps don't know what to do with the %new, so fix it up.
+    %pragma(python) addtoclass = "
+    def GetItem(self, *_args, **_kwargs):
+        val = apply(controls2c.wxListCtrl_GetItem,(self,) + _args, _kwargs)
+        val.thisown = 1
+        return val
+    "
+
+
+    // Sets information about the item
+    bool SetItem(wxListItem& info) ;
+
+    // Sets a string field at a particular column
+    %name(SetStringItem)long SetItem(long index, int col, const wxString& label, int imageId = -1);
+
+    // Gets the item state
+    int  GetItemState(long item, long stateMask) const ;
+
+    // Sets the item state
+    bool SetItemState(long item, long state, long stateMask) ;
+
+    // Sets the item image
+    bool SetItemImage(long item, int image, int selImage) ;
+
+    // Gets the item text
+    wxString GetItemText(long item) const ;
+
+    // Sets the item text
+    void SetItemText(long item, const wxString& str) ;
+
+    // Gets the item data
+    long GetItemData(long item) const ;
+
+    // Sets the item data
+    bool SetItemData(long item, long data) ;
+
+
+    //bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
+    //bool GetItemPosition(long item, wxPoint& pos) const ;
+    %addmethods {
+        // Gets the item position
         %new wxPoint* GetItemPosition(long item) {
             wxPoint* pos = new wxPoint;
             self->GetItemPosition(item, *pos);
             return pos;
         }
+        // Gets the item rectangle
         %new wxRect* GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
             wxRect* rect= new wxRect;
             self->GetItemRect(item, *rect, code);
@@ -287,60 +465,160 @@ public:
         }
     }
 
-    int GetItemState(long item, long stateMask);
-    int GetItemCount();
-    int GetItemSpacing(bool isSmall);
-    wxString GetItemText(long item);
-    long GetNextItem(long item,
-                     int geometry = wxLIST_NEXT_ALL,
-                     int state = wxLIST_STATE_DONTCARE);
-    int GetSelectedItemCount();
-#ifdef __WXMSW__
-    wxColour GetTextColour();
+
+    // Sets the item position
+    bool SetItemPosition(long item, const wxPoint& pos) ;
+
+    // Gets the number of items in the list control
+    int GetItemCount() const;
+
+    // Gets the number of columns in the list control
+    int GetColumnCount() const { return m_colCount; }
+
+    // Retrieves the spacing between icons in pixels.
+    // If small is TRUE, gets the spacing for the small icon
+    // view, otherwise the large icon view.
+    int GetItemSpacing(bool isSmall) const;
+
+    // Gets the number of selected items in the list control
+    int GetSelectedItemCount() const;
+
+    // Gets the text colour of the listview
+    wxColour GetTextColour() const;
+
+    // Sets the text colour of the listview
     void SetTextColour(const wxColour& col);
+
+    // Gets the index of the topmost visible item when in
+    // list or report view
+    long GetTopItem() const ;
+
+    // Add or remove a single window style
+    void SetSingleStyle(long style, bool add = TRUE) ;
+
+    // Set the whole window style
+    void SetWindowStyleFlag(long style) ;
+
+    // Searches for an item, starting from 'item'.
+    // item can be -1 to find the first item that matches the
+    // specified flags.
+    // Returns the item or -1 if unsuccessful.
+    long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
+
+    // Gets one of the three image lists
+    wxImageList *GetImageList(int which) const ;
+
+    // Sets the image list
+    void SetImageList(wxImageList *imageList, int which) ;
+    void AssignImageList(wxImageList *imageList, int which) ;
+    %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
+
+    // returns true if it is a virtual list control
+    bool IsVirtual() const;
+
+    // refresh items selectively (only useful for virtual list controls)
+    void RefreshItem(long item);
+    void RefreshItems(long itemFrom, long itemTo);
+
+
+
+
+    // Arranges the items
+    bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
+
+    // Deletes an item
+    bool DeleteItem(long item);
+
+    // Deletes all items
+    bool DeleteAllItems() ;
+
+    // Deletes a column
+    bool DeleteColumn(int col);
+
+    // Deletes all columns
+    bool DeleteAllColumns();
+
+    // Clears items, and columns if there are any.
+    void ClearAll();
+
+#ifdef __WXMSW__
+    // Edit the label
+    wxTextCtrl* EditLabel(long item /*, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)*/);
+
+    // End label editing, optionally cancelling the edit
+    bool EndEditLabel(bool cancel);
 #endif
-    long GetTopItem();
+
+    // Ensures this item is visible
+    bool EnsureVisible(long item) ;
+
+    // Find an item whose label matches this string, starting from the item after 'start'
+    // or the beginning if 'start' is -1.
+    long FindItem(long start, const wxString& str, bool partial = FALSE);
+
+    // Find an item whose data matches this data, starting from the item after 'start'
+    // or the beginning if 'start' is -1.
+    %name(FindItemData)long FindItem(long start, long data);
+
+    // Find an item nearest this position in the specified direction, starting from
+    // the item after 'start' or the beginning if 'start' is -1.
+    %name(FindItemAtPos)long FindItem(long start, const wxPoint& pt, int direction);
+
+    // Determines which item (if any) is at the specified point,
+    // giving details in the second return value (see wxLIST_HITTEST_... flags above)
     long HitTest(const wxPoint& point, int& OUTPUT);
+
+    // Inserts an item, returning the index of the new item if successful,
+    // -1 otherwise.
+    long InsertItem(wxListItem& info);
+
+    // Insert a string item
+    %name(InsertStringItem)long InsertItem(long index, const wxString& label);
+
+    // Insert an image item
+    %name(InsertImageItem)long InsertItem(long index, int imageIndex);
+
+    // Insert an image/string item
+    %name(InsertImageStringItem)long InsertItem(long index, const wxString& label, int imageIndex);
+
+    // For list view mode (only), inserts a column.
     %name(InsertColumnInfo)long InsertColumn(long col, wxListItem& info);
-    long InsertColumn(long col, const wxString& heading,
+
+    long InsertColumn(long col,
+                      const wxString& heading,
                       int format = wxLIST_FORMAT_LEFT,
                       int width = -1);
 
-    long InsertItem(wxListItem& info);
-    %name(InsertStringItem)     long InsertItem(long index, const wxString& label);
-    %name(InsertImageItem)      long InsertItem(long index, int imageIndex);
-    %name(InsertImageStringItem)long InsertItem(long index, const wxString& label,
-                                                int imageIndex);
+    // set the number of items in a virtual list control
+    void SetItemCount(long count);
 
+    // Scrolls the list control. If in icon, small icon or report view mode,
+    // x specifies the number of pixels to scroll. If in list view mode, x
+    // specifies the number of columns to scroll.
+    // If in icon, small icon or list view mode, y specifies the number of pixels
+    // to scroll. If in report view mode, y specifies the number of lines to scroll.
     bool ScrollList(int dx, int dy);
-    void SetBackgroundColour(const wxColour& col);
-    bool SetColumn(int col, wxListItem& item);
-    bool SetColumnWidth(int col, int width);
-    void SetImageList(wxImageList* imageList, int which);
-
-    bool SetItem(wxListItem& info);
-    %name(SetStringItem)long SetItem(long index, int col, const wxString& label,
-                                     int imageId = -1);
-
-    bool SetItemData(long item, long data);
-    bool SetItemImage(long item, int image, int selImage);
-    bool SetItemPosition(long item, const wxPoint& pos);
-    bool SetItemState(long item, long state, long stateMask);
-    void SetItemText(long item, const wxString& text);
-    void SetSingleStyle(long style, bool add = TRUE);
-    void SetWindowStyleFlag(long style);
 
     // bool SortItems(wxListCtrlCompare fn, long data);
     %addmethods {
+        // Sort items.
+        // func is a function which takes 2 long arguments: item1, item2.
+        // item1 is the long data associated with a first item (NOT the index).
+        // item2 is the long data associated with a second item (NOT the index).
+        // The return value is a negative number if the first item should precede the second
+        // item, a positive number of the second item should precede the first,
+        // or zero if the two items are equivalent.
         bool SortItems(PyObject* func) {
             if (!PyCallable_Check(func))
                 return FALSE;
-
             return self->SortItems(wxPyListCtrl_SortItems, (long)func);
         }
     }
+
 };
 
+
+
 %{
     int wxCALLBACK wxPyListCtrl_SortItems(long item1, long item2, long funcPtr) {
         int retval = 0;