//----------------------------------------------------------------------
+
+// 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.
class wxControl : public wxWindow {
public:
+
+ //
wxControl(wxWindow *parent,
wxWindowID id,
const wxPoint& pos=wxDefaultPosition,
long style=0,
const wxValidator& validator=wxDefaultValidator,
const char* name="control");
+
+ //
%name(wxPreControl)wxControl();
+ //
bool Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos=wxDefaultPosition,
%pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
%pragma(python) addtomethod = "wxPreControl:val._setOORInfo(val)"
+ // Simulates the effect of the user issuing a command to the item. See
+ // wxCommandEvent.
void Command(wxCommandEvent& event);
+
+ // Return a control's text.
wxString GetLabel();
+
+ // Sets the item's text.
void SetLabel(const wxString& label);
};
public:
// void Clear(); ambiguous, redefine below...
+
+ // Deletes an item from the control
void Delete(int n);
+ // Returns the number of items in the control.
int GetCount();
%pragma(python) addtoclass = "Number = GetCount"
+
+ // Returns the string at the given position.
wxString GetString(int n);
+
+ // Sets the string value of an item.
void SetString(int n, const wxString& s);
+
+ // Finds an item matching the given string. Returns the zero-based
+ // position of the item, or -1 if the string was not found.
int FindString(const wxString& s);
+ // Select the item at postion n.
void Select(int n);
+
+ // Gets the position of the selected item.
int GetSelection();
+ // Gets the current selection as a string.
wxString GetStringSelection() const;
// void Append(const wxString& item);
// void Append(const wxString& item, char* clientData);
// char* GetClientData(const int n);
// void SetClientData(const int n, char* data);
+
+
%addmethods {
+ // Adds the item to the control, associating the given data with the
+ // item if not None.
void Append(const wxString& item, PyObject* clientData=NULL) {
if (clientData) {
wxPyClientData* data = new wxPyClientData(clientData);
self->Append(item);
}
+ // Returns the client data associated with the given item, (if any.)
PyObject* GetClientData(int n) {
wxPyClientData* data = (wxPyClientData*)self->GetClientObject(n);
if (data) {
}
}
+ // Associate the given client data with the item at position n.
void SetClientData(int n, PyObject* clientData) {
wxPyClientData* data = new wxPyClientData(clientData);
self->SetClientObject(n, data);
}
};
+
//----------------------------------------------------------------------
+// A button is a control that contains a text string, and is one of the most
+// common elements of a GUI. It may be placed on a dialog box or panel, or
+// indeed almost any other window.
+//
+// Styles
+// wxBU_LEFT: Left-justifies the label. WIN32 only.
+// wxBU_TOP: Aligns the label to the top of the button. WIN32 only.
+// wxBU_RIGHT: Right-justifies the bitmap label. WIN32 only.
+// wxBU_BOTTOM: Aligns the label to the bottom of the button. WIN32 only.
+// wxBU_EXACTFIT: Creates the button as small as possible instead of making
+// it of the standard size (which is the default behaviour.)
+//
+// Events
+// EVT_BUTTON(win,id,func):
+// Sent when the button is clicked.
+//
class wxButton : public wxControl {
public:
+ // Constructor, creating and showing a button.
+ //
+ // parent: Parent window. Must not be None.
+ // id: Button identifier. A value of -1 indicates a default value.
+ // label: The text to be displayed on the button.
+ // pos: The button position on it's parent.
+ // size: Button size. If the default size (-1, -1) is specified then the
+ // button is sized appropriately for the text.
+ // style: Window style. See wxButton.
+ // validator: Window validator.
+ // name: Window name.
wxButton(wxWindow* parent, wxWindowID id, const wxString& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
char* name = "button");
+
+ // Default constructor
%name(wxPreButton)wxButton();
+ // Button creation function for two-step creation.
bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
%pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
%pragma(python) addtomethod = "wxPreButton:val._setOORInfo(val)"
+ // This sets the button to be the default item for the panel or dialog box.
+ //
+ // Under Windows, only dialog box buttons respond to this function. As
+ // normal under Windows and Motif, pressing return causes the default
+ // button to be depressed when the return key is pressed. See also
+ // wxWindow.SetFocus which sets the keyboard focus for windows and text
+ // panel items, and wxPanel.SetDefaultItem.
void SetDefault();
+
+ //
void SetBackgroundColour(const wxColour& colour);
+ //
void SetForegroundColour(const wxColour& colour);
+
#ifdef __WXMSW__
+ // show the image in the button in addition to the label
void SetImageLabel(const wxBitmap& bitmap);
+
+ // set the margins around the image
void SetImageMargins(wxCoord x, wxCoord y);
#endif
+
+ // returns the default button size for this platform
static wxSize GetDefaultSize();
};
%pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
%pragma(python) addtomethod = "wxPreBitmapButton:val._setOORInfo(val)"
- wxBitmap& GetBitmapLabel();
- wxBitmap& GetBitmapDisabled();
- wxBitmap& GetBitmapFocus();
- wxBitmap& GetBitmapSelected();
+ wxBitmap GetBitmapLabel();
+ wxBitmap GetBitmapDisabled();
+ wxBitmap GetBitmapFocus();
+ wxBitmap GetBitmapSelected();
void SetBitmapDisabled(const wxBitmap& bitmap);
void SetBitmapFocus(const wxBitmap& bitmap);
void SetBitmapSelected(const wxBitmap& bitmap);
//----------------------------------------------------------------------
+// wxGTK's wxComboBox doesn't derive from wxChoice like wxMSW, or
+// even wxControlWithItems, so we have to duplicate the methods
+// here... <blech!>
+
+#ifdef __WXGTK__
+class wxComboBox : public wxControl
+{
+public:
+ wxComboBox(wxWindow* parent, wxWindowID id, char* value = "",
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ int LCOUNT=0, wxString* choices=NULL,
+ long style = 0,
+ const wxValidator& validator = wxDefaultValidator,
+ char* name = "comboBox");
+ %name(wxPreComboBox)wxComboBox();
+
+ bool Create(wxWindow* parent, wxWindowID id, char* value = "",
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ int LCOUNT=0, wxString* choices=NULL,
+ long style = 0,
+ const wxValidator& validator = wxDefaultValidator,
+ char* name = "comboBox");
+
+ %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+ %pragma(python) addtomethod = "wxPreComboBox:val._setOORInfo(val)"
+
+ void Copy();
+ void Cut();
+ long GetInsertionPoint();
+ long GetLastPosition();
+ wxString GetValue();
+ void Paste();
+ void Replace(long from, long to, const wxString& text);
+ void Remove(long from, long to);
+ void SetInsertionPoint(long pos);
+ void SetInsertionPointEnd();
+ void SetSelection(int n);
+ %name(SetMark)void SetSelection(long from, long to);
+ void SetValue(const wxString& text);
+ void SetEditable(bool editable);
+
+
+ void Clear();
+ void Delete(int n);
+
+ int GetCount();
+ %pragma(python) addtoclass = "Number = GetCount"
+ wxString GetString(int n);
+ int FindString(const wxString& s);
+
+ //void SetString(int n, const wxString& s); *** No equivalent for wxGTK!!!
+
+ // void Select(int n);
+ %pragma(python) addtoclass = "Select = SetSelection"
+
+ int GetSelection();
+ wxString GetStringSelection() const;
+
+ // void Append(const wxString& item);
+ // void Append(const wxString& item, char* clientData);
+ // char* GetClientData(const int n);
+ // void SetClientData(const int n, char* data);
+ %addmethods {
+ void Append(const wxString& item, PyObject* clientData=NULL) {
+ if (clientData) {
+ wxPyClientData* data = new wxPyClientData(clientData);
+ self->Append(item, data);
+ } else
+ self->Append(item);
+ }
+
+ PyObject* GetClientData(int n) {
+ wxPyClientData* data = (wxPyClientData*)self->GetClientObject(n);
+ if (data) {
+ Py_INCREF(data->m_obj);
+ return data->m_obj;
+ } else {
+ Py_INCREF(Py_None);
+ return Py_None;
+ }
+ }
+
+ void SetClientData(int n, PyObject* clientData) {
+ wxPyClientData* data = new wxPyClientData(clientData);
+ self->SetClientObject(n, data);
+ }
+ }
+
+};
+
+
+
+#else // For all but wxGTK
+
+
class wxComboBox : public wxChoice {
public:
wxComboBox(wxWindow* parent, wxWindowID id, char* value = "",
void SetValue(const wxString& text);
void SetEditable(bool editable);
};
+#endif
+
//----------------------------------------------------------------------
bool HasBackgroundColour() const;
bool HasFont() const;
- const wxColour& GetTextColour() const;
- const wxColour& GetBackgroundColour() const;
- const wxFont& GetFont() const;
+ wxColour GetTextColour() const;
+ wxColour GetBackgroundColour() const;
+ wxFont GetFont() const;
+
+ // returns false if we have any attributes set, true otherwise
+ bool IsDefault();
+
+ // return the attribute having the valid font and colours: it uses the
+ // attributes set in attr and falls back first to attrDefault and then to
+ // the text control font/colours for those attributes which are not set
+ static wxTextAttr Combine(const wxTextAttr& attr,
+ const wxTextAttr& attrDef,
+ const wxTextCtrl *text);
};
%pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
%pragma(python) addtomethod = "wxPreTextCtrl:val._setOORInfo(val)"
+
+ wxString GetValue() const;
+ void SetValue(const wxString& value);
+
+ int GetLineLength(long lineNo) const;
+ wxString GetLineText(long lineNo) const;
+ int GetNumberOfLines() const;
+
+ bool IsModified() const;
+ bool IsEditable() const;
+
+ // If the return values from and to are the same, there is no selection.
+ void GetSelection(long* OUTPUT, long* OUTPUT) const;
+ wxString GetStringSelection();
+
void Clear();
- void Copy();
- void Cut();
- void DiscardEdits();
- long GetInsertionPoint();
- long GetLastPosition();
- int GetLineLength(long lineNo);
- wxString GetLineText(long lineNo);
- int GetNumberOfLines();
- wxString GetValue();
- bool IsModified();
- bool LoadFile(const wxString& filename);
- void Paste();
- void PositionToXY(long pos, long *OUTPUT, long *OUTPUT);
- void Remove(long from, long to);
void Replace(long from, long to, const wxString& value);
- bool SaveFile(const wxString& filename);
- void SetEditable(bool editable);
- void SetInsertionPoint(long pos);
- void SetInsertionPointEnd();
- void SetSelection(long from, long to);
- void SetValue(const wxString& value);
- void ShowPosition(long pos);
+ void Remove(long from, long to);
+
+ // load/save the controls contents from/to the file
+ bool LoadFile(const wxString& file);
+ bool SaveFile(const wxString& file = wxEmptyString);
+
+ // clears the dirty flag
+ void DiscardEdits();
+
+ // set the max number of characters which may be entered in a single line
+ // text control
+ void SetMaxLength(unsigned long len);
+
+ // writing text inserts it at the current position, appending always
+ // inserts it at the end
void WriteText(const wxString& text);
void AppendText(const wxString& text);
- long XYToPosition(long x, long y);
-
- bool CanCopy();
- bool CanCut();
- bool CanPaste();
- bool CanRedo();
- bool CanUndo();
- void GetSelection(long* OUTPUT, long* OUTPUT);
- bool IsEditable();
- void Undo();
- void Redo();
+ // 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
bool SetStyle(long start, long end, const wxTextAttr& style);
bool SetDefaultStyle(const wxTextAttr& style);
const wxTextAttr& GetDefaultStyle() const;
- void SetMaxLength(unsigned long len);
+ // 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.
+ long XYToPosition(long x, long y) const;
+ bool PositionToXY(long pos, long *OUTPUT, long *OUTPUT) const;
+
+ void ShowPosition(long pos);
+
+ // Clipboard operations
+ void Copy();
+ void Cut();
+ void Paste();
+
+ bool CanCopy() const;
+ bool CanCut() const;
+ bool CanPaste() const;
+
+ // Undo/redo
+ void Undo();
+ void Redo();
+
+ bool CanUndo() const;
+ bool CanRedo() const;
+
+ // Insertion point
+ void SetInsertionPoint(long pos);
+ void SetInsertionPointEnd();
+ long GetInsertionPoint() const;
+ long GetLastPosition() const;
+
+ void SetSelection(long from, long to);
+ void SelectAll();
+ void SetEditable(bool editable);
%addmethods {
void write(const wxString& text) {
self->AppendText(text);
}
}
+
+ // TODO: replace this when the method is really added to wxTextCtrl
+ %addmethods {
+ wxString GetString(long from, long to) {
+ return self->GetValue().Mid(from, to-from);
+ }
+ }
};
//----------------------------------------------------------------------
int GetThumbPosition();
int GetThumbSize();
%name(GetThumbLength) int GetThumbSize(); // to match the docs
+
+ bool IsVertical();
+
void SetThumbPosition(int viewStart);
void SetScrollbar(int position, int thumbSize,
int range, int pageSize,
%pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
%pragma(python) addtomethod = "wxPreStaticBitmap:val._setOORInfo(val)"
- const wxBitmap& GetBitmap();
+ wxBitmap GetBitmap();
void SetBitmap(const wxBitmap& bitmap);
void SetIcon(const wxIcon& icon);
};
projects / wxWidgets.git / blobdiff