Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More docstrings and rearrainged a couple things.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@24664 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2003-11-26 06:09:56 +00:00
parent 8feaa81f86
commit 1e0c87227c
24 changed files with 958 additions and 701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
wxPython/src/_button.i
View File

@@ -33,22 +33,25 @@ enum {
//---------------------------------------------------------------------------
// 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.
//
DocStr(wxButton,
"A button is a control that contains a text string, and is one of the most\n"
"common elements of a GUI. It may be placed on a dialog box or panel, or\n"
"indeed almost any other window.");
RefDoc(wxButton, "
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:
@@ -56,17 +59,7 @@ public:
%addtofunc wxButton() ""
// 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.
DocStr(wxButton, "Create and show a button.")
wxButton(wxWindow* parent, wxWindowID id, const wxString& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
@@ -74,10 +67,10 @@ public:
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyButtonNameStr);
// Default constructor
DocStr(wxButton(), "Precreate a Button for 2-phase creation.");
%name(PreButton)wxButton();
// Button creation function for two-step creation.
DocStr(Create, "Acutally create the GUI Button for 2-phase creation.");
bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
@@ -86,13 +79,7 @@ public:
const wxString& name = wxPyButtonNameStr);
// 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.
DocStr(SetDefault, "This sets the button to be the default item for the panel or dialog box.");
void SetDefault();
@@ -104,7 +91,7 @@ public:
void SetImageMargins(wxCoord x, wxCoord y);
#endif
// returns the default button size for this platform
DocStr(GetDefaultButtonSize, "Returns the default button size for this platform.");
static wxSize GetDefaultSize();
};
@@ -112,34 +99,58 @@ public:
//---------------------------------------------------------------------------
DocStr(wxBitmapButton, "A Buttont that contains a bitmap.");
class wxBitmapButton : public wxButton
{
public:
%addtofunc wxBitmapButton "self._setOORInfo(self)"
%addtofunc wxBitmapButton() ""
DocStr(wxBitmapButton, "Create and show a button.")
wxBitmapButton(wxWindow* parent, wxWindowID id, const wxBitmap& bitmap,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxBU_AUTODRAW,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyButtonNameStr);
DocStr(wxBitmapButton(), "Precreate a BitmapButton for 2-phase creation.");
%name(PreBitmapButton)wxBitmapButton();
DocStr(Create, "Acutally create the GUI BitmapButton for 2-phase creation.");
bool Create(wxWindow* parent, wxWindowID id, const wxBitmap& bitmap,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxBU_AUTODRAW,
const wxValidator& validator = wxDefaultValidator,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxBU_AUTODRAW,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyButtonNameStr);
DocStr(GetBitmapLabel, "Returns the label bitmap (the one passed to the constructor).");
wxBitmap GetBitmapLabel();
DocStr(GetBitmapDisabled, "Returns the bitmap for the disabled state.");
wxBitmap GetBitmapDisabled();
DocStr(GetBitmapFocus, "Returns the bitmap for the focused state.");
wxBitmap GetBitmapFocus();
DocStr(GetBitmapSelected, "Returns the bitmap for the selected state.");
wxBitmap GetBitmapSelected();
DocStr(SetBitmapDisabled, "Sets the bitmap for the disabled button appearance.");
void SetBitmapDisabled(const wxBitmap& bitmap);
DocStr(SetBitmapFocus, "Sets the bitmap for the button appearance when it has the keyboard focus.");
void SetBitmapFocus(const wxBitmap& bitmap);
DocStr(SetBitmapSelected, "Sets the bitmap for the selected (depressed) button appearance.");
void SetBitmapSelected(const wxBitmap& bitmap);
DocStr(SetBitmapLabel,
"Sets the bitmap label for the button. This is the bitmap used for the\n"
"unselected state, and for all other states if no other bitmaps are provided.");
void SetBitmapLabel(const wxBitmap& bitmap);
void SetMargins(int x, int y);