From 1058f652031c9b99daa7c701f09f16c3af7159c1 Mon Sep 17 00:00:00 2001 From: Mattia Barbon Date: Sun, 18 Oct 2009 17:47:01 +0000 Subject: [PATCH] Copy wxPerl notes from the LaTeX documentation. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62451 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/accel.h | 7 ++++ interface/wx/bitmap.h | 8 +++++ interface/wx/caret.h | 14 ++++++++ interface/wx/checklst.h | 8 +++++ interface/wx/choicdlg.h | 34 ++++++++++++++++++ interface/wx/choice.h | 8 +++++ interface/wx/combobox.h | 8 +++++ interface/wx/config.h | 66 +++++++++++++++++++++++++++++++++++ interface/wx/cursor.h | 4 +++ interface/wx/dataobj.h | 15 ++++++++ interface/wx/dc.h | 74 ++++++++++++++++++++++++++++++++++++++++ interface/wx/docview.h | 40 ++++++++++++++++++++++ interface/wx/event.h | 27 +++++++++++++++ interface/wx/filesys.h | 2 +- interface/wx/frame.h | 4 +++ interface/wx/icon.h | 8 +++++ interface/wx/image.h | 4 +++ interface/wx/intl.h | 5 +++ interface/wx/listbox.h | 21 ++++++++++++ interface/wx/listctrl.h | 51 +++++++++++++++++++++++++++ interface/wx/menu.h | 10 ++++++ interface/wx/palette.h | 10 ++++++ interface/wx/print.h | 20 +++++++++++ interface/wx/process.h | 5 +++ interface/wx/radiobox.h | 8 +++++ interface/wx/scrolwin.h | 25 ++++++++++++++ interface/wx/statusbr.h | 14 ++++++++ interface/wx/textctrl.h | 10 ++++++ interface/wx/textentry.h | 5 +++ interface/wx/treebase.h | 7 ++++ interface/wx/treectrl.h | 38 +++++++++++++++++++++ interface/wx/utils.h | 20 +++++++++-- interface/wx/window.h | 30 ++++++++++++++++ 33 files changed, 606 insertions(+), 4 deletions(-) diff --git a/interface/wx/accel.h b/interface/wx/accel.h index bc67d5f3b2..0704a7a5d9 100644 --- a/interface/wx/accel.h +++ b/interface/wx/accel.h @@ -179,6 +179,13 @@ public: Number of accelerator entries. @param entries The array of entries. + + @beginWxPerlOnly + The wxPerl constructor accepts a list of either + Wx::AcceleratorEntry objects or references to 3-element arrays + [flags, keyCode, cmd] , like the parameters of + Wx::AcceleratorEntry::new. + @endWxPerlOnly */ wxAcceleratorTable(int n, const wxAcceleratorEntry entries[]); diff --git a/interface/wx/bitmap.h b/interface/wx/bitmap.h index 913d530e9e..6117072a03 100644 --- a/interface/wx/bitmap.h +++ b/interface/wx/bitmap.h @@ -260,6 +260,10 @@ public: @param depth Specifies the depth of the bitmap. If this is omitted, then a value of 1 (monochrome bitmap) is used. + + @beginWxPerlOnly + In wxPerl use Wx::Bitmap->newFromBits(bits, width, height, depth). + @endWxPerlOnly */ wxBitmap(const char bits[], int width, int height, int depth = 1); @@ -281,6 +285,10 @@ public: /** Creates a bitmap from XPM data. + + @beginWxPerlOnly + In wxPerl use Wx::Bitmap->newFromXPM(data). + @endWxPerlOnly */ wxBitmap(const char* const* bits); diff --git a/interface/wx/caret.h b/interface/wx/caret.h index b5d870635e..205543b7e8 100644 --- a/interface/wx/caret.h +++ b/interface/wx/caret.h @@ -60,6 +60,13 @@ public: //@{ /** Get the caret position (in pixels). + + @beginWxPerlOnly + In wxPerl there are two methods instead of a single overloaded + method: + - GetPosition(): returns a Wx::Point object. + - GetPositionXY(): returns a 2-element list (x, y). + @endWxPerlOnly */ void GetPosition(int* x, int* y) const; wxPoint GetPosition() const; @@ -68,6 +75,13 @@ public: //@{ /** Get the caret size. + + @beginWxPerlOnly + In wxPerl there are two methods instead of a single overloaded + method: + - GetSize(): returns a Wx::Size object. + - GetSizeWH(): returns a 2-element list (width, height). + @endWxPerlOnly */ void GetSize(int* width, int* height) const; wxSize GetSize() const; diff --git a/interface/wx/checklst.h b/interface/wx/checklst.h index 2ed407f031..62ee9e8a9f 100644 --- a/interface/wx/checklst.h +++ b/interface/wx/checklst.h @@ -62,6 +62,10 @@ public: Window validator. @param name Window name. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxCheckListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, @@ -91,6 +95,10 @@ public: Window validator. @param name Window name. + + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly */ wxCheckListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos, diff --git a/interface/wx/choicdlg.h b/interface/wx/choicdlg.h index 118f09048f..534564455d 100644 --- a/interface/wx/choicdlg.h +++ b/interface/wx/choicdlg.h @@ -60,6 +60,10 @@ public: strings. @endWxPythonOnly + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxMultiChoiceDialog(wxWindow* parent, const wxString& message, const wxString& caption, @@ -103,6 +107,10 @@ public: strings. @endWxPythonOnly + + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly */ wxMultiChoiceDialog(wxWindow* parent, const wxString& message, @@ -189,6 +197,10 @@ public: strings. @endWxPythonOnly + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxSingleChoiceDialog(wxWindow* parent, const wxString& message, const wxString& caption, @@ -237,6 +249,10 @@ public: strings. @endWxPythonOnly + + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly */ wxSingleChoiceDialog(wxWindow* parent, const wxString& message, @@ -287,6 +303,10 @@ public: selected string. If the user pressed cancel, -1 is returned. @header{wx/choicdlg.h} + + @beginWxPerlOnly + Use an array reference for the @a aChoices parameter. + @endWxPerlOnly */ int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption, @@ -328,6 +348,10 @@ int wxGetSingleChoiceIndex(const wxString& message, characters) is centred; if @false, the message is left-justified. @header{wx/choicdlg.h} + + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly */ wxString wxGetSingleChoice(const wxString& message, const wxString& caption, @@ -361,6 +385,10 @@ wxString wxGetSingleChoice(const wxString& message, of elements as @c choices or @c aChoices! @header{wx/choicdlg.h} + + @beginWxPerlOnly + Use an array reference for the @a aChoices and @a client_data parameters. + @endWxPerlOnly */ wxString wxGetSingleChoiceData(const wxString& message, const wxString& caption, @@ -405,6 +433,12 @@ wxString wxGetSingleChoiceData(const wxString& message, characters) is centred; if @false, the message is left-justified. @header{wx/choicdlg.h} + + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + In wxPerl there is no @a selections parameter; the function + returns an array containing the user selections. + @endWxPerlOnly */ int wxGetSelectedChoices(wxArrayInt& selections, const wxString& message, diff --git a/interface/wx/choice.h b/interface/wx/choice.h index 0d00b7db2d..975052193e 100644 --- a/interface/wx/choice.h +++ b/interface/wx/choice.h @@ -73,6 +73,10 @@ public: arguments to a single argument, which is a list of strings. @endWxPythonOnly + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxChoice( wxWindow *parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, @@ -111,6 +115,10 @@ public: arguments to a single argument, which is a list of strings. @endWxPythonOnly + + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly */ wxChoice( wxWindow *parent, wxWindowID id, const wxPoint& pos, diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h index b3ed47a41d..d8f8392bb1 100644 --- a/interface/wx/combobox.h +++ b/interface/wx/combobox.h @@ -117,6 +117,10 @@ public: arguments are to a single argument, which is a list of strings. @endWxPythonOnly + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly + @see Create(), wxValidator */ wxComboBox(wxWindow* parent, wxWindowID id, @@ -156,6 +160,10 @@ public: arguments are to a single argument, which is a list of strings. @endWxPythonOnly + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly + @see Create(), wxValidator */ wxComboBox(wxWindow* parent, wxWindowID id, diff --git a/interface/wx/config.h b/interface/wx/config.h index 5afaeeff33..258938bf09 100644 --- a/interface/wx/config.h +++ b/interface/wx/config.h @@ -374,6 +374,11 @@ public: The wxPython version of this method returns a 3-tuple consisting of the continue flag, the value string, and the index for the next call. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a 3-element + list (continue_flag, string, index_for_getnextentry). + @endWxPerlOnly */ virtual bool GetFirstEntry(wxString& str, long& index) const = 0; @@ -384,6 +389,11 @@ public: The wxPython version of this method returns a 3-tuple consisting of the continue flag, the value string, and the index for the next call. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a 3-element + list (continue_flag, string, index_for_getnextentry). + @endWxPerlOnly */ virtual bool GetFirstGroup(wxString& str, long& index) const = 0; @@ -394,6 +404,12 @@ public: The wxPython version of this method returns a 3-tuple consisting of the continue flag, the value string, and the index for the next call. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method only takes the @a index parameter and + returns a 3-element list (continue_flag, string, + index_for_getnextentry). + @endWxPerlOnly */ virtual bool GetNextEntry(wxString& str, long& index) const = 0; @@ -404,6 +420,12 @@ public: The wxPython version of this method returns a 3-tuple consisting of the continue flag, the value string, and the index for the next call. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method only takes the @a index parameter and + returns a 3-element list (continue_flag, string, + index_for_getnextentry). + @endWxPerlOnly */ virtual bool GetNextGroup(wxString& str, long& index) const = 0; @@ -496,6 +518,10 @@ public: /** Read a string from the key, returning @true if the value was read. If the key was not found, @a str is not changed. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ bool Read(const wxString& key, wxString* str) const; /** @@ -503,44 +529,84 @@ public: was not found. @return @true if value was really read, @false if the default was used. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ bool Read(const wxString& key, wxString* str, const wxString& defaultVal) const; /** Another version of Read(), returning the string value directly. + + @beginWxPerlOnly + In wxPerl, this can be called as: + - Read(key): returns the empty string if no key is found + - Read(key, default): returns the default value if no key is found + @endWxPerlOnly */ const wxString Read(const wxString& key, const wxString& defaultVal) const; /** Reads a long value, returning @true if the value was found. If the value was not found, @a l is not changed. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ bool Read(const wxString& key, long* l) const; /** Reads a long value, returning @true if the value was found. If the value was not found, @a defaultVal is used instead. + + @beginWxPerlOnly + In wxPerl, this can be called as: + - ReadInt(key): returns the 0 if no key is found + - ReadInt(key, default): returns the default value if no key is found + @endWxPerlOnly */ bool Read(const wxString& key, long* l, long defaultVal) const; /** Reads a double value, returning @true if the value was found. If the value was not found, @a d is not changed. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ bool Read(const wxString& key, double* d) const; /** Reads a double value, returning @true if the value was found. If the value was not found, @a defaultVal is used instead. + + @beginWxPerlOnly + In wxPerl, this can be called as: + - ReadFloat(key): returns the 0.0 if no key is found + - ReadFloat(key, default): returns the default value if no key is found + @endWxPerlOnly */ bool Read(const wxString& key, double* d, double defaultVal) const; /** Reads a bool value, returning @true if the value was found. If the value was not found, @a b is not changed. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ bool Read(const wxString& key, bool* b) const; /** Reads a bool value, returning @true if the value was found. If the value was not found, @a defaultVal is used instead. + + @beginWxPerlOnly + In wxPerl, this can be called as: + - ReadBool(key): returns false if no key is found + - ReadBool(key, default): returns the default value if no key is found + @endWxPerlOnly */ bool Read(const wxString& key, bool* d, bool defaultVal) const; diff --git a/interface/wx/cursor.h b/interface/wx/cursor.h index 7c778ab81e..194db591aa 100644 --- a/interface/wx/cursor.h +++ b/interface/wx/cursor.h @@ -111,6 +111,10 @@ public: Bits for a mask bitmap. @onlyfor{wxgtk,wxmotif} + + @beginWxPerlOnly + In wxPerl use Wx::Cursor->newData(bits, width, height, hotSpotX = -1, hotSpotY = -1, maskBits = 0). + @endWxPerlOnly */ wxCursor(const char bits[], int width, int height, int hotSpotX = -1, int hotSpotY = -1, diff --git a/interface/wx/dataobj.h b/interface/wx/dataobj.h index 6f3951a0d3..e26168c08b 100644 --- a/interface/wx/dataobj.h +++ b/interface/wx/dataobj.h @@ -67,12 +67,20 @@ public: /** Constructs a data format object for one of the standard data formats or an empty data object (use SetType() or SetId() later in this case). + + @beginWxPerlOnly + In wxPerl use Wx::Bitmap->newNative(format). + @endWxPerlOnly */ wxDataFormat(wxDataFormatId format = wxDF_INVALID); /** Constructs a data format object for a custom format identified by its name @a format. + + @beginWxPerlOnly + In wxPerl use Wx::Bitmap->newUser(format). + @endWxPerlOnly */ wxDataFormat(const wxString& format); @@ -245,6 +253,13 @@ public: Copies all formats supported in the given direction @a dir to the array pointed to by @a formats. There must be enough space for GetFormatCount(dir) formats in it. + + @beginWxPerlOnly + In wxPerl this method only takes the @a dir parameter. In scalar + context it returns the first format in the list, in list + context it returns a list containing all the supported + formats. + @endWxPerlOnly */ virtual void GetAllFormats(wxDataFormat* formats, Direction dir = Get) const = 0; diff --git a/interface/wx/dc.h b/interface/wx/dc.h index 4e75b0ee3e..131277e2bb 100644 --- a/interface/wx/dc.h +++ b/interface/wx/dc.h @@ -347,6 +347,10 @@ public: The wxPython version of this method accepts a Python list of wxPoint objects. @endWxPythonOnly + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void DrawLines(int n, wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0); @@ -359,6 +363,12 @@ public: The wxPython version of this method accepts a Python list of wxPoint objects. @endWxPythonOnly + + @beginWxPerlOnly + The wxPerl version of this method accepts + as its first parameter a reference to an array + of wxPoint objects. + @endWxPerlOnly */ void DrawLines(const wxPointList* points, wxCoord xoffset = 0, wxCoord yoffset = 0); @@ -379,6 +389,10 @@ public: The current pen is used for drawing the outline, and the current brush for filling the shape. Using a transparent brush suppresses filling. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void DrawPolygon(int n, wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0, @@ -400,6 +414,12 @@ public: The wxPython version of this method accepts a Python list of wxPoint objects. @endWxPythonOnly + + @beginWxPerlOnly + The wxPerl version of this method accepts + as its first parameter a reference to an array + of wxPoint objects. + @endWxPerlOnly */ void DrawPolygon(const wxPointList* points, wxCoord xoffset = 0, wxCoord yoffset = 0, @@ -480,16 +500,32 @@ public: The wxPython version of this method accepts a Python list of wxPoint objects. @endWxPythonOnly + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void DrawSpline(int n, wxPoint points[]); /** @overload + + + @beginWxPerlOnly + The wxPerl version of this method accepts + as its first parameter a reference to an array + of wxPoint objects. + @endWxPerlOnly */ void DrawSpline(const wxPointList* points); /** @overload + + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void DrawSpline(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2, wxCoord x3, wxCoord y3); @@ -669,6 +705,12 @@ public: @note This function works with both single-line and multi-line strings. + @beginWxPerlOnly + In wxPerl this method is implemented as + GetMultiLineTextExtent(string, font = undef) returning a + 3-element list (width, height, line_height) + @endWxPerlOnly + @see wxFont, SetFont(), GetPartialTextExtents(), GetTextExtent() */ void GetMultiLineTextExtent(const wxString& string, wxCoord* w, @@ -684,6 +726,10 @@ public: @note This function works with both single-line and multi-line strings. + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly + @see wxFont, SetFont(), GetPartialTextExtents(), GetTextExtent() */ wxSize GetMultiLineTextExtent(const wxString& string) const; @@ -701,6 +747,11 @@ public: of integers. @endWxPythonOnly + @beginWxPerlOnly + In wxPerl this method only takes the @a text parameter and + returns the widths as a list of integers. + @endWxPerlOnly + @see GetMultiLineTextExtent(), GetTextExtent() */ bool GetPartialTextExtents(const wxString& text, @@ -729,6 +780,12 @@ public: Returns a 4-tuple, (width, height, descent, externalLeading). @endWxPythonOnly + @beginWxPerlOnly + In wxPerl this method is implemented as GetTextExtent(string, + font = undef) returning a 4-element list (width, height, + descent, externalLeading) + @endWxPerlOnly + @see wxFont, SetFont(), GetPartialTextExtents(), GetMultiLineTextExtent() */ @@ -739,6 +796,11 @@ public: /** @overload + + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxSize GetTextExtent(const wxString& string) const; @@ -1203,6 +1265,13 @@ public: - GetSize() - Returns a wxSize. - GetSizeWH() - Returns a 2-tuple (width, height). @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl there are two methods instead of a single overloaded + method: + - GetSize(): returns a Wx::Size object. + - GetSizeWH(): returns a 2-element list (width, height). + @endWxPerlOnly */ void GetSize(wxCoord* width, wxCoord* height) const; @@ -1224,6 +1293,11 @@ public: /** Gets the current user scale factor. + @beginWxPerlOnly + In wxPerl this method takes no arguments and return a two + element array (x, y). + @endWxPerlOnly + @see SetUserScale() */ void GetUserScale(double* x, double* y) const; diff --git a/interface/wx/docview.h b/interface/wx/docview.h index 7996ea6afb..021af24e14 100644 --- a/interface/wx/docview.h +++ b/interface/wx/docview.h @@ -60,6 +60,28 @@ public: - wxTEMPLATE_INVISIBLE - The template may not be displayed to the user in dialogs. - wxDEFAULT_TEMPLATE_FLAGS - Defined as wxTEMPLATE_VISIBLE. + + @beginWxPerlOnly + + In wxPerl @a docClassInfo and @a viewClassInfo can be either + @c Wx::ClassInfo objects or strings containing the name of the + perl packages which are to be used as @c Wx::Document and + @c Wx::View classes (they must have a constructor named new); + as an example: + + - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext, + docTypeName, viewTypeName, docClassInfo, viewClassInfo, + flags): will construct document and view objects from the + class information. + - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext, + docTypeName, viewTypeName, docClassName, viewClassName, + flags): will construct document and view objects from perl + packages. + - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext, + docTypeName, viewTypeName): + in this case @c Wx::DocTemplate::CreateDocument() and + @c Wx::DocTemplate::CreateView() must be overridden + @endWxPerlOnly */ wxDocTemplate(wxDocManager* manager, const wxString& descr, const wxString& filter, const wxString& dir, @@ -578,6 +600,16 @@ public: choice list is popped up, followed by a file selector. This function is used in CreateDocument(). + + @beginWxPerlOnly + In wxPerl @a templates is a reference to a list of templates. + If you override this method in your document manager it must + return two values, eg: + + @code + (doctemplate, path) = My::DocManager->SelectDocumentPath(...); + @endcode + @endWxPerlOnly */ virtual wxDocTemplate* SelectDocumentPath(wxDocTemplate** templates, int noTemplates, wxString& path, @@ -597,6 +629,10 @@ public: parameter indicates whether the list of templates that the user will have to choose from is sorted or not when shown the choice box dialog. Default is @false. + + @beginWxPerlOnly + In wxPerl @a templates is a reference to a list of templates. + @endWxPerlOnly */ virtual wxDocTemplate* SelectDocumentType(wxDocTemplate** templates, int noTemplates, @@ -619,6 +655,10 @@ public: parameter indicates whether the list of templates that the user will have to choose from is sorted or not when shown the choice box dialog. Default is @false. + + @beginWxPerlOnly + In wxPerl @a templates is a reference to a list of templates. + @endWxPerlOnly */ virtual wxDocTemplate* SelectViewType(wxDocTemplate** templates, int noTemplates, bool sort = false); diff --git a/interface/wx/event.h b/interface/wx/event.h index f26740f421..cc24d5bcb4 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -645,6 +645,12 @@ public: when connecting an event generated by one object to a member function of a different object. If it is omitted, @c this is used. + @beginWxPerlOnly + In wxPerl this function takes 4 arguments: @a id, @a lastid, + @a type, @a method; if @a method is undef, the handler is + disconnected.} + @endWxPerlOnly + @see Bind<>() */ void Connect(int id, int lastId, wxEventType eventType, @@ -664,6 +670,10 @@ public: wxEVT_COMMAND_MENU_SELECTED, wxCommandEventHandler(MyFrame::OnQuit) ); @endcode + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void Connect(int id, wxEventType eventType, wxObjectEventFunction function, @@ -676,6 +686,10 @@ public: This overload will connect the given event handler so that regardless of the ID of the event source, the handler will be called. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void Connect(wxEventType eventType, wxObjectEventFunction function, @@ -699,6 +713,10 @@ public: Data associated with the event table entry. @param eventSink Object whose member function should be called. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ bool Disconnect(wxEventType eventType, wxObjectEventFunction function, @@ -710,6 +728,10 @@ public: overload for more info. This overload takes the additional @a id parameter. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ bool Disconnect(int id = wxID_ANY, wxEventType eventType = wxEVT_NULL, @@ -722,6 +744,11 @@ public: overload for more info. This overload takes an additional range of source IDs. + + @beginWxPerlOnly + In wxPerl this function takes 3 arguments: @a id, + @a lastid, @a type. + @endWxPerlOnly */ bool Disconnect(int id, int lastId, wxEventType eventType, diff --git a/interface/wx/filesys.h b/interface/wx/filesys.h index 6d3146db61..bc311541f5 100644 --- a/interface/wx/filesys.h +++ b/interface/wx/filesys.h @@ -331,7 +331,7 @@ public: @beginWxPerlOnly In wxPerl, you need to derive your file system handler class - from Wx::PlFileSystemHandler. + from @c Wx::PlFileSystemHandler. @endWxPerlOnly @library{wxbase} diff --git a/interface/wx/frame.h b/interface/wx/frame.h index 82f283a3e8..32b1593fb2 100644 --- a/interface/wx/frame.h +++ b/interface/wx/frame.h @@ -415,6 +415,10 @@ public: @remarks The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields. + + @beginWxPerlOnly + In wxPerl this method takes the field widths as parameters. + @endWxPerlOnly */ virtual void SetStatusWidths(int n, const int* widths_field); diff --git a/interface/wx/icon.h b/interface/wx/icon.h index 9cb95d7348..80a40419da 100644 --- a/interface/wx/icon.h +++ b/interface/wx/icon.h @@ -94,6 +94,10 @@ public: @param height The height of the image. + @beginWxPerlOnly + In wxPerl use Wx::Icon->newBits(bits, width, height, depth = -1); + @endWxPerlOnly + @onlyfor{wxmsw,wxosx} */ wxIcon(const char bits[], int width, int height); @@ -125,6 +129,10 @@ public: wxIcon icon("mondrian"); #endif @endcode + + @beginWxPerlOnly + In wxPerl use Wx::Icon->newFromXPM(data). + @endWxPerlOnly */ wxIcon(const char* const* bits); diff --git a/interface/wx/image.h b/interface/wx/image.h index 43dcf59028..0477244094 100644 --- a/interface/wx/image.h +++ b/interface/wx/image.h @@ -457,6 +457,10 @@ public: @param xpmData A pointer to XPM image data. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxImage(const char* const* xpmData); diff --git a/interface/wx/intl.h b/interface/wx/intl.h index 947d47ad7e..b0e0567fcb 100644 --- a/interface/wx/intl.h +++ b/interface/wx/intl.h @@ -278,6 +278,11 @@ enum wxLayoutDirection /** Encapsulates a ::wxLanguage indentifier together with OS-specific information related to that language. + + @beginWxPerlOnly + In wxPerl @c Wx::LanguageInfo has only one method: + - Wx::LanguageInfo->new(language, canonicalName, WinLang, WinSubLang, Description) + @endWxPerlOnly */ struct WXDLLIMPEXP_BASE wxLanguageInfo { diff --git a/interface/wx/listbox.h b/interface/wx/listbox.h index 14e8af65de..c7a199a0de 100644 --- a/interface/wx/listbox.h +++ b/interface/wx/listbox.h @@ -95,6 +95,10 @@ public: The validator for this control. @param name The name of this class. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxListBox(wxWindow* parent, wxWindowID id, @@ -112,6 +116,10 @@ public: See the other wxListBox() constructor; the only difference is that this overload takes a wxArrayString instead of a pointer to an array of wxString. + + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly */ wxListBox(wxWindow* parent, wxWindowID id, @@ -169,6 +177,11 @@ public: @remarks Use this with a multiple selection listbox. + @beginWxPerlOnly + In wxPerl this method takes no parameters and return the + selected items as a list. + @endWxPerlOnly + @see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection, wxControlWithItems::SetSelection */ @@ -205,6 +218,10 @@ public: @param pos Position before which to insert the items: if pos is 0 the items will be inserted in the beginning of the listbox + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void InsertItems(unsigned int nItems, const wxString *items, unsigned int pos); @@ -217,6 +234,10 @@ public: @param pos Position before which to insert the items: if pos is @c 0 the items will be inserted in the beginning of the listbox + + @beginWxPerlOnly + Use an array reference for the @a items parameter. + @endWxPerlOnly */ void InsertItems(const wxArrayString& items, unsigned int pos); diff --git a/interface/wx/listctrl.h b/interface/wx/listctrl.h index bfd05c44af..222af7f596 100644 --- a/interface/wx/listctrl.h +++ b/interface/wx/listctrl.h @@ -264,18 +264,31 @@ public: /** Find an item whose data matches this data, starting from start or the beginning if 'start' is @c -1. + + @beginWxPerlOnly + In wxPerl this method is implemented as FindItemData(start, data). + @endWxPerlOnly */ long FindItem(long start, wxUIntPtr data); /** Find an item nearest this position in the specified direction, starting from @a start or the beginning if @a start is -1. + + @beginWxPerlOnly + In wxPerl this method is implemented as FindItemAtPos(start, pt, direction). + @endWxPerlOnly */ long FindItem(long start, const wxPoint& pt, int direction); /** Gets information about this column. See SetItem() for more information. + + @beginWxPerlOnly + In wxPerl this method takes only the @a col parameter and + returns a @c Wx::ListItem (or @c undef). + @endWxPerlOnly */ bool GetColumn(int col, wxListItem& item) const; @@ -359,6 +372,11 @@ public: You must call @e info.SetId() to set the ID of item you're interested in before calling this method, and @e info.SetMask() with the flags indicating what fields you need to retrieve from @a info. + + @beginWxPerlOnly + In wxPerl this method takes as parameter the ID of the item + and (optionally) the column, and returns a Wx::ListItem object. + @endWxPerlOnly */ bool GetItem(wxListItem& info) const; @@ -388,6 +406,11 @@ public: /** Returns the position of the item, in icon or small icon view. + + @beginWxPerlOnly + In wxPerl this method takes only the @a item parameter and + returns a @c Wx::Point (or @c undef). + @endWxPerlOnly */ bool GetItemPosition(long item, wxPoint& pos) const; @@ -396,6 +419,11 @@ public: coordinates. @a code is one of wxLIST_RECT_BOUNDS, wxLIST_RECT_ICON, wxLIST_RECT_LABEL. + + @beginWxPerlOnly + In wxPerl this method takes only the @a item and @a code parameters and + returns a @c Wx::Rect (or @c undef). + @endWxPerlOnly */ bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const; @@ -541,6 +569,11 @@ public: the host system or the value stored in @a ptrSubItem will be always -1. To compile this feature into wxWidgets library you need to have access to commctrl.h of version 4.70 that is provided by Microsoft. + + @beginWxPerlOnly + In wxPerl this method only takes the @a point parameter + and returns a 2-element list (item, flags). + @endWxPerlOnly */ long HitTest(const wxPoint& point, int& flags, long* ptrSubItem = NULL) const; @@ -571,6 +604,10 @@ public: Index of the new item, supplied by the application @param label String label + + @beginWxPerlOnly + In wxPerl this method is implemented as InsertStringItem(index, label). + @endWxPerlOnly */ long InsertItem(long index, const wxString& label); @@ -581,6 +618,10 @@ public: Index of the new item, supplied by the application @param imageIndex Index into the image list associated with this control and view style + + @beginWxPerlOnly + In wxPerl this method is implemented as InsertImageItem(index, imageIndex). + @endWxPerlOnly */ long InsertItem(long index, int imageIndex); @@ -593,6 +634,10 @@ public: String label @param imageIndex Index into the image list associated with this control and view style + + @beginWxPerlOnly + In wxPerl this method is implemented as InsertImageStringItem(index, label, imageIndex). + @endWxPerlOnly */ long InsertItem(long index, const wxString& label, int imageIndex); @@ -860,6 +905,12 @@ public: items in the control. Please see the @ref page_samples_listctrl for an example of using this function. + + @beginWxPerlOnly + In wxPerl the comparison function must take just two parameters; + however, you may use a closure to achieve an effect similar to the + SortItems third parameter. + @endWxPerlOnly */ bool SortItems(wxListCtrlCompare fnSortCallBack, wxIntPtr data); diff --git a/interface/wx/menu.h b/interface/wx/menu.h index f1c9b97d05..ba8bb6bb55 100644 --- a/interface/wx/menu.h +++ b/interface/wx/menu.h @@ -53,6 +53,10 @@ public: the menu bar. @param style If wxMB_DOCKABLE the menu bar can be detached (wxGTK only). + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxMenuBar(size_t n, wxMenu* menus[], const wxString titles[], long style = 0); @@ -124,6 +128,12 @@ public: If not @NULL, menu will get set to the associated menu. @return The found menu item object, or @NULL if one was not found. + + @beginWxPerlOnly + In wxPerl this method takes just the @a id parameter; + in scalar context it returns the associated @c Wx::MenuItem, in list + context it returns a 2-element list (item, submenu). + @endWxPerlOnly */ virtual wxMenuItem* FindItem(int id, wxMenu* menu = NULL) const; diff --git a/interface/wx/palette.h b/interface/wx/palette.h index 0a4f35678b..ff6aa08792 100644 --- a/interface/wx/palette.h +++ b/interface/wx/palette.h @@ -60,6 +60,11 @@ public: @param blue An array of blue values. + @beginWxPerlOnly + In wxPerl this method takes as parameters + 3 array references (they must be of the same length). + @endWxPerlOnly + @see Create() */ wxPalette(int n, const unsigned char* red, @@ -130,6 +135,11 @@ public: @return @true if the operation was successful. + @beginWxPerlOnly + In wxPerl this method takes only the @a pixel parameter and + returns a 3-element list (or the empty list upon failure). + @endWxPerlOnly + @see GetPixel() */ bool GetRGB(int pixel, unsigned char* red, unsigned char* green, diff --git a/interface/wx/print.h b/interface/wx/print.h index 53ce4e2f3e..343dbb5b81 100644 --- a/interface/wx/print.h +++ b/interface/wx/print.h @@ -586,6 +586,11 @@ public: @beginWxPythonOnly This method returns the output-only parameters as a tuple. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no arguments and returns a + 2-element list (w, h). + @endWxPerlOnly */ void GetPPIPrinter(int* w, int* h) const; @@ -601,6 +606,11 @@ public: @beginWxPythonOnly This method returns the output-only parameters as a tuple. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no arguments and returns a + 2-element list (w, h). + @endWxPerlOnly */ void GetPPIScreen(int* w, int* h) const; @@ -630,6 +640,11 @@ public: @beginWxPythonOnly This method returns the output-only parameters as a tuple. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no arguments and returns a + 2-element list (w, h). + @endWxPerlOnly */ void GetPageSizeMM(int* w, int* h) const; @@ -646,6 +661,11 @@ public: @beginWxPythonOnly This method returns the output-only parameters as a tuple. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no arguments and returns a + 2-element list (w, h). + @endWxPerlOnly */ void GetPageSizePixels(int* w, int* h) const; diff --git a/interface/wx/process.h b/interface/wx/process.h index 4a5585f81a..e516a6f055 100644 --- a/interface/wx/process.h +++ b/interface/wx/process.h @@ -75,6 +75,11 @@ enum wxKillError @library{wxbase} @category{appmanagement} + @beginWxPerlOnly + In wxPerl this class has an additional @c Destroy method, + for explicit destruction. + @endWxPerlOnly + @see wxExecute(), @ref page_samples_exec */ class wxProcess : public wxEvtHandler diff --git a/interface/wx/radiobox.h b/interface/wx/radiobox.h index 43326c3aeb..f8b23afe99 100644 --- a/interface/wx/radiobox.h +++ b/interface/wx/radiobox.h @@ -77,6 +77,10 @@ public: @param name Window name. + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly + @see Create(), wxValidator */ wxRadioBox(wxWindow* parent, wxWindowID id, @@ -118,6 +122,10 @@ public: @param name Window name. + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly + @see Create(), wxValidator */ wxRadioBox(wxWindow* parent, wxWindowID id, diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h index f5762e7e5e..9749ef7e8c 100644 --- a/interface/wx/scrolwin.h +++ b/interface/wx/scrolwin.h @@ -163,6 +163,11 @@ public: 10) and so the call to CalcScrolledPosition(0, 10, xx, yy) will return 0 in yy. + @beginWxPerlOnly + In wxPerl this method takes two parameters and returns a + 2-element list (xx, yy). + @endWxPerlOnly + @see CalcUnscrolledPosition() */ void CalcScrolledPosition(int x, int y, int* xx, int* yy) const; @@ -174,6 +179,11 @@ public: 10) and so the call to CalcUnscrolledPosition(0, 0, xx, yy) will return 10 in yy. + @beginWxPerlOnly + In wxPerl this method takes two parameters and returns a + 2-element list (xx, yy). + @endWxPerlOnly + @see CalcScrolledPosition() */ void CalcUnscrolledPosition(int x, int y, int* xx, int* yy) const; @@ -283,6 +293,11 @@ public: @param yUnit Receives the number of pixels per vertical unit. + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a + 2-element list (xUnit, yUnit). + @endWxPerlOnly + @see SetScrollbars(), GetVirtualSize() */ void GetScrollPixelsPerUnit(int* xUnit, int* yUnit) const; @@ -304,6 +319,11 @@ public: to pixels you will have to multiply by the number of pixels per scroll increment. + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a + 2-element list (x, y). + @endWxPerlOnly + @see SetScrollbars(), Scroll() */ void GetViewStart(int* x, int* y) const; @@ -327,6 +347,11 @@ public: @remarks Use wxDC::DeviceToLogicalX() and wxDC::DeviceToLogicalY() to translate these units to logical units. + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a + 2-element list (xUnit, yUnit). + @endWxPerlOnly + @see SetScrollbars(), GetScrollPixelsPerUnit() */ void GetVirtualSize(int* x, int* y) const; diff --git a/interface/wx/statusbr.h b/interface/wx/statusbr.h index 10ac248b5b..0b7c1b1dc7 100644 --- a/interface/wx/statusbr.h +++ b/interface/wx/statusbr.h @@ -135,6 +135,11 @@ public: @return @true if the field index is valid, @false otherwise. + @beginWxPerlOnly + In wxPerl this function returns a @c Wx::Rect if the field + index is valid, @c undef otherwise. + @endWxPerlOnly + @see wxRect */ virtual bool GetFieldRect(int i, wxRect& rect) const; @@ -215,6 +220,11 @@ public: @param widths An array of n integers interpreted in the same way as in SetStatusWidths(). + + @beginWxPerlOnly + In wxPerl this function accepts only the @a number parameter. + Use SetStatusWidths to set the field widths. + @endWxPerlOnly */ virtual void SetFieldsCount(int number = 1, const int* widths = NULL); @@ -287,6 +297,10 @@ public: width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields. + @beginWxPerlOnly + In wxPerl this method takes as parameters the field widths. + @endWxPerlOnly + @see SetFieldsCount(), wxFrame::SetStatusWidths() */ virtual void SetStatusWidths(int n, const int* widths_field); diff --git a/interface/wx/textctrl.h b/interface/wx/textctrl.h index a8178169ea..e64f8f0092 100644 --- a/interface/wx/textctrl.h +++ b/interface/wx/textctrl.h @@ -1236,6 +1236,11 @@ public: Please note that this function is currently only implemented in wxUniv, wxMSW and wxGTK2 ports. + @beginWxPerlOnly + In wxPerl this function takes only the @a pt argument and + returns a 3-element list (result, col, row). + @endWxPerlOnly + @see PositionToXY(), XYToPosition() */ wxTextCtrlHitTestResult HitTest(const wxPoint& pt, @@ -1313,6 +1318,11 @@ public: @true on success, @false on failure (most likely due to a too large position parameter). + @beginWxPerlOnly + In wxPerl this function takes only the @a pos argument and + returns a 2-element list (x, y). + @endWxPerlOnly + @see XYToPosition() */ virtual bool PositionToXY(long pos, long* x, long* y) const; diff --git a/interface/wx/textentry.h b/interface/wx/textentry.h index bdbf7f28e2..ba646469e2 100644 --- a/interface/wx/textentry.h +++ b/interface/wx/textentry.h @@ -198,6 +198,11 @@ public: The returned first position. @param to The returned last position. + + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a + 2-element list (from, to). + @endWxPerlOnly */ virtual void GetSelection(long* from, long* to) const; diff --git a/interface/wx/treebase.h b/interface/wx/treebase.h index e9eaf7da5d..5bed652e0c 100644 --- a/interface/wx/treebase.h +++ b/interface/wx/treebase.h @@ -77,6 +77,13 @@ public: - GetData(): Returns a reference to the Python Object. - SetData(obj): Associates a new Python Object with the wxTreeItemData. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl the constructor accepts a scalar as an optional parameter + and stores it as client data; use + - GetData() to retrieve the value. + - SetData(data) to set it. + @endWxPerlOnly */ wxTreeItemData(); diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h index 6897303738..f1cdacd529 100644 --- a/interface/wx/treectrl.h +++ b/interface/wx/treectrl.h @@ -358,6 +358,11 @@ public: textOnly parameters. The return value is either a wxRect object or @c None. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method only takes the @a item and + @a textOnly parameters and returns a @c Wx::Rect (or @c undef). + @endWxPerlOnly */ virtual bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, bool textOnly = false) const; @@ -408,6 +413,11 @@ public: returned as a tuple containing the two values. @endWxPythonOnly + @beginWxPerlOnly + In wxPerl this method only takes the @a item parameter, and + returns a 2-element list (item, cookie). + @endWxPerlOnly + @see GetNextChild(), GetNextSibling() */ virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item, @@ -452,6 +462,13 @@ public: @li GetPyData(item): Returns the Python Object associated with the wxTreeItemData for the given item Id. @endWxPythonOnly + + @beginWxPerlOnly + wxPerl provides the following shortcut method: + - GetPlData(item): returns the Perl data + associated with the Wx::TreeItemData. It is just the same as + tree->GetItemData(item)->GetData(). + @endWxPerlOnly */ virtual wxTreeItemData* GetItemData(const wxTreeItemId& item) const; @@ -518,6 +535,11 @@ public: returned as a tuple containing the two values. @endWxPythonOnly + @beginWxPerlOnly + In wxPerl this method returns a 2-element list + (item, cookie) instead of modifying its parameters. + @endWxPerlOnly + @see GetFirstChild() */ virtual wxTreeItemId GetNextChild(const wxTreeItemId& item, @@ -591,6 +613,11 @@ public: The wxPython version of this method accepts no parameters and returns a Python list of @ref wxTreeItemId "wxTreeItemId"s. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a list of + @c Wx::TreeItemId. + @endWxPerlOnly */ virtual size_t GetSelections(wxArrayTreeItemIds& selection) const; @@ -621,6 +648,11 @@ public: @beginWxPythonOnly In wxPython both the wxTreeItemId and the flags are returned as a tuple. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method only takes the @a point parameter + and returns a 2-element list (item, flags). + @endWxPerlOnly */ wxTreeItemId HitTest(const wxPoint& point, int& flags) const; @@ -795,6 +827,12 @@ public: the wxTreeItemData for the given item Id. @endWxPythonOnly + @beginWxPerlOnly + wxPerl provides the following shortcut method: + - SetPlData(item, data): sets the Perl data + associated with the @c Wx::TreeItemData. It is just the same as + tree->GetItemData(item)->SetData(data). + @endWxPerlOnly */ virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData* data); diff --git a/interface/wx/utils.h b/interface/wx/utils.h index 08b6a55037..9bb227a63d 100644 --- a/interface/wx/utils.h +++ b/interface/wx/utils.h @@ -780,9 +780,7 @@ wxLinuxDistributionInfo wxGetLinuxDistributionInfo(); @header{wx/utils.h} @beginWxPerlOnly - This function is called @c Wx::ExecuteStdoutStderr and it only takes the - @a command argument, and returns a 3-element list (@c status, @c output, - @c errors), where @c output and @c errors are array references. + In wxPerl this function is called @c Wx::ExecuteCommand. @endWxPerlOnly */ long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC, @@ -815,6 +813,10 @@ long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC, wxLaunchDefaultApplication(), wxLaunchDefaultBrowser() @header{wx/utils.h} + + @beginWxPerlOnly + In wxPerl this function is called @c Wx::ExecuteArgs. + @endWxPerlOnly */ long wxExecute(char** argv, int flags = wxEXEC_ASYNC, wxProcess* callback = NULL); @@ -847,6 +849,12 @@ long wxExecute(wchar_t** argv, int flags = wxEXEC_ASYNC, wxLaunchDefaultApplication(), wxLaunchDefaultBrowser() @header{wx/utils.h} + + @beginWxPerlOnly + This function is called @c Wx::ExecuteStdout: it only takes the + @a command argument, and returns a 2-element list (@c status, @c output), + where @c output in an array reference. + @endWxPerlOnly */ long wxExecute(const wxString& command, wxArrayString& output, int flags = 0); @@ -874,6 +882,12 @@ long wxExecute(const wxString& command, wxArrayString& output, int flags = 0); wxLaunchDefaultApplication(), wxLaunchDefaultBrowser() @header{wx/utils.h} + + @beginWxPerlOnly + This function is called @c Wx::ExecuteStdoutStderr: it only takes the + @a command argument, and returns a 3-element list (@c status, @c output, + @c errors), where @c output and @c errors are array references. + @endWxPerlOnly */ long wxExecute(const wxString& command, wxArrayString& output, wxArrayString& errors, int flags = 0); diff --git a/interface/wx/window.h b/interface/wx/window.h index 44e1aff4e6..a40cace842 100644 --- a/interface/wx/window.h +++ b/interface/wx/window.h @@ -782,6 +782,11 @@ public: Note that if this window is a top-level one and it is currently minimized, the return size is empty (both width and height are 0). + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns + a 2-element list (width, height). + @endWxPerlOnly + @see GetSize(), GetVirtualSize() */ void GetClientSize(int* width, int* height) const; @@ -858,6 +863,11 @@ public: @param height Receives the window height. + @beginWxPerlOnly + In wxPerl this method is implemented as GetSizeWH() returning + a 2-element list (width, height). + @endWxPerlOnly + @see GetClientSize(), GetVirtualSize(), @ref overview_windowsizing */ void GetSize(int* width, int* height) const; @@ -1197,6 +1207,11 @@ public: @param y Receives the y position of the window if non-@NULL. + @beginWxPerlOnly + In wxPerl this method is implemented as GetPositionXY() returning + a 2-element list (x, y). + @endWxPerlOnly + @see GetScreenPosition() */ void GetPosition(int* x, int* y) const; @@ -1305,6 +1320,11 @@ public: - ClientToScreen(point): Accepts and returns a wxPoint - ClientToScreenXY(x, y): Returns a 2-tuple, (x, y) @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method returns a 2-element list instead of + modifying its parameters. + @endWxPerlOnly */ void ClientToScreen(int* x, int* y) const; @@ -1511,6 +1531,12 @@ public: Return value for external leading (optional). @param font Font to use instead of the current window font (optional). + + @beginWxPerlOnly + In wxPerl this method takes only the @a string and optionally + @a font parameters, and returns a 4-element list + (x, y, descent, externalLeading). + @endWxPerlOnly */ void GetTextExtent(const wxString& string, int* w, int* h, @@ -2861,6 +2887,10 @@ public: Returns the platform-specific handle of the physical window. Cast it to an appropriate handle, such as @b HWND for Windows, @b Widget for Motif, @b GtkWidget for GTK or @b WinHandle for PalmOS. + + @beginWxPerlOnly + This method will return an integer in wxPerl. + @endWxPerlOnly */ virtual WXWidget GetHandle() const; -- 2.45.2