python-wxgtk3.0-dev 3.0.2.0+dfsg-7 / usr / include / wx-3.0 / wx / wxPython / i_files / _control.i

/////////////////////////////////////////////////////////////////////////////
// Name:        _control.i
// Purpose:     SWIG interface defs for wxControl and other base classes
//
// Author:      Robin Dunn
//
// Created:     10-June-1998
// RCS-ID:      $Id$
// Copyright:   (c) 2003 by Total Control Software
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

// Not a %module


//---------------------------------------------------------------------------

MAKE_CONST_WXSTRING(ControlNameStr);

//---------------------------------------------------------------------------
%newgroup;


enum wxEllipsizeFlags
{
    wxELLIPSIZE_FLAGS_NONE,
    wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS,
    wxELLIPSIZE_FLAGS_EXPAND_TABS,
    wxELLIPSIZE_FLAGS_DEFAULT,
};

enum wxEllipsizeMode
{
    wxELLIPSIZE_NONE,
    wxELLIPSIZE_START,
    wxELLIPSIZE_MIDDLE,
    wxELLIPSIZE_END
};



DocStr(wxControl,
"This is the base class for a control or 'widget'.

A control is generally a small window which processes user input
and/or displays one or more item of data.", "");

MustHaveApp(wxControl);

class wxControl : public wxWindow
{
public:
    %pythonAppend wxControl         "self._setOORInfo(self)"
    %pythonAppend wxControl()       ""
    %typemap(out) wxControl*;    // turn off this typemap

    DocCtorStr(
        wxControl(wxWindow *parent,
                  wxWindowID id=-1,
                  const wxPoint& pos=wxDefaultPosition,
                  const wxSize& size=wxDefaultSize,
                  long style=0,
                  const wxValidator& validator=wxDefaultValidator,
                  const wxString& name=wxPyControlNameStr),
        "Create a Control.  Normally you should only call this from a subclass'
__init__ as a plain old wx.Control is not very useful.", "");

    DocCtorStrName(
        wxControl(),
        "Precreate a Control control for 2-phase creation", "",
        PreControl);

    // Turn it back on again
    %typemap(out) wxControl* { $result = wxPyMake_wxObject($1, $owner); }


    DocDeclStr(
        bool , Create(wxWindow *parent,
                      wxWindowID id=-1,
                      const wxPoint& pos=wxDefaultPosition,
                      const wxSize& size=wxDefaultSize,
                      long style=0,
                      const wxValidator& validator=wxDefaultValidator,
                      const wxString& name=wxPyControlNameStr),
        "Do the 2nd phase and create the GUI control.", "");
    

    DocDeclStr(
        int , GetAlignment() const,
        "Get the control alignment (left/right/centre, top/bottom/centre)", "");


    DocDeclStr(
        wxString , GetLabelText() const,
        "Get just the text of the label, without mnemonic characters ('&')", "");
    
    DocDeclStr(
        void , SetLabelText(const wxString& text),
        "", "");
    

    
    // Set the label with markup (and mnemonics). Markup is a simple subset of
    // HTML with tags such as <b>, <i> and <span>. By default it is not
    // supported i.e. all the markup is simply stripped and SetLabel() is
    // called but some controls in some ports do support this already and in
    // the future most of them should.
    //
    // Notice that, being HTML-like, markup also supports XML entities so '<'
    // should be encoded as "&lt;" and so on, a bare '<' in the input will
    // likely result in an error. As an exception, a bare '&' is allowed and
    // indicates that the next character is a mnemonic. To insert a literal '&'
    // in the control you need to use "&amp;" in the input string.
    //
    // Returns true if the label was set, even if the markup in it was ignored.
    // False is only returned if we failed to parse the label.
    bool SetLabelMarkup(const wxString& markup);
   
    
    DocDeclStr(
        void , Command(wxCommandEvent& event),
        "Simulates the effect of the user issuing a command to the item.

:see: `wx.CommandEvent`
", "");
   

//     DocDeclStr(
//         bool , GetAdjustMinSizeFlag(),
//         "Returns whether the minsize should be adjusted for this control when
// `SetLabel` or `SetFont` are called.", "");
    
//     DocDeclStr(
//         void , SetAdjustMinSizeFlag(bool adjust),
//         "By default controls will readjust their size and minsize when
// `SetLabel` or `SetFont` are called.  This flag will allow you to
// control this behavior.", "

// :see: `GetAdjustMinSizeFlag`
// ");

 
    DocDeclStr(
        static wxString , RemoveMnemonics(const wxString& str),
        "removes the mnemonics characters", "");


    DocDeclStr(
        static wxString , EscapeMnemonics(const wxString& str),
        "escapes (by doubling them) the mnemonics", "");
    

    DocDeclStr(
        static int , FindAccelIndex(const wxString& label), 
        "Return the accel index in the string or -1 if none.", "");


    
    // replaces parts of the (multiline) string with ellipsis if needed
    static wxString Ellipsize(const wxString& label, const wxDC& dc,
                              wxEllipsizeMode mode, int maxWidth,
                              int flags = wxELLIPSIZE_FLAGS_DEFAULT);


    // this is a helper for the derived class GetClassDefaultAttributes()
    // implementation: it returns the right colours for the classes which
    // contain something else (e.g. wxListBox, wxTextCtrl, ...) instead of
    // being simple controls (such as wxButton, wxCheckBox, ...)
    static wxVisualAttributes
        GetCompositeControlsDefaultAttributes(wxWindowVariant variant);

         
    static wxVisualAttributes
    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

    %property(Alignment, GetAlignment, doc="See `GetAlignment`");
    %property(LabelText, GetLabelText, SetLabelText, doc="See `GetLabelText`");

};


//---------------------------------------------------------------------------
%newgroup;




DocStr(wxItemContainer,
"The wx.ItemContainer class defines an interface which is implemented
by all controls which have string subitems, each of which may be
selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
as `wx.ComboBox` which implements an extended interface deriving from
this one.

It defines the methods for accessing the control's items and although
each of the derived classes implements them differently, they still
all conform to the same interface.

The items in a wx.ItemContainer have (non empty) string labels and,
optionally, client data associated with them.
", "");

class wxItemContainer
{
public:
    // wxItemContainer()  ** It's an ABC
    

    %extend {
        DocStr(Append,
               "Adds the item to the control, associating the given data with the item
if not None.  The return value is the index of the newly added item
which may be different from the last one if the control is sorted (e.g.
has wx.LB_SORT or wx.CB_SORT style).", "");
        int Append(const wxString& item, PyObject* clientData=NULL) {
            if (clientData) {
                wxPyClientData* data = new wxPyClientData(clientData);
                return self->Append(item, data);
            } else
                return self->Append(item);
        }
    }
    
    DocDeclAStrName(
        void , Append(const wxArrayString& strings),
        "AppendItems(self, List strings)",
        "Apend several items at once to the control.  Notice that calling this
method may be much faster than appending the items one by one if you
need to add a lot of items.", "",
        AppendItems);

    
    %extend {
        DocStr(Insert,
               "Insert an item into the control before the item at the ``pos`` index,
optionally associating some data object with the item.", "");
        int Insert(const wxString& item, /*unsigned*/ int pos, PyObject* clientData=NULL) {
            if (clientData) {
                wxPyClientData* data = new wxPyClientData(clientData);
                return self->Insert(item, pos, data);
            } else
                return self->Insert(item, pos);
        }
    }

    
    DocDeclAStrName(
        int , Insert(const wxArrayString& items, /*unsigned*/ int pos),
        "InsertItems(self, List strings, int pos) --> int",
        "Inserts several items at once into the control.  Returns the index of
the last item inserted.", "",
        InsertItems);

    
    DocDeclAStr(
        void , Set(const wxArrayString& items),
        "Set(self, List strings)",
        "Replace all the items in the control", "");
    
    
    
    DocDeclStr(
        virtual void , Clear(),
        "Removes all items from the control.", "");

    
    DocDeclStr(
        virtual void , Delete(/*unsigned*/ int n),
        "Deletes the item at the zero-based index 'n' from the control. Note
that it is an error (signalled by a `wx.PyAssertionError` exception if
enabled) to remove an item with the index negative or greater or equal
than the number of items in the control.", "");
    


     %extend {
        DocStr(GetClientData,
               "Returns the client data associated with the given item, (if any.)", "");
        PyObject* GetClientData(/*unsigned*/ int n) {
            wxPyClientData* data = (wxPyClientData*)self->GetClientObject(n);
            return wxPyClientData::SafeGetData(data);
        }

        DocStr(SetClientData,
               "Associate the given client data with the item at position n.", "");
        void SetClientData(/*unsigned*/ int n, PyObject* clientData) {
            wxPyClientData* data = new wxPyClientData(clientData);
            self->SetClientObject(n, data);
        }
    }

    // TODO?     wxClientData* DetachClientObject(unsigned int n);


    DocDeclStr(
        bool , HasClientData() const,
        "", "");
    
    
    
    DocDeclStr(
        virtual /*unsigned*/ int , GetCount() const,
        "Returns the number of items in the control.", "");
    
    DocDeclStr(
        bool , IsEmpty() const,
        "Returns True if the control is empty or False if it has some items.", "");
    
    DocDeclStr(
        virtual wxString , GetString(/*unsigned*/ int n) const,
        "Returns the label of the item with the given index.", "");
    
    DocDeclStr(
        wxArrayString , GetStrings() const,
        "", "");

    
    DocDeclStr(
        bool , IsSorted() const,
        "", "");
    
    DocDeclStr(
        virtual void , SetString(/*unsigned*/ int n, const wxString& s),
        "Sets the label for the given item.", "");
    
    DocDeclStr(
        virtual int , FindString(const wxString& s) const,
        "Finds an item whose label matches the given string.  Returns the
zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
found.", "");
    

    DocDeclStr(
        virtual void , SetSelection(int n),
        "Sets the item at index 'n' to be the selected item.", "");
    
    DocDeclStr(
        virtual int , GetSelection() const,
        "Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
is selected.", "");
    

    bool SetStringSelection(const wxString& s);

    DocDeclStr(
        wxString , GetStringSelection() const,
        "Returns the label of the selected item or an empty string if no item
is selected.", "");
    

    DocDeclStr(
        void , Select(int n),
        "This is the same as `SetSelection` and exists only because it is
slightly more natural for controls which support multiple selection.", "");
    

    %pythoncode {
        def GetItems(self):
            """Return a list of the strings in the control"""
            return [self.GetString(i) for i in xrange(self.GetCount())]
            
        def SetItems(self, items):
            """Clear and set the strings in the control from a list"""
            self.Clear()
            self.AppendItems(items)
    }

    %property(Count, GetCount, doc="See `GetCount`");
    %property(Items, GetItems, SetItems, doc="See `GetItems` and `SetItems`");
    %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
    %property(StringSelection, GetStringSelection, SetStringSelection, doc="See `GetStringSelection` and `SetStringSelection`");
    %property(Strings, GetStrings, doc="See `GetStrings`");
    
};


//---------------------------------------------------------------------------
%newgroup;

DocStr(wxControlWithItems,
"wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
wx.Control class, and is used for the base class of various controls
that have items.", "");

class wxControlWithItems : public wxControl, public wxItemContainer
{
public:
};

//---------------------------------------------------------------------------
%newgroup;


enum wxTextCtrlHitTestResult
{
    wxTE_HT_UNKNOWN = -2,   // this means HitTest() is simply not implemented
    wxTE_HT_BEFORE,         // either to the left or upper
    wxTE_HT_ON_TEXT,        // directly on
    wxTE_HT_BELOW,          // below [the last line]
    wxTE_HT_BEYOND          // after [the end of line]
};



class wxTextEntryBase
{
public:
    // wxTextEntryBase() { m_eventsBlock = 0; }  ****  It's an ABC, can't instantiate
    virtual ~wxTextEntryBase();


    DocDeclStr(
        virtual void , SetValue(const wxString& value),
        "Set the value in the text entry field.  Generates a text change event.", "");
    
    DocDeclStr(
        virtual void , ChangeValue(const wxString& value),
        "Set the value in the text entry field.  Does not generate a text change event.", "");
    

    DocDeclStr(
        virtual void , WriteText(const wxString& text),
        "Insert text at the current insertion point in the text field,
replacing any text that is currently selected.", "");
    
    DocDeclStr(
        virtual void , AppendText(const wxString& text),
        "Add text to the end of the text field, without removing any existing
text.  Will reset the selection if any.", "");
    

    DocDeclStr(
        virtual wxString , GetValue(),
        "Returns the current value in the text field.", "");
    
    DocDeclStr(
        virtual wxString , GetRange(long from, long to) const,
        "Returns a subset of the value in the text field.", "");

    // Just for backwards compatibility
    %pythoncode { GetString = wx.deprecated(GetRange, "Use `GetRange` instead.") }
    
    DocDeclStr(
        bool , IsEmpty() const,
        "Returns True if the value in the text field is empty.", "");
    


    DocDeclStr(
        virtual void , Replace(long from, long to, const wxString& value),
        "Replaces the text between two positions with the given text.", "");
    
    DocDeclStr(
        virtual void , Remove(long from, long to),
        "Removes the text between two positions in the text field", "");
    
    DocDeclStr(
        virtual void , Clear(),
        "Clear all text from the text field", "");
    
    void RemoveSelection();


    // clipboard operations
    // --------------------

    DocDeclStr(
        virtual void , Copy(),
        "Copies the selected text to the clipboard.", "");
    
    DocDeclStr(
        virtual void , Cut(),
        "Copies the selected text to the clipboard and removes the selection.", "");
    
    DocDeclStr(
        virtual void , Paste(),
        "Pastes text from the clipboard to the text field.", "");
    

    DocDeclStr(
        virtual bool , CanCopy() const,
        "Returns True if the text field has a text selection to copy to the
clipboard.", "");
    
    DocDeclStr(
        virtual bool , CanCut() const,
        "Returns True if the text field is editable and there is a text
selection to copy to the clipboard.", "");
    
    DocDeclStr(
        virtual bool , CanPaste() const,
        "Returns True if the text field is editable and there is text on the
clipboard that can be pasted into the text field.", "");
    

    // undo/redo
    // ---------

    DocDeclStr(
        virtual void , Undo(),
        "Undoes the last edit in the text field", "");
    
    DocDeclStr(
        virtual void , Redo(),
        "Redoes the last undo in the text field", "");
    

    DocDeclStr(
        virtual bool , CanUndo() const,
        "Returns True if the text field is editable and the last edit can be
undone.", "");
    
    DocDeclStr(
        virtual bool , CanRedo() const,
        "Returns True if the text field is editable and the last undo can be
redone.", "");
    



    DocDeclStr(
        virtual void , SetInsertionPoint(long pos),
        "Sets the insertion point in the combobox text field.", "");
    
    DocDeclStr(
        virtual long , GetInsertionPoint() const,
        "Returns the insertion point for the combobox's text field.", "");
    

    DocDeclStr(
        virtual void , SetInsertionPointEnd(),
        "Move the insertion point to the end of the current value.", "");
    

    DocDeclStr(
        virtual long , GetLastPosition() const,
        "Returns the last position in the combobox text field.", "");



    DocDeclStr(
        virtual void , SetSelection(long from, long to),
        "Selects the text starting at the first position up to (but not
including) the character at the last position.  If both parameters are
-1 then all text in the control is selected.", "");
    
    DocDeclStr(
        virtual void , SelectAll(),
        "Select all text in the text field.", "");
    
    DocDeclStr(
        bool , HasSelection() const,
        "Returns True if there is a non-empty selection in the text field.", "");
    
    DocDeclStr(
        virtual wxString , GetStringSelection() const,
        "Returns the selected text.", "");
    

    DocDeclAStr(
        virtual void, GetSelection(long* OUTPUT, long* OUTPUT) const,
        "GetSelection() -> (from, to)",
        "If the return values from and to are the same, there is no selection.", "");

    %property(Selection, GetSelection)
    

    // auto-completion
    // ---------------

    // these functions allow to auto-complete the text already entered into the
    // control using either the given fixed list of strings, the paths from the
    // file system or, in the future, an arbitrary user-defined completer
    //
    // they all return true if completion was enabled or false on error (most
    // commonly meaning that this functionality is not available under the
    // current platform)

    bool AutoComplete(const wxArrayString& choices);
    bool AutoCompleteFileNames();
    bool AutoCompleteDirectories();

    // TODO
    // bool AutoComplete(wxTextCompleter *completer);


    // status
    // ------

    virtual bool IsEditable() const;
    virtual void SetEditable(bool editable);


    DocDeclStr(
        virtual void , SetMaxLength(long len),
        "Set the max number of characters which may be entered in a single line
text control.", "");
    

    virtual bool SetHint(const wxString& hint);
    virtual wxString GetHint() const;

    bool SetMargins(const wxPoint& pt);
    wxPoint GetMargins() const;


    %property(InsertionPoint, GetInsertionPoint, SetInsertionPoint);
    %property(LastPosition, GetLastPosition);
    %property(Value, GetValue, SetValue);
    
};


class wxTextEntry : public wxTextEntryBase {};

    
DocStr(wxTextAreaBase,
"multiline text control specific methods","");           

class wxTextAreaBase
{
public:
//    wxTextAreaBase();  // ****   An ABC
    virtual ~wxTextAreaBase() ;

    // lines access
    // ------------

    virtual int GetLineLength(long lineNo) const;
    virtual wxString GetLineText(long lineNo) const;
    virtual int GetNumberOfLines() const;


    // file IO
    // -------

    bool LoadFile(const wxString& file, int fileType = wxTEXT_TYPE_ANY);
    bool SaveFile(const wxString& file = wxEmptyString,
                  int fileType = wxTEXT_TYPE_ANY);

    // dirty flag handling
    // -------------------

    virtual bool IsModified() const;
    virtual void MarkDirty();
    virtual void DiscardEdits();
    void SetModified(bool modified);


    // styles handling
    // ---------------

    // text control under some platforms supports the text styles: these
    // methods allow to apply the given text style to the given selection or to
    // set/get the style which will be used for all appended text
    virtual bool SetStyle(long start, long end, const wxTextAttr& style);
    virtual bool GetStyle(long position, wxTextAttr& style);
    virtual bool SetDefaultStyle(const wxTextAttr& style);
    virtual const wxTextAttr& GetDefaultStyle() const;


    // coordinates translation
    // -----------------------

    // translate between the position (which is just an index in the text ctrl
    // considering all its contents as a single strings) and (x, y) coordinates
    // which represent column and line.
    virtual long XYToPosition(long x, long y) const;
    DocDeclA(
        virtual /*bool*/ void, PositionToXY(long pos, long *OUTPUT, long *OUTPUT) const,
        "PositionToXY(long pos) -> (x, y)");

    // translate the given position (which is just an index in the text control)
    // to client coordinates
    wxPoint PositionToCoords(long pos) const;

    virtual void ShowPosition(long pos);

    DocDeclAStr(
        virtual wxTextCtrlHitTestResult, HitTest(const wxPoint& pt,
                                                 long* OUTPUT, long* OUTPUT) const,
        "HitTest(Point pt) -> (result, col, row)",
        "Find the row, col coresponding to the character at the point given in
pixels. NB: pt is in device coords but is not adjusted for the client
area origin nor scrolling.", "");


    DocDeclAStrName(
        virtual wxTextCtrlHitTestResult , HitTest(const wxPoint& pt, long *OUTPUT) const,
        "HitTestPos(Point pt) -> (result, position)",
        "Find the character position in the text coresponding to the point
given in pixels. NB: pt is in device coords but is not adjusted for
the client area origin nor scrolling. ", "",
        HitTestPos);


    %property(DefaultStyle, GetDefaultStyle, SetDefaultStyle);
    %property(NumberOfLines, GetNumberOfLines);
};


    
DocStr(wxTextCtrlIface,
"This class defines the wx.TextCtrl interface", "");
class  wxTextCtrlIface : public wxTextAreaBase,
                         public wxTextEntryBase
{
public:
    // wxTextCtrlIface();   ****  An ABC

};


DocStr(wxTextCtrlBase,
"An abstract base class for wx.TextCtrl.", "");
class wxTextCtrlBase : public wxControl,
                       public wxTextAreaBase,
                       public wxTextEntry
{
public:
    // wxTextCtrlBase();   ****  An ABC
};

                       

//---------------------------------------------------------------------------