From f05074ad6029cefb1e0bdd58f16df906c578c761 Mon Sep 17 00:00:00 2001 From: Ryan Norton Date: Mon, 7 Feb 2005 04:40:35 +0000 Subject: [PATCH] Remove depreciated wxTabCtrl and wxTabEvent API from docs... git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31814 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/category.tex | 2 - docs/latex/wx/classes.tex | 2 - docs/latex/wx/notebook.tex | 1 - docs/latex/wx/noteevt.tex | 2 +- docs/latex/wx/tabctrl.tex | 237 ------------------------------------- docs/latex/wx/tabevent.tex | 41 ------- 6 files changed, 1 insertion(+), 284 deletions(-) delete mode 100644 docs/latex/wx/tabctrl.tex delete mode 100644 docs/latex/wx/tabevent.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index e9338691ee..74ba6dc771 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -99,7 +99,6 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection} \twocolitem{\helpref{wxListCtrl}{wxlistctrl}}{A control for displaying lists of strings and/or icons, plus a multicolumn report view} \twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade} for wxListCtrl in report mode} -\twocolitem{\helpref{wxTabCtrl}{wxtabctrl}}{Manages several tabs} \twocolitem{\helpref{wxTextCtrl}{wxtextctrl}}{Single or multiline text editing control} \twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierarchy) control} \twocolitem{\helpref{wxScrollBar}{wxscrollbar}}{Scrollbar control} @@ -247,7 +246,6 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event} \twocolitem{\helpref{wxSpinEvent}{wxspinevent}}{An event from \helpref{wxSpinButton}{wxspinbutton}} \twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event} -\twocolitem{\helpref{wxTabEvent}{wxtabevent}}{A tab control event} \twocolitem{\helpref{wxTimerEvent}{wxtimerevent}}{A timer expiration event} \twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event} \twocolitem{\helpref{wxUpdateUIEvent}{wxupdateuievent}}{A user interface update event} diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 47f8fa26c7..8cf0aca14e 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -317,8 +317,6 @@ \input sysclevt.tex \input sysopt.tex \input settings.tex -\input tabctrl.tex -\input tabevent.tex \input taskbar.tex \input tcpclint.tex \input tcpconn.tex diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex index 514a107684..114492e8d7 100644 --- a/docs/latex/wx/notebook.tex +++ b/docs/latex/wx/notebook.tex @@ -75,7 +75,6 @@ and the above code will therefore work on all platforms. \wxheading{See also} \helpref{wxNotebookEvent}{wxnotebookevent}, \helpref{wxImageList}{wximagelist},\rtfsp -\helpref{wxTabCtrl}{wxtabctrl} \latexignore{\rtfignore{\wxheading{Members}}} diff --git a/docs/latex/wx/noteevt.tex b/docs/latex/wx/noteevt.tex index 3ba299a0d0..04e0a26391 100644 --- a/docs/latex/wx/noteevt.tex +++ b/docs/latex/wx/noteevt.tex @@ -31,7 +31,7 @@ unnecessary to process both events at once. \wxheading{See also} -\helpref{wxNotebook}{wxnotebook}, \helpref{wxTabCtrl}{wxtabctrl}, \helpref{wxTabEvent}{wxtabevent} +\helpref{wxNotebook}{wxnotebook} \latexignore{\rtfignore{\wxheading{Members}}} diff --git a/docs/latex/wx/tabctrl.tex b/docs/latex/wx/tabctrl.tex deleted file mode 100644 index b5dd16b227..0000000000 --- a/docs/latex/wx/tabctrl.tex +++ /dev/null @@ -1,237 +0,0 @@ -\section{\class{wxTabCtrl}}\label{wxtabctrl} - -This class represents a tab control, which manages multiple tabs. - -\wxheading{Derived from} - -\helpref{wxControl}{wxcontrol}\\ -\helpref{wxWindow}{wxwindow}\\ -\helpref{wxEvtHandler}{wxevthandler}\\ -\helpref{wxObject}{wxobject} - -\wxheading{Include files} - - - -\wxheading{See also} - -\helpref{wxTabEvent}{wxtabevent}, \helpref{wxImageList}{wximagelist},\rtfsp -\helpref{wxNotebook}{wxnotebook} - -\latexignore{\rtfignore{\wxheading{Members}}} - -\membersection{wxTabCtrl::wxTabCtrl}\label{wxtabctrlctor} - -\func{}{wxTabCtrl}{\void} - -Default constructor. - -\func{}{wxTabCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, - \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "tabCtrl"}} - -Constructs a tab control. - -\wxheading{Parameters} - -\docparam{parent}{The parent window. Must be non-NULL.} - -\docparam{id}{The window identifier.} - -\docparam{pos}{The window position.} - -\docparam{size}{The window size.} - -\docparam{style}{The window style. Its value is a bit list of zero or more of {\bf wxTC\_MULTILINE}, - {\bf wxTC\_RIGHTJUSTIFY}, {\bf wxTC\_FIXEDWIDTH} and {\bf wxTC\_OWNERDRAW}.} - -\membersection{wxTabCtrl::\destruct{wxTabCtrl}}\label{wxtabctrldtor} - -\func{}{\destruct{wxTabCtrl}}{\void} - -Destroys the wxTabCtrl object. - -\membersection{wxTabCtrl::Create}\label{wxtabctrlcreate} - -\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, - \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "tabCtrl"}} - -Creates a tab control. See \helpref{wxTabCtrl::wxTabCtrl}{wxtabctrlctor} for a description -of the parameters. - -\membersection{wxTabCtrl::DeleteAllItems}\label{wxtabctrldeleteallitems} - -\func{bool}{DeleteAllItems}{\void} - -Deletes all tab items. - -\membersection{wxTabCtrl::DeleteItem}\label{wxtabctrldeleteitem} - -\func{bool}{DeleteItem}{\param{int}{ item}} - -Deletes the specified tab item. - -\membersection{wxTabCtrl::GetCurFocus}\label{wxtabctrlgetcurfocus} - -\constfunc{int}{GetCurFocus}{\void} - -Returns the index for the tab with the focus, or -1 if none has the focus. - -\membersection{wxTabCtrl::GetImageList}\label{wxtabctrlgetimagelist} - -\constfunc{wxImageList*}{GetImageList}{\void} - -Returns the associated image list. - -\wxheading{See also} - -\helpref{wxImageList}{wximagelist}, \helpref{wxTabCtrl::SetImageList}{wxtabctrlsetimagelist} - -\membersection{wxTabCtrl::GetItemCount}\label{wxtabctrlgetitemcount} - -\constfunc{int}{GetItemCount}{\void} - -Returns the number of tabs in the tab control. - -\membersection{wxTabCtrl::GetItemData}\label{wxtabctrlgetitemdata} - -\constfunc{void*}{GetItemData}{\void} - -Returns the client data for the given tab. - -\membersection{wxTabCtrl::GetItemImage}\label{wxtabctrlgetitemimage} - -\constfunc{int}{GetItemImage}{\void} - -Returns the image index for the given tab. - -\membersection{wxTabCtrl::GetItemRect}\label{wxtabctrlgetitemrect} - -\constfunc{bool}{GetItemRect}{\param{int }{item}, \param{wxRect\&}{ rect}} - -Returns the rectangle bounding the given tab. - -\wxheading{See also} - -\helpref{wxRect}{wxrect} - -\membersection{wxTabCtrl::GetItemText}\label{wxtabctrlgetitemtext} - -\constfunc{wxString}{GetItemText}{\void} - -Returns the string for the given tab. - -\membersection{wxTabCtrl::GetRowCount}\label{wxtabctrlgetrowcount} - -\constfunc{int}{GetRowCount}{\void} - -Returns the number of rows in the tab control. - -\membersection{wxTabCtrl::GetSelection}\label{wxtabctrlgetselection} - -\constfunc{int}{GetSelection}{\void} - -Returns the index for the currently selected tab. - -\wxheading{See also} - -\helpref{wxTabCtrl::SetSelection}{wxtabctrlsetselection} - -\membersection{wxTabCtrl::HitTest}\label{wxtabctrlhittest} - -\func{int}{HitTest}{\param{const wxPoint\&}{ pt}, \param{long\&}{ flags}} - -Tests whether a tab is at the specified position. - -\wxheading{Parameters} - -\docparam{pt}{Specifies the point for the hit test.} - -\docparam{flags}{Return value for detailed information. One of the following values: - -\twocolwidtha{7cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{{\bf wxTAB\_HITTEST\_NOWHERE}}{There was no tab under this point.} -\twocolitem{{\bf wxTAB\_HITTEST\_ONICON}}{The point was over an icon.} -\twocolitem{{\bf wxTAB\_HITTEST\_ONLABEL}}{The point was over a label.} -\twocolitem{{\bf wxTAB\_HITTEST\_ONITEM}}{The point was over an item, but not on the label or icon.} -\end{twocollist} -} - -\wxheading{Return value} - -Returns the zero-based tab index or -1 if no tab is at the specified position. - -\membersection{wxTabCtrl::InsertItem}\label{wxtabctrlinsertitem} - -\func{void}{InsertItem}{\param{int}{ item}, \param{const wxString\&}{ text}, \param{int }{imageId = -1}, - \param{void*}{ clientData = NULL}} - -Inserts a new tab. - -\wxheading{Parameters} - -\docparam{item}{Specifies the index for the new item.} - -\docparam{text}{Specifies the text for the new item.} - -\docparam{imageId}{Specifies the optional image index for the new item.} - -\docparam{clientData}{Specifies the optional client data for the new item.} - -\wxheading{Return value} - -true if successful, false otherwise. - -\membersection{wxTabCtrl::SetItemData}\label{wxtabctrlsetitemdata} - -\func{bool}{SetItemData}{\param{int}{ item}, \param{void*}{ data}} - -Sets the client data for a tab. - -\membersection{wxTabCtrl::SetItemImage}\label{wxtabctrlsetitemimage} - -\func{bool}{SetItemImage}{\param{int}{ item}, \param{int }{image}} - -Sets the image index for the given tab. {\it image} is an index into -the image list which was set with \helpref{wxTabCtrl::SetImageList}{wxtabctrlsetimagelist}. - -\membersection{wxTabCtrl::SetImageList}\label{wxtabctrlsetimagelist} - -\func{void}{SetImageList}{\param{wxImageList*}{ imageList}} - -Sets the image list for the tab control. - -\wxheading{See also} - -\helpref{wxImageList}{wximagelist} - -\membersection{wxTabCtrl::SetItemSize}\label{wxtabctrlsetitemsize} - -\func{void}{SetItemSize}{\param{const wxSize\&}{ size}} - -Sets the width and height of the tabs. - -\membersection{wxTabCtrl::SetItemText}\label{wxtabctrlsetitemtext} - -\func{bool}{SetItemText}{\param{int}{ item}, \param{const wxString\& }{text}} - -Sets the text for the given tab. - -\membersection{wxTabCtrl::SetPadding}\label{wxtabctrlsetpadding} - -\func{void}{SetPadding}{\param{const wxSize\&}{ padding}} - -Sets the amount of space around each tab's icon and label. - -\membersection{wxTabCtrl::SetSelection}\label{wxtabctrlsetselection} - -\func{int}{SetSelection}{\param{int}{ item}} - -Sets the selection for the given tab, returning the index of the previously -selected tab. Returns -1 if the call was unsuccessful. - -\wxheading{See also} - -\helpref{wxTabCtrl::GetSelection}{wxtabctrlgetselection} - - diff --git a/docs/latex/wx/tabevent.tex b/docs/latex/wx/tabevent.tex deleted file mode 100644 index c578812222..0000000000 --- a/docs/latex/wx/tabevent.tex +++ /dev/null @@ -1,41 +0,0 @@ -\section{\class{wxTabEvent}}\label{wxtabevent} - -This class represents the events generated by a tab control. - -\wxheading{Derived from} - -\helpref{wxCommandEvent}{wxcommandevent}\\ -\helpref{wxEvent}{wxevent}\\ -\helpref{wxEvtHandler}{wxevthandler}\\ -\helpref{wxObject}{wxobject} - -\wxheading{Include files} - - - -\wxheading{Event table macros} - -To process a tab event, use these event handler macros to direct input to member -functions that take a wxTabEvent argument. - -\twocolwidtha{7cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{{\bf EVT\_TAB\_SEL\_CHANGED(id, func)}}{Process a wxEVT\_TAB\_SEL\_CHANGED event, indicating that -the tab selection has changed.} -\twocolitem{{\bf EVT\_TAB\_SEL\_CHANGING(id, func)}}{Process a wxEVT\_TAB\_SEL\_CHANGING event, indicating that -the tab selection is changing.} -\end{twocollist}% - -\wxheading{See also} - -\helpref{wxTabCtrl}{wxtabctrl} - -\latexignore{\rtfignore{\wxheading{Members}}} - -\membersection{wxTabEvent::wxTabEvent}\label{wxtabeventconstr} - -\func{}{wxTabEvent}{\param{WXTYPE}{ commandType = 0}, \param{int}{ id = 0}} - -Constructor. - -