Re: [Wxruby-dev] Request for non-coding assistance

[Richard Kilmer]

On Sunday, June 1, 2003, at 12:32  PM, Kevin Smith wrote:

> The first file I tried was window. Generally it looks good, but I see
> that ClientToScreen isn't listed. I haven't yet looked at the tex file
> to try to figure it out.

Figured out the ClientToScreen thing.  I was finding lines that started 
with \func and it seems that there are also \constfunc lines (which is 
what ClientToScreen is).  I fixed the parse_wxdoc.rb file (attached) to 
include \constfunc's.

parse_wxdoc.rb
Description: Binary data

> The feature request is: Would it be possible to list the Python
> signatures where they exist? I plan to match the Python implementation
> where it differs from C++. One example is window's ClientToScreen call.

It looks like with the python signatures, they vary the method names in 
methods that have overloaded methods (like ClientToScreen).  There are 
'\pythonnote' sections under these methods that I probably could figure 
out how to parse, but it may be a pain in the rear end.  For WxWindow 
there are 14 such \pythonnote sections (and one that changes the return 
type). Across all of the .tex files there are 129 such \pythonnotes. It 
may be better to just emit these notes (as annotations on the methods) 
for access our output.

Let me know what you want to do.

-rich

Here is a (grep'ed) list of \constfunc's:

\constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* 
}{y}}
\constfunc{virtual wxPoint}{ClientToScreen}{\param{const wxPoint\&}{ 
pt}}
\constfunc{wxSize}{GetAdjustedBestSize}{\void}
\constfunc{virtual wxColour}{GetBackgroundColour}{\void}
\constfunc{virtual wxSize}{GetBestSize}{\void}
\constfunc{wxCaret *}{GetCaret}{\void}
\constfunc{virtual int}{GetCharHeight}{\void}
\constfunc{virtual int}{GetCharWidth}{\void}
\constfunc{virtual void}{GetClientSize}{\param{int* }{width}, 
\param{int* }{height}}
\constfunc{virtual wxSize}{GetClientSize}{\void}
\constfunc{wxLayoutConstraints*}{GetConstraints}{\void}
\constfunc{const wxSizer *}{GetContainingSizer}{\void}
\constfunc{wxDropTarget*}{GetDropTarget}{\void}
\constfunc{wxEvtHandler*}{GetEventHandler}{\void}
\constfunc{long}{GetExtraStyle}{\void}
\constfunc{wxFont\&}{GetFont}{\void}
\constfunc{wxWindow*}{GetGrandParent}{\void}
\constfunc{void*}{GetHandle}{\void}
\constfunc{virtual wxString}{GetHelpText}{\void}
\constfunc{int}{GetId}{\void}
\constfunc{virtual wxString }{GetLabel}{\void}
\constfunc{virtual wxString }{GetName}{\void}
\constfunc{virtual wxWindow*}{GetParent}{\void}
\constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* 
}{y}}
\constfunc{wxPoint}{GetPosition}{\void}
\constfunc{virtual wxRect}{GetRect}{\void}
\constfunc{virtual void}{GetSize}{\param{int* }{width}, \param{int* 
}{height}}
\constfunc{virtual wxSize}{GetSize}{\void}
\constfunc{wxSizer *}{GetSizer}{\void}
\constfunc{virtual void}{GetTextExtent}{\param{const wxString\& 
}{string}, \param{int* }{x}, \param{int* }{y},
\constfunc{virtual wxRegion}{GetUpdateRegion}{\void}
\constfunc{wxValidator*}{GetValidator}{\void}
\constfunc{void}{GetVirtualSize}{\param{int* }{width}, \param{int* 
}{height}}
\constfunc{wxSize}{GetVirtualSize}{\void}
\constfunc{long}{GetWindowStyleFlag}{\void}
\constfunc{virtual bool}{HasCapture}{\void}
\constfunc{virtual bool}{IsEnabled}{\void}
\constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}}
\constfunc{bool}{IsExposed}{\param{wxPoint }{\&pt}}
\constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}, 
\param{int }{w}, \param{int }{h}}
\constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}}
\constfunc{virtual bool}{IsRetained}{\void}
\constfunc{virtual bool}{IsShown}{\void}
\constfunc{bool}{IsTopLevel}{\void}
\constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler 
= {\tt FALSE}}}
\constfunc{virtual void}{ScreenToClient}{\param{int* }{x}, \param{int* 
}{y}}
\constfunc{virtual wxPoint}{ScreenToClient}{\param{const wxPoint\& 
}{pt}}
\constfunc{void}{SetCaret}{\param{wxCaret *}{caret}}
\constfunc{wxToolTip*}{GetToolTip}{\void}

And here is a grep'ed list of \func's:

\func{}{wxWindow}{\void}
\func{}{wxWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},
\func{}{\destruct{wxWindow}}{\void}
\func{virtual void}{AddChild}{\param{wxWindow* }{child}}
\func{virtual void}{CaptureMouse}{\void}
\func{void}{Center}{\param{int}{ direction}}
\func{void}{CenterOnParent}{\param{int}{ direction}}
\func{void}{CenterOnScreen}{\param{int}{ direction}}
\func{void}{Centre}{\param{int}{ direction = wxBOTH}}
\func{void}{CentreOnParent}{\param{int}{ direction = wxBOTH}}
\func{void}{CentreOnScreen}{\param{int}{ direction = wxBOTH}}
\func{void}{Clear}{\void}
\func{virtual bool}{Close}{\param{bool}{ force = {\tt FALSE}}}
\func{wxPoint}{ConvertDialogToPixels}{\param{const wxPoint\&}{ pt}}
\func{wxSize}{ConvertDialogToPixels}{\param{const wxSize\&}{ sz}}
\func{wxPoint}{ConvertPixelsToDialog}{\param{const wxPoint\&}{ pt}}
\func{wxSize}{ConvertPixelsToDialog}{\param{const wxSize\&}{ sz}}
\func{virtual bool}{Destroy}{\void}
\func{virtual void}{DestroyChildren}{\void}
\func{void}{Disable}{\void}
\func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}}
\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt TRUE}}}
\func{static wxWindow*}{FindFocus}{\void}
\func{wxWindow*}{FindWindow}{\param{long}{ id}}
\func{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}}
\func{static wxWindow*}{FindWindowById}{\param{long}{ id}, 
\param{wxWindow*}{ parent = NULL}}
\func{static wxWindow*}{FindWindowByName}{\param{const wxString\&}{ 
name}, \param{wxWindow*}{ parent = NULL}}
\func{static wxWindow*}{FindWindowByLabel}{\param{const wxString\&}{ 
label}, \param{wxWindow*}{ parent = NULL}}
\func{virtual void}{Fit}{\void}
\func{virtual void}{FitInside}{\void}
\func{virtual void}{Freeze}{\void}
\func{static wxWindow *}{GetCapture}{\void}
\func{wxList\&}{GetChildren}{\void}
\func{virtual wxColour}{GetForegroundColour}{\void}
\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
\func{virtual int}{GetScrollPos}{\param{int }{orientation}}
\func{virtual int}{GetScrollRange}{\param{int }{orientation}}
\func{virtual wxString}{GetTitle}{\void}
\func{bool}{Hide}{\void}
\func{void}{InitDialog}{\void}
\func{void}{Layout}{\void}
\func{virtual bool}{LoadFromResource}{\param{wxWindow* }{parent},\rtfsp
\func{void}{Lower}{\void}
\func{virtual void}{MakeModal}{\param{bool }{flag}}
\func{void}{Move}{\param{int}{ x}, \param{int}{ y}}
\func{void}{Move}{\param{const wxPoint\&}{ pt}}
\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& 
}{pos}}
\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, 
\param{int }{y}}
\func{void}{PushEventHandler}{\param{wxEvtHandler* }{handler}}
\func{void}{Raise}{\void}
\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt 
TRUE}}, \param{const wxRect* }{rect
\func{virtual void}{Refresh}{\param{const wxRect\& }{rect}}
\func{virtual void}{ReleaseMouse}{\void}
\func{virtual void}{RemoveChild}{\param{wxWindow* }{child}}
\func{bool}{RemoveEventHandler}{\param{wxEvtHandler *}{handler}}
\func{virtual bool}{Reparent}{\param{wxWindow* }{newParent}}
\func{virtual bool}{ScrollLines}{\param{int }{lines}}
\func{virtual bool}{ScrollPages}{\param{int }{pages}}
\func{virtual void}{ScrollWindow}{\param{int }{dx}, \param{int }{dy}, 
\param{const wxRect*}{ rect = NULL}}
\func{virtual void}{SetAcceleratorTable}{\param{const 
wxAcceleratorTable\&}{ accel}}
\func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
\func{virtual void}{SetBackgroundColour}{\param{const wxColour\& 
}{colour}}
\func{virtual void}{SetClientSize}{\param{int}{ width}, \param{int}{ 
height}}
\func{virtual void}{SetClientSize}{\param{const wxSize\&}{ size}}
\func{void}{SetContainingSizer}{\param{wxSizer* }{sizer}}
\func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}}
\func{void}{SetConstraints}{\param{wxLayoutConstraints* }{constraints}}
\func{void}{SetDropTarget}{\param{wxDropTarget*}{ target}}
\func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}}
\func{void}{SetExtraStyle}{\param{long }{exStyle}}
\func{virtual void}{SetFocus}{\void}
\func{virtual void}{SetFocusFromKbd}{\void}
\func{void}{SetFont}{\param{const wxFont\& }{font}}
\func{virtual void}{SetForegroundColour}{\param{const wxColour\& 
}{colour}}
\func{virtual void}{SetHelpText}{\param{const wxString\& }{helpText}}
\func{void}{SetId}{\param{int}{ id}}
\func{virtual void}{SetName}{\param{const wxString\& }{name}}
\func{virtual void}{SetPalette}{\param{wxPalette* }{palette}}
\func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int 
}{position},\rtfsp
\func{virtual void}{SetScrollPage}{\param{int }{orientation}, 
\param{int }{pageSize}, \param{bool }{refresh = {\tt TRUE}}}
\func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int 
}{pos}, \param{bool }{refresh = {\tt TRUE}}}
\func{virtual void}{SetScrollRange}{\param{int }{orientation}, 
\param{int }{range}, \param{bool }{refresh = {\tt TRUE}}}
\func{virtual void}{SetSize}{\param{int}{ x}, \param{int}{ y}, 
\param{int}{ width}, \param{int}{ height},
\func{virtual void}{SetSize}{\param{const wxRect\&}{ rect}}
\func{virtual void}{SetSize}{\param{int}{ width}, \param{int}{ height}}
\func{virtual void}{SetSize}{\param{const wxSize\&}{ size}}
\func{virtual void}{SetSizeHints}{\param{int}{ minW=-1}, \param{int}{ 
minH=-1}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1},
\func{void}{SetSizer}{\param{wxSizer* }{sizer}, \param{bool 
}{deleteOld=TRUE}}
\func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool 
}{deleteOld=TRUE}}
\func{virtual void}{SetTitle}{\param{const wxString\& }{title}}
\func{virtual void}{SetThemeEnabled}{\param{bool }{enable}}
\func{virtual void}{SetValidator}{\param{const wxValidator\&}{ 
validator}}
\func{void}{SetToolTip}{\param{const wxString\& }{tip}}
\func{void}{SetToolTip}{\param{wxToolTip* }{tip}}
\func{void}{SetVirtualSize}{\param{int}{ width}, \param{int}{ height}}
\func{void}{SetVirtualSize}{\param{const wxSize\&}{ size}}
\func{virtual void}{SetVirtualSizeHints}{\param{int}{ 
minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}}
\func{void}{SetWindowStyle}{\param{long}{ style}}
\func{virtual void}{SetWindowStyleFlag}{\param{long}{ style}}
\func{virtual bool}{Show}{\param{bool}{ show = {\tt TRUE}}}
\func{virtual void}{Thaw}{\void}
\func{virtual bool}{TransferDataFromWindow}{\void}
\func{virtual bool}{TransferDataToWindow}{\void}
\func{virtual void}{Update}{\void}
\func{virtual bool}{Validate}{\void}
\func{void}{WarpPointer}{\param{int}{ x}, \param{int}{ y}}