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

wxPython doc updates

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5087 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
1999-12-23 20:09:58 +00:00
parent 9b3d3bc44b
commit 874a1686d8
3 changed files with 23 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/latex/wx/dataobj.tex
View File

@@ -91,7 +91,7 @@ wxDataObjectSimple: \helpref{wxFileDataObject}{wxfiledataobject},
\helpref{wxBitmapDataObject}{wxbitmapdataobject} which can be used without \helpref{wxBitmapDataObject}{wxbitmapdataobject} which can be used without
change. change.
You may also derive your own data object classes from You may also derive your own data object classes from
\helpref{wxCustomDataObject}{wxcustomdataobject} for user-defined types. The \helpref{wxCustomDataObject}{wxcustomdataobject} for user-defined types. The
format of user-defined data is given as mime-type string literal, such as format of user-defined data is given as mime-type string literal, such as
"application/word" or "image/png". These strings are used as they are under "application/word" or "image/png". These strings are used as they are under
@@ -100,7 +100,7 @@ Windows equivalent under Win32 (using the OLE IDataObject for data exchange to
and from the clipboard and for drag and drop). Note that the format string and from the clipboard and for drag and drop). Note that the format string
translation under Windows is not yet finished. translation under Windows is not yet finished.
\pythonnote{At this time this class is directly usable from wxPython. \pythonnote{At this time this class is not directly usable from wxPython.
Derive a class from \helpref{wxPyDataObjectSimple}{wxdataobjectsimple} Derive a class from \helpref{wxPyDataObjectSimple}{wxdataobjectsimple}
instead.} instead.}
@@ -123,15 +123,15 @@ None
\wxheading{See also} \wxheading{See also}
\helpref{Clipboard and drag and drop overview}{wxdndoverview}, \helpref{Clipboard and drag and drop overview}{wxdndoverview},
\helpref{DnD sample}{samplednd}, \helpref{DnD sample}{samplednd},
\helpref{wxFileDataObject}{wxfiledataobject}, \helpref{wxFileDataObject}{wxfiledataobject},
\helpref{wxTextDataObject}{wxtextdataobject}, \helpref{wxTextDataObject}{wxtextdataobject},
\helpref{wxBitmapDataObject}{wxbitmapdataobject}, \helpref{wxBitmapDataObject}{wxbitmapdataobject},
\helpref{wxCustomDataObject}{wxcustomdataobject}, \helpref{wxCustomDataObject}{wxcustomdataobject},
\helpref{wxDropTarget}{wxdroptarget}, \helpref{wxDropTarget}{wxdroptarget},
\helpref{wxDropSource}{wxdropsource}, \helpref{wxDropSource}{wxdropsource},
\helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxTextDropTarget}{wxtextdroptarget},
\helpref{wxFileDropTarget}{wxfiledroptarget} \helpref{wxFileDropTarget}{wxfiledroptarget}
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}

15
docs/latex/wx/menu.tex
View File

@@ -29,7 +29,7 @@ With a popup menu, there is a variety of ways to handle a menu selection event
\item Provide EVT\_MENU handlers in the window which pops up the menu, or in an ancestor of \item Provide EVT\_MENU handlers in the window which pops up the menu, or in an ancestor of
this window. this window.
\item Define a callback of type wxFunction, which you pass to the wxMenu constructor. \item Define a callback of type wxFunction, which you pass to the wxMenu constructor.
The callback takes a reference to the menu, and a reference to a The callback takes a reference to the menu, and a reference to a
\helpref{wxCommandEvent}{wxcommandevent}. This method is deprecated and should \helpref{wxCommandEvent}{wxcommandevent}. This method is deprecated and should
not be used in the new code, it is provided for backwards compatibility only. not be used in the new code, it is provided for backwards compatibility only.
\end{enumerate} \end{enumerate}
@@ -169,7 +169,7 @@ Checks or unchecks the menu item.
\func{void}{Delete}{\param{wxMenuItem *}{item}} \func{void}{Delete}{\param{wxMenuItem *}{item}}
Deletes the menu item from the menu. If the item is a submenu, it will Deletes the menu item from the menu. If the item is a submenu, it will
{\bf not} be deleted. Use \helpref{Destroy}{wxmenudestroy} if you want to {\bf not} be deleted. Use \helpref{Destroy}{wxmenudestroy} if you want to
delete a submenu. delete a submenu.
@@ -191,7 +191,7 @@ delete a submenu.
\func{void}{Destroy}{\param{wxMenuItem *}{item}} \func{void}{Destroy}{\param{wxMenuItem *}{item}}
Deletes the menu item from the menu. If the item is a submenu, it will Deletes the menu item from the menu. If the item is a submenu, it will
be deleted. Use \helpref{Remove}{wxmenuremove} if you want to keep the submenu be deleted. Use \helpref{Remove}{wxmenuremove} if you want to keep the submenu
(for example, to reuse it later). (for example, to reuse it later).
@@ -268,6 +268,9 @@ Returns the menu item object, or NULL if it is not found.
\helpref{wxMenu::FindItem}{wxmenufinditem} \helpref{wxMenu::FindItem}{wxmenufinditem}
\pythonnote{The name of this method in wxPython is \tt{FindItemById}
and it does not support the second parameter.}
\membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring} \membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring}
\constfunc{wxString}{GetHelpString}{\param{int}{ id}} \constfunc{wxString}{GetHelpString}{\param{int}{ id}}
@@ -706,8 +709,8 @@ Returns the number of menus in this menubar.
\func{bool}{Insert}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}} \func{bool}{Insert}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
Inserts the menu at the given position into the menu bar. Inserting menu at Inserts the menu at the given position into the menu bar. Inserting menu at
position $0$ will insert it in the very beginning of it, inserting at position position $0$ will insert it in the very beginning of it, inserting at position
\helpref{GetMenuCount()}{wxmenubargetmenucount} is the same as calling \helpref{GetMenuCount()}{wxmenubargetmenucount} is the same as calling
\helpref{Append()}{wxmenubarappend}. \helpref{Append()}{wxmenubarappend}.
\wxheading{Parameters} \wxheading{Parameters}
@@ -765,7 +768,7 @@ Redraw the menu bar
\func{wxMenu *}{Remove}{\param{size\_t }{pos}} \func{wxMenu *}{Remove}{\param{size\_t }{pos}}
Removes the menu from the menu bar and returns the menu object - the caller is Removes the menu from the menu bar and returns the menu object - the caller is
reposnbile for deleting it. This function may be used together with reposnbile for deleting it. This function may be used together with
\helpref{wxMenuBar::Insert}{wxmenubarinsert} to change the menubar \helpref{wxMenuBar::Insert}{wxmenubarinsert} to change the menubar
dynamically. dynamically.

3
docs/latex/wx/treectrl.tex
View File

@@ -361,6 +361,9 @@ Returns the next visible item.
Returns the item's parent. Returns the item's parent.
\pythonnote{This method is named \tt{GetItemParent} to avoid a name
clash with wxWindow::GetParent.}
\membersection{wxTreeCtrl::GetPrevSibling}\label{wxtreectrlgetprevsibling} \membersection{wxTreeCtrl::GetPrevSibling}\label{wxtreectrlgetprevsibling}
\constfunc{wxTreeItemId}{GetPrevSibling}{\param{const wxTreeItemId\&}{ item}} \constfunc{wxTreeItemId}{GetPrevSibling}{\param{const wxTreeItemId\&}{ item}}