AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added docstrings

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25959 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn 2004-02-26 19:38:21 +00:00
parent d7466b1d18
commit 0facd0e524
2 changed files with 1264 additions and 329 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
wxPython/src/_dataobj.i
View File

@ -48,13 +48,52 @@ enum wxDataFormatId
};
DocStr(wxDataFormat,
"A wx.DataFormat is an encapsulation of a platform-specific format
handle which is used by the system for the clipboard and drag and
drop operations. The applications are usually only interested in,
for example, pasting data from the clipboard only if the data is
in a format the program understands. A data format is is used to
uniquely identify this format.
On the system level, a data format is usually just a number
(CLIPFORMAT under Windows or Atom under X11, for example).");
// The standard format IDs are
// wx.DF_INVALID An invalid format
// wx.DF_TEXT Text format
// wx.DF_BITMAP A bitmap (wx.Bitmap)
// wx.DF_METAFILE A metafile (wx.Metafile, Windows only)
// wx.DF_FILENAME A list of filenames
// wx.DF_HTML An HTML string. This is only valid on Windows and non-unicode builds
// Aside the standard formats, the application may also use
// custom formats which are identified by their names (strings)
// and not numeric identifiers. Although internally custom format
// must be created (or registered) first, you shouldn\'t care
// about it because it is done automatically the first time the
// wxDataFormat object corresponding to a given format name is
// created.
// ");
class wxDataFormat {
public:
wxDataFormat( wxDataFormatId type );
%name(CustomDataFormat) wxDataFormat(const wxString& format);
DocCtorStr(
wxDataFormat( wxDataFormatId type ),
"Constructs a data format object for one of the standard data\n"
"formats or an empty data object (use SetType or SetId later in\n"
"this case)");
DocCtorStrName(
wxDataFormat(const wxString& format),
"Constructs a data format object for a custom format identified by its name.",
CustomDataFormat);
~wxDataFormat();
%nokwargs operator==;
%nokwargs operator!=;
bool operator==(wxDataFormatId format) const;
@ -62,11 +101,23 @@ public:
bool operator==(const wxDataFormat& format) const;
bool operator!=(const wxDataFormat& format) const;
void SetType(wxDataFormatId format);
wxDataFormatId GetType() const;
DocDeclStr(
void , SetType(wxDataFormatId format),
"Sets the format to the given value, which should be one of wx.DF_XXX constants.");
DocDeclStr(
wxDataFormatId , GetType() const,
"Returns the platform-specific number identifying the format.");
wxString GetId() const;
void SetId(const wxString& format);
DocDeclStr(
wxString , GetId() const,
"Returns the name of a custom format (this function will fail for a standard format).");
DocDeclStr(
void , SetId(const wxString& format),
"Sets the format to be the custom format identified by the given name.");
};

1530
wxPython/src/_window.i
View File

File diff suppressed because it is too large Load Diff