d07d2bc9d0
Removed RefDoc macros, instead made all the normal Docstring macros take an extra parameter to be used for the optional details postion of the docstring. The intent is that the docstrings put in the generated .py files checked in to CVS and delivered in releases will be only a paragraph or two, but when used for generating the epydoc reference docs they can optionally contain a lot more details. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27216 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
364 lines
11 KiB
OpenEdge ABL
364 lines
11 KiB
OpenEdge ABL
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: _notebook.i
|
|
// Purpose: SWIG interface defs for wxNotebook and such
|
|
//
|
|
// Author: Robin Dunn
|
|
//
|
|
// Created: 2-June-1998
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) 2003 by Total Control Software
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Not a %module
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
MAKE_CONST_WXSTRING(NOTEBOOK_NAME);
|
|
|
|
//---------------------------------------------------------------------------
|
|
%newgroup
|
|
|
|
// TODO: Virtualize this class so other book controls can be derived in Python
|
|
|
|
// Common base class for wxList/Tree/Notebook
|
|
class wxBookCtrl : public wxControl
|
|
{
|
|
public:
|
|
// This is an ABC, it can't be constructed...
|
|
|
|
// wxBookCtrl(wxWindow *parent,
|
|
// wxWindowID id,
|
|
// const wxPoint& pos = wxDefaultPosition,
|
|
// const wxSize& size = wxDefaultSize,
|
|
// long style = 0,
|
|
// const wxString& name = wxPyEmptyString);
|
|
// %name(PreBookCtrl)wxBookCtrl();
|
|
// bool Create(wxWindow *parent,
|
|
// wxWindowID id,
|
|
// const wxPoint& pos = wxDefaultPosition,
|
|
// const wxSize& size = wxDefaultSize,
|
|
// long style = 0,
|
|
// const wxString& name = wxPyEmptyString);
|
|
|
|
|
|
// get number of pages in the dialog
|
|
virtual size_t GetPageCount() const;
|
|
|
|
// get the panel which represents the given page
|
|
virtual wxWindow *GetPage(size_t n);
|
|
|
|
// get the currently selected page or wxNOT_FOUND if none
|
|
virtual int GetSelection() const/* = 0*/;
|
|
|
|
// set/get the title of a page
|
|
virtual bool SetPageText(size_t n, const wxString& strText)/* = 0*/;
|
|
virtual wxString GetPageText(size_t n) const/* = 0*/;
|
|
|
|
|
|
// image list stuff: each page may have an image associated with it (all
|
|
// images belong to the same image list)
|
|
|
|
// sets the image list to use, it is *not* deleted by the control
|
|
virtual void SetImageList(wxImageList *imageList);
|
|
|
|
// as SetImageList() but we will delete the image list ourselves
|
|
%apply SWIGTYPE *DISOWN { wxImageList *imageList };
|
|
void AssignImageList(wxImageList *imageList);
|
|
%clear wxImageList *imageList;
|
|
|
|
// get pointer (may be NULL) to the associated image list
|
|
wxImageList* GetImageList() const;
|
|
|
|
// sets/returns item's image index in the current image list
|
|
virtual int GetPageImage(size_t n) const/* = 0*/;
|
|
virtual bool SetPageImage(size_t n, int imageId)/* = 0*/;
|
|
|
|
|
|
// resize the notebook so that all pages will have the specified size
|
|
virtual void SetPageSize(const wxSize& size);
|
|
|
|
// calculate the size of the control from the size of its page
|
|
virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const/* = 0*/;
|
|
|
|
|
|
|
|
// remove one page from the control and delete it
|
|
virtual bool DeletePage(size_t n);
|
|
|
|
// remove one page from the notebook, without deleting it
|
|
virtual bool RemovePage(size_t n);
|
|
|
|
// remove all pages and delete them
|
|
virtual bool DeleteAllPages();
|
|
|
|
// adds a new page to the control
|
|
virtual bool AddPage(wxWindow *page,
|
|
const wxString& text,
|
|
bool select = False,
|
|
int imageId = -1);
|
|
|
|
// the same as AddPage(), but adds the page at the specified position
|
|
virtual bool InsertPage(size_t n,
|
|
wxWindow *page,
|
|
const wxString& text,
|
|
bool select = False,
|
|
int imageId = -1)/* = 0*/;
|
|
|
|
// set the currently selected page, return the index of the previously
|
|
// selected one (or -1 on error)
|
|
//
|
|
// NB: this function will _not_ generate PAGE_CHANGING/ED events
|
|
virtual int SetSelection(size_t n)/* = 0*/;
|
|
|
|
|
|
// cycle thru the pages
|
|
void AdvanceSelection(bool forward = True);
|
|
|
|
static wxVisualAttributes
|
|
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
|
|
};
|
|
|
|
|
|
|
|
class wxBookCtrlEvent : public wxNotifyEvent
|
|
{
|
|
public:
|
|
wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
|
|
int nSel = -1, int nOldSel = -1);
|
|
|
|
// the currently selected page (-1 if none)
|
|
int GetSelection() const;
|
|
void SetSelection(int nSel);
|
|
// the page that was selected before the change (-1 if none)
|
|
int GetOldSelection() const;
|
|
void SetOldSelection(int nOldSel);
|
|
};
|
|
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
%newgroup
|
|
|
|
enum {
|
|
// styles
|
|
wxNB_FIXEDWIDTH,
|
|
wxNB_TOP,
|
|
wxNB_LEFT,
|
|
wxNB_RIGHT,
|
|
wxNB_BOTTOM,
|
|
wxNB_MULTILINE,
|
|
|
|
// hittest flags
|
|
wxNB_HITTEST_NOWHERE = 1, // not on tab
|
|
wxNB_HITTEST_ONICON = 2, // on icon
|
|
wxNB_HITTEST_ONLABEL = 4, // on label
|
|
wxNB_HITTEST_ONITEM = wxNB_HITTEST_ONICON | wxNB_HITTEST_ONLABEL,
|
|
|
|
};
|
|
|
|
|
|
|
|
class wxNotebook : public wxBookCtrl {
|
|
public:
|
|
%pythonAppend wxNotebook "self._setOORInfo(self)"
|
|
%pythonAppend wxNotebook() ""
|
|
|
|
wxNotebook(wxWindow *parent,
|
|
wxWindowID id=-1,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = 0,
|
|
const wxString& name = wxPyNOTEBOOK_NAME);
|
|
%name(PreNotebook)wxNotebook();
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = 0,
|
|
const wxString& name = wxPyNOTEBOOK_NAME);
|
|
|
|
|
|
// get the number of rows for a control with wxNB_MULTILINE style (not all
|
|
// versions support it - they will always return 1 then)
|
|
virtual int GetRowCount() const;
|
|
|
|
// set the padding between tabs (in pixels)
|
|
virtual void SetPadding(const wxSize& padding);
|
|
|
|
// set the size of the tabs for wxNB_FIXEDWIDTH controls
|
|
virtual void SetTabSize(const wxSize& sz);
|
|
|
|
// hit test, returns which tab is hit and, optionally, where (icon, label)
|
|
// (not implemented on all platforms)
|
|
DocDeclAStr(
|
|
virtual int, HitTest(const wxPoint& pt, long* OUTPUT) const,
|
|
"HitTest(Point pt) -> (tab, where)",
|
|
"Returns the tab which is hit, and flags indicating where using
|
|
wx.NB_HITTEST flags.", "");
|
|
|
|
// implement some base class functions
|
|
virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
|
|
|
|
#ifdef __WXMSW__
|
|
// Windows only: attempts to apply the UX theme page background to this page
|
|
void ApplyThemeBackground(wxWindow* window, const wxColour& colour);
|
|
#endif
|
|
|
|
static wxVisualAttributes
|
|
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
|
|
};
|
|
|
|
|
|
|
|
class wxNotebookEvent : public wxBookCtrlEvent
|
|
{
|
|
public:
|
|
wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
|
|
int nSel = -1, int nOldSel = -1);
|
|
|
|
};
|
|
|
|
// notebook control event types
|
|
%constant wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED;
|
|
%constant wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING;
|
|
|
|
|
|
%pythoncode {
|
|
%# wxNotebook events
|
|
EVT_NOTEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 1 )
|
|
EVT_NOTEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 1 )
|
|
}
|
|
|
|
|
|
%pythoncode {
|
|
%#----------------------------------------------------------------------------
|
|
|
|
class NotebookPage(wx.Panel):
|
|
"""
|
|
There is an old (and apparently unsolvable) bug when placing a
|
|
window with a nonstandard background colour in a wxNotebook on
|
|
wxGTK, as the notbooks's background colour would always be used
|
|
when the window is refreshed. The solution is to place a panel in
|
|
the notbook and the coloured window on the panel, sized to cover
|
|
the panel. This simple class does that for you, just put an
|
|
instance of this in the notebook and make your regular window a
|
|
child of this one and it will handle the resize for you.
|
|
"""
|
|
def __init__(self, parent, id=-1,
|
|
pos=wx.DefaultPosition, size=wx.DefaultSize,
|
|
style=wx.TAB_TRAVERSAL, name="panel"):
|
|
wx.Panel.__init__(self, parent, id, pos, size, style, name)
|
|
self.child = None
|
|
EVT_SIZE(self, self.OnSize)
|
|
|
|
def OnSize(self, evt):
|
|
if self.child is None:
|
|
children = self.GetChildren()
|
|
if len(children):
|
|
self.child = children[0]
|
|
if self.child:
|
|
self.child.SetPosition((0,0))
|
|
self.child.SetSize(self.GetSize())
|
|
|
|
}
|
|
|
|
//---------------------------------------------------------------------------
|
|
%newgroup
|
|
|
|
|
|
enum
|
|
{
|
|
// default alignment: left everywhere except Mac where it is top
|
|
wxLB_DEFAULT = 0,
|
|
|
|
// put the list control to the left/right/top/bottom of the page area
|
|
wxLB_TOP = 0x1,
|
|
wxLB_BOTTOM = 0x2,
|
|
wxLB_LEFT = 0x4,
|
|
wxLB_RIGHT = 0x8,
|
|
|
|
// the mask which can be used to extract the alignment from the style
|
|
wxLB_ALIGN_MASK = 0xf,
|
|
};
|
|
|
|
|
|
|
|
// wxListCtrl and wxNotebook combination
|
|
class wxListbook : public wxBookCtrl
|
|
{
|
|
public:
|
|
%pythonAppend wxListbook "self._setOORInfo(self)"
|
|
%pythonAppend wxListbook() ""
|
|
|
|
wxListbook(wxWindow *parent,
|
|
wxWindowID id=-1,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = 0,
|
|
const wxString& name = wxPyEmptyString);
|
|
%name(PreListbook)wxListbook();
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = 0,
|
|
const wxString& name = wxPyEmptyString);
|
|
|
|
// returns True if we have wxLB_TOP or wxLB_BOTTOM style
|
|
bool IsVertical() const;
|
|
|
|
};
|
|
|
|
|
|
|
|
class wxListbookEvent : public wxBookCtrlEvent
|
|
{
|
|
public:
|
|
wxListbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
|
|
int nSel = -1, int nOldSel = -1);
|
|
};
|
|
|
|
|
|
%constant wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED;
|
|
%constant wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING;
|
|
|
|
%pythoncode {
|
|
EVT_LISTBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, 1 )
|
|
EVT_LISTBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, 1 )
|
|
}
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
%newgroup;
|
|
|
|
|
|
class wxBookCtrlSizer: public wxSizer
|
|
{
|
|
public:
|
|
%pythonAppend wxBookCtrlSizer "self._setOORInfo(self)"
|
|
|
|
wxBookCtrlSizer( wxBookCtrl *nb );
|
|
|
|
void RecalcSizes();
|
|
wxSize CalcMin();
|
|
wxBookCtrl *GetControl();
|
|
};
|
|
|
|
|
|
class wxNotebookSizer: public wxSizer {
|
|
public:
|
|
%pythonAppend wxNotebookSizer "self._setOORInfo(self)"
|
|
|
|
wxNotebookSizer( wxNotebook *nb );
|
|
|
|
void RecalcSizes();
|
|
wxSize CalcMin();
|
|
wxNotebook *GetNotebook();
|
|
};
|
|
|
|
//---------------------------------------------------------------------------
|