git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@29255
c3d73ce0-8a6f-49c7-b76d-
6d57e0e08775
19 files changed:
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxEvent::widthSash}
+\membersection{wxEvent::widthSash}\label{wxeventwidthsash}
\member{const wxCoord}{widthSash}
The width of the splitter sash.
\member{const wxCoord}{widthSash}
The width of the splitter sash.
-\membersection{wxSplitterRenderParams::border}
+\membersection{wxSplitterRenderParams::border}\label{wxsplitterrenderparamsborder}
\member{const wxCoord}{border}
The width of the border drawn by the splitter inside it, may be $0$.
\member{const wxCoord}{border}
The width of the border drawn by the splitter inside it, may be $0$.
-\membersection{wxSplitterRenderParams::isHotSensitive}
+\membersection{wxSplitterRenderParams::isHotSensitive}\label{wxsplitterrenderparamsishotsensitive}
\member{const bool}{isHotSensitive}
\member{const bool}{isHotSensitive}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxSplitterWindow::wxSplitterWindow}\label{wxsplitterwindowconstr}
+\membersection{wxSplitterWindow::wxSplitterWindow}\label{wxsplitterwindowctor}
\func{}{wxSplitterWindow}{\void}
\func{}{wxSplitterWindow}{\void}
\helpref{wxSplitterWindow::SplitHorizontally}{wxsplitterwindowsplithorizontally},\rtfsp
\helpref{wxSplitterWindow::Create}{wxsplitterwindowcreate}
\helpref{wxSplitterWindow::SplitHorizontally}{wxsplitterwindowsplithorizontally},\rtfsp
\helpref{wxSplitterWindow::Create}{wxsplitterwindowcreate}
-\membersection{wxSplitterWindow::\destruct{wxSplitterWindow}}
+\membersection{wxSplitterWindow::\destruct{wxSplitterWindow}}\label{wxsplitterwindowdtor}
\func{}{\destruct{wxSplitterWindow}}{\void}
\func{}{\destruct{wxSplitterWindow}}{\void}
\param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
\param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
-Creation function, for two-step construction. See \helpref{wxSplitterWindow::wxSplitterWindow}{wxsplitterwindowconstr} for
+Creation function, for two-step construction. See \helpref{wxSplitterWindow::wxSplitterWindow}{wxsplitterwindowctor} for
details.
\membersection{wxSplitterWindow::GetMinimumPaneSize}\label{wxsplitterwindowgetminimumpanesize}
details.
\membersection{wxSplitterWindow::GetMinimumPaneSize}\label{wxsplitterwindowgetminimumpanesize}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxStaticBox::wxStaticBox}\label{wxstaticboxconstr}
+\membersection{wxStaticBox::wxStaticBox}\label{wxstaticboxctor}
\func{}{wxStaticBox}{\void}
\func{}{wxStaticBox}{\void}
\helpref{wxStaticBox::Create}{wxstaticboxcreate}
\helpref{wxStaticBox::Create}{wxstaticboxcreate}
-\membersection{wxStaticBox::\destruct{wxStaticBox}}
+\membersection{wxStaticBox::\destruct{wxStaticBox}}\label{wxstaticboxdtor}
\func{void}{\destruct{wxStaticBox}}{\void}
\func{void}{\destruct{wxStaticBox}}{\void}
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}}
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}}
-Creates the static box for two-step construction. See \helpref{wxStaticBox::wxStaticBox}{wxstaticboxconstr}\rtfsp
+Creates the static box for two-step construction. See \helpref{wxStaticBox::wxStaticBox}{wxstaticboxctor}\rtfsp
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxStatusBar::wxStatusBar}\label{wxstatusbarconstr}
+\membersection{wxStatusBar::wxStatusBar}\label{wxstatusbarctor}
\func{}{wxStatusBar}{\void}
\func{}{wxStatusBar}{\void}
\helpref{wxStatusBar::Create}{wxstatusbarcreate}
\helpref{wxStatusBar::Create}{wxstatusbarcreate}
-\membersection{wxStatusBar::\destruct{wxStatusBar}}
+\membersection{wxStatusBar::\destruct{wxStatusBar}}\label{wxstatusbardtor}
\func{void}{\destruct{wxStatusBar}}{\void}
\func{void}{\destruct{wxStatusBar}}{\void}
Creates the window, for two-step construction.
Creates the window, for two-step construction.
-See \helpref{wxStatusBar::wxStatusBar}{wxstatusbarconstr} for details.
+See \helpref{wxStatusBar::wxStatusBar}{wxstatusbarctor} for details.
\membersection{wxStatusBar::GetFieldRect}\label{wxstatusbargetfieldrect}
\membersection{wxStatusBar::GetFieldRect}\label{wxstatusbargetfieldrect}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxStopWatch::wxStopWatch}
+\membersection{wxStopWatch::wxStopWatch}\label{wxstopwatchctor}
\func{}{wxStopWatch}{\void}
\func{}{wxStopWatch}{\void}
(Re)starts the stop watch with a given initial value.
(Re)starts the stop watch with a given initial value.
-\membersection{wxStopWatch::Time}
+\membersection{wxStopWatch::Time}\label{wxstopwatchtime}
\constfunc{long}{Time}{\void}\label{wxstopwatchtime}
\constfunc{long}{Time}{\void}\label{wxstopwatchtime}
% -----------
% ctor & dtor
% -----------
% -----------
% ctor & dtor
% -----------
-\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufconst}
+\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufferctor}
\func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
\func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
\helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
\helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
-\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}
+\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}\label{wxstreambufferdtor}
\func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
\func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
See \helpref{Read}{wxstreambufferread}.
See \helpref{Read}{wxstreambufferread}.
-\membersection{wxStreamBuffer::GetChar}
+\membersection{wxStreamBuffer::GetChar}\label{wxstreambuffergetchar}
\func{char}{GetChar}{\void}
\func{char}{GetChar}{\void}
\helpref{wxStreamBuffer::Read}{wxstreambufferread}
\helpref{wxStreamBuffer::Read}{wxstreambufferread}
-\membersection{wxStreamBuffer::PutChar}
+\membersection{wxStreamBuffer::PutChar}\label{wxstreambufferputchar}
\func{void}{PutChar}{\param{char }{c}}
\func{void}{PutChar}{\param{char }{c}}
\helpref{wxStreamBuffer::Read}{wxstreambufferwrite}
\helpref{wxStreamBuffer::Read}{wxstreambufferwrite}
-\membersection{wxStreamBuffer::Tell}
+\membersection{wxStreamBuffer::Tell}\label{wxstreambuffertell}
\constfunc{off\_t}{Tell}{\void}
\constfunc{off\_t}{Tell}{\void}
% --------------
% Buffer control
% --------------
% --------------
% Buffer control
% --------------
-\membersection{wxStreamBuffer::ResetBuffer}
+\membersection{wxStreamBuffer::ResetBuffer}\label{wxstreambufferresetbuffer}
\func{void}{ResetBuffer}{\void}
\func{void}{ResetBuffer}{\void}
Specifies which pointers to use for stream buffering. You need to pass a pointer on the
start of the buffer end and another on the end. The object will use this buffer
to cache stream data. It may be used also as a source/destination buffer when
Specifies which pointers to use for stream buffering. You need to pass a pointer on the
start of the buffer end and another on the end. The object will use this buffer
to cache stream data. It may be used also as a source/destination buffer when
-you create an empty stream buffer (See \helpref{wxStreamBuffer::wxStreamBuffer}{wxstreambufconst}).
+you create an empty stream buffer (See \helpref{wxStreamBuffer::wxStreamBuffer}{wxstreambufferctor}).
-\helpref{wxStreamBuffer constructor}{wxstreambufconst}\\
+\helpref{wxStreamBuffer constructor}{wxstreambufferctor}\\
\helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
\helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
\helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
\helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
\helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
\helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
\helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
\helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
-\membersection{wxStreamBuffer::GetBufferStart}
+\membersection{wxStreamBuffer::GetBufferStart}\label{wxstreambuffergetbufferstart}
\constfunc{char *}{GetBufferStart}{\void}
Returns a pointer on the start of the stream buffer.
\constfunc{char *}{GetBufferStart}{\void}
Returns a pointer on the start of the stream buffer.
-\membersection{wxStreamBuffer::GetBufferEnd}
+\membersection{wxStreamBuffer::GetBufferEnd}\label{wxstreambuffergetbufferend}
\constfunc{char *}{GetBufferEnd}{\void}
Returns a pointer on the end of the stream buffer.
\constfunc{char *}{GetBufferEnd}{\void}
Returns a pointer on the end of the stream buffer.
-\membersection{wxStreamBuffer::GetBufferPos}
+\membersection{wxStreamBuffer::GetBufferPos}\label{wxstreambuffergetbufferpos}
\constfunc{char *}{GetBufferPos}{\void}
Returns a pointer on the current position of the stream buffer.
\constfunc{char *}{GetBufferPos}{\void}
Returns a pointer on the current position of the stream buffer.
-\membersection{wxStreamBuffer::GetIntPosition}
+\membersection{wxStreamBuffer::GetIntPosition}\label{wxstreambuffergetintposition}
\constfunc{off\_t}{GetIntPosition}{\void}
Returns the current position (counted in bytes) in the stream buffer.
\constfunc{off\_t}{GetIntPosition}{\void}
Returns the current position (counted in bytes) in the stream buffer.
-\membersection{wxStreamBuffer::SetIntPosition}
+\membersection{wxStreamBuffer::SetIntPosition}\label{wxstreambuffersetintposition}
\func{void}{SetIntPosition}{\param{size\_t}{ pos}}
\func{void}{SetIntPosition}{\param{size\_t}{ pos}}
Since it is a very low-level function, there is no check on the position:
specifing an invalid position can induce unexpected results.
Since it is a very low-level function, there is no check on the position:
specifing an invalid position can induce unexpected results.
-\membersection{wxStreamBuffer::GetLastAccess}
+\membersection{wxStreamBuffer::GetLastAccess}\label{wxstreambuffergetlastaccess}
\constfunc{size\_t}{GetLastAccess}{\void}
\constfunc{size\_t}{GetLastAccess}{\void}
Toggles the flushable flag. If {\it flushable} is disabled, no data are sent
to the parent stream.
Toggles the flushable flag. If {\it flushable} is disabled, no data are sent
to the parent stream.
-\membersection{wxStreamBuffer::FlushBuffer}
+\membersection{wxStreamBuffer::FlushBuffer}\label{wxstreambufferflushbuffer}
\func{bool}{FlushBuffer}{\void}
Flushes the IO buffer.
\func{bool}{FlushBuffer}{\void}
Flushes the IO buffer.
-\membersection{wxStreamBuffer::FillBuffer}
+\membersection{wxStreamBuffer::FillBuffer}\label{wxstreambufferfillbuffer}
\func{bool}{FillBuffer}{\void}
Fill the IO buffer.
\func{bool}{FillBuffer}{\void}
Fill the IO buffer.
-\membersection{wxStreamBuffer::GetDataLeft}
+\membersection{wxStreamBuffer::GetDataLeft}\label{wxstreambuffergetdataleft}
\func{size\_t}{GetDataLeft}{\void}
\func{size\_t}{GetDataLeft}{\void}
% --------------
% Administration
% --------------
% --------------
% Administration
% --------------
-\membersection{wxStreamBuffer::Stream}
+\membersection{wxStreamBuffer::Stream}\label{wxstreambufferstream}
\func{wxStreamBase*}{Stream}{\void}
\func{wxStreamBase*}{Stream}{\void}
% ctor & dtor
% -----------
% ctor & dtor
% -----------
-\membersection{wxStreamBase::wxStreamBase}
+\membersection{wxStreamBase::wxStreamBase}\label{wxstreambasector}
\func{}{wxStreamBase}{\void}
Creates a dummy stream object. It doesn't do anything.
\func{}{wxStreamBase}{\void}
Creates a dummy stream object. It doesn't do anything.
-\membersection{wxStreamBase::\destruct{wxStreamBase}}
+\membersection{wxStreamBase::\destruct{wxStreamBase}}\label{wxstreambasedtor}
\func{}{\destruct{wxStreamBase}}{\void}
\func{}{\destruct{wxStreamBase}}{\void}
Internal function. It is called when the stream wants to read data of the
specified size. It should return the size that was actually read.
Internal function. It is called when the stream wants to read data of the
specified size. It should return the size that was actually read.
-\membersection{wxStreamBase::OnSysSeek}
+\membersection{wxStreamBase::OnSysSeek}\label{wxstreambaseonsysseek}
\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
Internal function. It is called when the stream needs to change the
current position.
\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
Internal function. It is called when the stream needs to change the
current position.
-\membersection{wxStreamBase::OnSysTell}
+\membersection{wxStreamBase::OnSysTell}\label{wxstreambaseonsystell}
\constfunc{off\_t}{OnSysTell}{\void}
Internal function. Is is called when the stream needs to know the
real position.
\constfunc{off\_t}{OnSysTell}{\void}
Internal function. Is is called when the stream needs to know the
real position.
-\membersection{wxStreamBase::OnSysWrite}
+\membersection{wxStreamBase::OnSysWrite}\label{wxstreambaseonsyswrite}
\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}}
\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}}
\docparam{ostr}{The C++ stream to redirect, {\it cout} is used if it is NULL}
\docparam{ostr}{The C++ stream to redirect, {\it cout} is used if it is NULL}
-\membersection{wxStreamToTextRedirector::\destruct{wxStreamToTextRedirector}}
+\membersection{wxStreamToTextRedirector::\destruct{wxStreamToTextRedirector}}\label{wxstreamtotextredirectordtor}
\func{}{\destruct{wxStreamToTextRedirector}}{\void}
\func{}{\destruct{wxStreamToTextRedirector}}{\void}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxTaskBarIcon::wxTaskBarIcon}\label{wxtaskbariconconstr}
+\membersection{wxTaskBarIcon::wxTaskBarIcon}\label{wxtaskbariconctor}
\func{}{wxTaskBarIcon}{\void}
Default constructor.
\func{}{wxTaskBarIcon}{\void}
Default constructor.
-\membersection{wxTaskBarIcon::\destruct{wxTaskBarIcon}}
+\membersection{wxTaskBarIcon::\destruct{wxTaskBarIcon}}\label{wxtaskbaricondtor}
\func{}{\destruct{wxTaskBarIcon}}{\void}
\func{}{\destruct{wxTaskBarIcon}}{\void}
\end{twocollist}
See also \helpref{window styles overview}{windowstyles} and
\end{twocollist}
See also \helpref{window styles overview}{windowstyles} and
-\helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}.
+\helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlctor}.
\wxheading{wxTextCtrl text format}
\wxheading{wxTextCtrl text format}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlconstr}
+\membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlctor}
\func{}{wxTextCtrl}{\void}
\func{}{wxTextCtrl}{\void}
\helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator}
\helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator}
-\membersection{wxTextCtrl::\destruct{wxTextCtrl}}
+\membersection{wxTextCtrl::\destruct{wxTextCtrl}}\label{wxtextctrldtor}
\func{}{\destruct{wxTextCtrl}}{\void}
\func{}{\destruct{wxTextCtrl}}{\void}
\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxTextCtrlNameStr}}
Creates the text control for two-step construction. Derived classes
\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxTextCtrlNameStr}}
Creates the text control for two-step construction. Derived classes
-should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}\rtfsp
+should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlctor}\rtfsp
Copies the selected text to the clipboard and removes the selection.
Copies the selected text to the clipboard and removes the selection.
-\membersection{wxTextCtrl::DiscardEdits}
+\membersection{wxTextCtrl::DiscardEdits}\label{wxtextctrldiscardedits}
\func{void}{DiscardEdits}{\void}
Resets the internal `modified' flag as if the current edits had been saved.
\func{void}{DiscardEdits}{\void}
Resets the internal `modified' flag as if the current edits had been saved.
-\membersection{wxTextCtrl::EmulateKeyPress}
+\membersection{wxTextCtrl::EmulateKeyPress}\label{wxtextctrlemulatekeypress}
\func{bool}{EmulateKeyPress}{\param{const wxKeyEvent\& }{event}}
\func{bool}{EmulateKeyPress}{\param{const wxKeyEvent\& }{event}}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxTextEntryDialog::wxTextEntryDialog}\label{wxtextentrydialogconstr}
+\membersection{wxTextEntryDialog::wxTextEntryDialog}\label{wxtextentrydialogctor}
\func{}{wxTextEntryDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
\param{const wxString\& }{caption = "Please enter text"}, \param{const wxString\& }{defaultValue = ""}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
\func{}{wxTextEntryDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
\param{const wxString\& }{caption = "Please enter text"}, \param{const wxString\& }{defaultValue = ""}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
\docparam{pos}{Dialog position.}
\docparam{pos}{Dialog position.}
-\membersection{wxTextEntryDialog::\destruct{wxTextEntryDialog}}
+\membersection{wxTextEntryDialog::\destruct{wxTextEntryDialog}}\label{wxtextentrydialogdtor}
\func{}{\destruct{wxTextEntryDialog}}{\void}
\func{}{\destruct{wxTextEntryDialog}}{\void}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxTreeItemData::wxTreeItemData}\label{wxtreeitemdataconstr}
+\membersection{wxTreeItemData::wxTreeItemData}\label{wxtreeitemdatactor}
\func{}{wxTreeItemData}{\void}
\func{}{wxTreeItemData}{\void}
{\bf GetData()}, and set it by calling {\bf SetData( data ).}
}
{\bf GetData()}, and set it by calling {\bf SetData( data ).}
}
-\membersection{wxTreeItemData::\destruct{wxTreeItemData}}
+\membersection{wxTreeItemData::\destruct{wxTreeItemData}}\label{wxtreeitemdatadtor}
\func{void}{\destruct{wxTreeItemData}}{\void}
\func{void}{\destruct{wxTreeItemData}}{\void}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxTreeEvent::wxTreeEvent}
+\membersection{wxTreeEvent::wxTreeEvent}\label{wxtreeeventctor}
\func{}{wxTreeEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
Constructor.
\func{}{wxTreeEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
Constructor.
-\membersection{wxTreeEvent::GetKeyCode}
+\membersection{wxTreeEvent::GetKeyCode}\label{wxtreeeventgetkeycode}
\constfunc{int}{GetKeyCode}{}
\constfunc{int}{GetKeyCode}{}
\helpref{GetKeyEvent}{wxtreeeventgetkeyevent} to get the values of the
modifier keys for this event (i.e. Shift or Ctrl).
\helpref{GetKeyEvent}{wxtreeeventgetkeyevent} to get the values of the
modifier keys for this event (i.e. Shift or Ctrl).
-\membersection{wxTreeEvent::GetItem}
+\membersection{wxTreeEvent::GetItem}\label{wxtreeeventgetitem}
\constfunc{wxTreeItemId}{GetItem}{}
\constfunc{wxTreeItemId}{GetItem}{}
Returns the key event for {\tt EVT\_TREE\_KEY\_DOWN} events.
Returns the key event for {\tt EVT\_TREE\_KEY\_DOWN} events.
-\membersection{wxTreeEvent::GetLabel}
+\membersection{wxTreeEvent::GetLabel}\label{wxtreeeventgetlabel}
\constfunc{const wxString\&}{GetLabel}{}
Returns the label if the event was a begin or end edit label event.
\constfunc{const wxString\&}{GetLabel}{}
Returns the label if the event was a begin or end edit label event.
-\membersection{wxTreeEvent::GetOldItem}
+\membersection{wxTreeEvent::GetOldItem}\label{wxtreeeventgetolditem}
\constfunc{wxTreeItemId}{GetOldItem}{}
Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
\constfunc{wxTreeItemId}{GetOldItem}{}
Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
-\membersection{wxTreeEvent::GetPoint()}
+\membersection{wxTreeEvent::GetPoint()}\label{wxtreeeventgetpoint}
\constfunc{wxPoint}{GetPoint}{}
Returns the position of the mouse pointer if the event is a drag event.
\constfunc{wxPoint}{GetPoint}{}
Returns the position of the mouse pointer if the event is a drag event.
-\membersection{wxTreeEvent::IsEditCancelled()}
+\membersection{wxTreeEvent::IsEditCancelled()}\label{wxtreeeventiseditcancelled}
\constfunc{bool}{IsEditCancelled}{}
Returns true if the label edit was cancelled. This should be
called from within an EVT\_TREE\_END\_LABEL\_EDIT handler.
\constfunc{bool}{IsEditCancelled}{}
Returns true if the label edit was cancelled. This should be
called from within an EVT\_TREE\_END\_LABEL\_EDIT handler.
-\membersection{wxTreeEvent::SetToolTip}
+\membersection{wxTreeEvent::SetToolTip}\label{wxtreeeventsettooltip}
\func{void}{SetToolTip}{\param{const wxString\&}{ tooltip}}
\func{void}{SetToolTip}{\param{const wxString\&}{ tooltip}}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamconstr}
+\membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamctor}
\func{}{wxTextInputStream}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ sep=" $\backslash$t"},
\param{wxMBConv\&}{ conv = wxConvUTF8} }
\func{}{wxTextInputStream}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ sep=" $\backslash$t"},
\param{wxMBConv\&}{ conv = wxConvUTF8} }
\docparam{conv}{{\it In Unicode build only:} The encoding converter used to convert the bytes in the
underlying input stream to characters.}
\docparam{conv}{{\it In Unicode build only:} The encoding converter used to convert the bytes in the
underlying input stream to characters.}
-\membersection{wxTextInputStream::\destruct{wxTextInputStream}}
+\membersection{wxTextInputStream::\destruct{wxTextInputStream}}\label{wxtextinputstreamdtor}
\func{}{\destruct{wxTextInputStream}}{\void}
\func{}{\destruct{wxTextInputStream}}{\void}
which may have leading zeroes as they can yield unexpected (to the user not
familiar with C) results.
which may have leading zeroes as they can yield unexpected (to the user not
familiar with C) results.
-\membersection{wxTextInputStream::Read8S}
+\membersection{wxTextInputStream::Read8S}\label{wxtextinputstreamread8s}
\func{wxInt8}{Read8S}{\param{int}{ base = 10}}
\func{wxInt8}{Read8S}{\param{int}{ base = 10}}
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
-\membersection{wxTextInputStream::Read16}
+\membersection{wxTextInputStream::Read16}\label{wxtextinputstreamread16}
\func{wxUint16}{Read16}{\param{int}{ base = 10}}
\func{wxUint16}{Read16}{\param{int}{ base = 10}}
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
-\membersection{wxTextInputStream::Read16S}
+\membersection{wxTextInputStream::Read16S}\label{wxtextinputstreamread16s}
\func{wxInt16}{Read16S}{\param{int}{ base = 10}}
\func{wxInt16}{Read16S}{\param{int}{ base = 10}}
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
-\membersection{wxTextInputStream::Read32}
+\membersection{wxTextInputStream::Read32}\label{wxtextinputstreamread32}
\func{wxUint32}{Read32}{\param{int}{ base = 10}}
\func{wxUint32}{Read32}{\param{int}{ base = 10}}
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
-\membersection{wxTextInputStream::Read32S}
+\membersection{wxTextInputStream::Read32S}\label{wxtextinputstreamread32s}
\func{wxInt32}{Read32S}{\param{int}{ base = 10}}
\func{wxInt32}{Read32S}{\param{int}{ base = 10}}
Reads a character, returns $0$ if there are no more characters in the stream.
Reads a character, returns $0$ if there are no more characters in the stream.
-\membersection{wxTextInputStream::ReadDouble}
+\membersection{wxTextInputStream::ReadDouble}\label{wxtextinputstreamreaddouble}
\func{double}{ReadDouble}{\void}
\func{double}{ReadDouble}{\void}
Reads a line from the input stream and returns it (without the end of line
character).
Reads a line from the input stream and returns it (without the end of line
character).
-\membersection{wxTextInputStream::ReadString}
+\membersection{wxTextInputStream::ReadString}\label{wxtextinputstreamreadstring}
\func{wxString}{wxTextInputStream::ReadString}{\void}
\func{wxString}{wxTextInputStream::ReadString}{\void}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamconstr}
+\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamctor}
\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
\docparam{conv}{{\it In Unicode build only:} The object used to convert
Unicode text into ASCII characters written to the output stream.}
\docparam{conv}{{\it In Unicode build only:} The object used to convert
Unicode text into ASCII characters written to the output stream.}
-\membersection{wxTextOutputStream::\destruct{wxTextOutputStream}}
+\membersection{wxTextOutputStream::\destruct{wxTextOutputStream}}\label{wxtextoutputstreamdtor}
\func{}{\destruct{wxTextOutputStream}}{\void}
Destroys the wxTextOutputStream object.
\func{}{\destruct{wxTextOutputStream}}{\void}
Destroys the wxTextOutputStream object.
-\membersection{wxTextOutputStream::GetMode}
+\membersection{wxTextOutputStream::GetMode}\label{wxtextoutputstreamgetmode}
\func{wxEOL}{wxTextOutputStream::GetMode}{\void}
Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
\func{wxEOL}{wxTextOutputStream::GetMode}{\void}
Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
-\membersection{wxTextOutputStream::SetMode}
+\membersection{wxTextOutputStream::SetMode}\label{wxtextoutputstreamsetmode}
\func{void}{wxTextOutputStream::SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}}
Set the end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
\func{void}{wxTextOutputStream::SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}}
Set the end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
-\membersection{wxTextOutputStream::Write8}
+\membersection{wxTextOutputStream::Write8}\label{wxtextoutputstreamwrite8}
\func{void}{wxTextOutputStream::Write8}{{\param wxUint8 }{i8}}
Writes the single byte {\it i8} to the stream.
\func{void}{wxTextOutputStream::Write8}{{\param wxUint8 }{i8}}
Writes the single byte {\it i8} to the stream.
-\membersection{wxTextOutputStream::Write16}
+\membersection{wxTextOutputStream::Write16}\label{wxtextoutputstreamwrite16}
\func{void}{wxTextOutputStream::Write16}{{\param wxUint16 }{i16}}
Writes the 16 bit integer {\it i16} to the stream.
\func{void}{wxTextOutputStream::Write16}{{\param wxUint16 }{i16}}
Writes the 16 bit integer {\it i16} to the stream.
-\membersection{wxTextOutputStream::Write32}
+\membersection{wxTextOutputStream::Write32}\label{wxtextoutputstreamwrite32}
\func{void}{wxTextOutputStream::Write32}{{\param wxUint32 }{i32}}
Writes the 32 bit integer {\it i32} to the stream.
\func{void}{wxTextOutputStream::Write32}{{\param wxUint32 }{i32}}
Writes the 32 bit integer {\it i32} to the stream.
-\membersection{wxTextOutputStream::WriteDouble}
+\membersection{wxTextOutputStream::WriteDouble}\label{wxtextoutputstreamwritedouble}
\func{virtual void}{wxTextOutputStream::WriteDouble}{{\param double }{f}}
Writes the double {\it f} to the stream using the IEEE format.
\func{virtual void}{wxTextOutputStream::WriteDouble}{{\param double }{f}}
Writes the double {\it f} to the stream using the IEEE format.
-\membersection{wxTextOutputStream::WriteString}
+\membersection{wxTextOutputStream::WriteString}\label{wxtextoutputstreamwritestring}
\func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}}
\func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxUpdateUIEvent::wxUpdateUIEvent}
+\membersection{wxUpdateUIEvent::wxUpdateUIEvent}\label{wxupdateuieventctor}
\func{}{wxUpdateUIEvent}{\param{wxWindowID }{commandId = 0}}
Constructor.
\func{}{wxUpdateUIEvent}{\param{wxWindowID }{commandId = 0}}
Constructor.
-\membersection{wxUpdateUIEvent::m\_checked}
+\membersection{wxUpdateUIEvent::m\_checked}\label{wxupdateuieventmchecked}
\member{bool}{m\_checked}
true if the element should be checked, false otherwise.
\member{bool}{m\_checked}
true if the element should be checked, false otherwise.
-\membersection{wxUpdateUIEvent::m\_enabled}
+\membersection{wxUpdateUIEvent::m\_enabled}\label{wxupdateuieventmenabled}
\member{bool}{m\_checked}
true if the element should be enabled, false otherwise.
\member{bool}{m\_checked}
true if the element should be enabled, false otherwise.
-\membersection{wxUpdateUIEvent::m\_setChecked}
+\membersection{wxUpdateUIEvent::m\_setChecked}\label{wxupdateuieventmsetchecked}
\member{bool}{m\_setChecked}
true if the application has set the {\bf m\_checked} member.
\member{bool}{m\_setChecked}
true if the application has set the {\bf m\_checked} member.
-\membersection{wxUpdateUIEvent::m\_setEnabled}
+\membersection{wxUpdateUIEvent::m\_setEnabled}\label{wxupdateuieventmsetenabled}
\member{bool}{m\_setEnabled}
true if the application has set the {\bf m\_enabled} member.
\member{bool}{m\_setEnabled}
true if the application has set the {\bf m\_enabled} member.
-\membersection{wxUpdateUIEvent::m\_setText}
+\membersection{wxUpdateUIEvent::m\_setText}\label{wxupdateuieventmsettext}
\member{bool}{m\_setText}
true if the application has set the {\bf m\_text} member.
\member{bool}{m\_setText}
true if the application has set the {\bf m\_text} member.
-\membersection{wxUpdateUIEvent::m\_text}
+\membersection{wxUpdateUIEvent::m\_text}\label{wxupdateuieventmtext}
\member{wxString}{m\_text}
\member{wxString}{m\_text}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxURL::wxURL}\label{wxurlconstr}
+\membersection{wxURL::wxURL}\label{wxurlctor}
\func{}{wxURL}{\param{const wxString\&}{ url}}
\func{}{wxURL}{\param{const wxString\&}{ url}}
\docparam{url}{Url string to parse.}
\docparam{url}{Url string to parse.}
-\membersection{wxURL::\destruct{wxURL}}
+\membersection{wxURL::\destruct{wxURL}}\label{wxurldtor}
\func{}{\destruct{wxURL}}{\void}
\func{}{\destruct{wxURL}}{\void}
-\membersection{wxURL::GetProtocolName}
+\membersection{wxURL::GetProtocolName}\label{wxurlgetprotocolname}
\constfunc{wxString}{GetProtocolName}{\void}
\constfunc{wxString}{GetProtocolName}{\void}
-\membersection{wxURL::GetProtocol}
+\membersection{wxURL::GetProtocol}\label{wxurlgetprotocol}
\func{wxProtocol\&}{GetProtocol}{\void}
\func{wxProtocol\&}{GetProtocol}{\void}
-\membersection{wxURL::GetPath}
+\membersection{wxURL::GetPath}\label{wxurlgetpath}
\func{wxString}{GetPath}{\void}
\func{wxString}{GetPath}{\void}
-\membersection{wxURL::GetError}
+\membersection{wxURL::GetError}\label{wxurlgeterror}
\constfunc{wxURLError}{GetError}{\void}
\constfunc{wxURLError}{GetError}{\void}
-\membersection{wxURL::GetInputStream}
+\membersection{wxURL::GetInputStream}\label{wxurlgetinputstream}
\func{wxInputStream *}{GetInputStream}{\void}
\func{wxInputStream *}{GetInputStream}{\void}
-\membersection{wxURL::ConvertToValidURI}
+\membersection{wxURL::ConvertToValidURI}\label{wxurlconverttovaliduri}
\func{static wxString}{ConvertToValidURI}{\param{const wxString\&}{ uri}}
\func{static wxString}{ConvertToValidURI}{\param{const wxString\&}{ uri}}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxValidator::wxValidator}\label{wxvalidatorconstr}
+\membersection{wxValidator::wxValidator}\label{wxvalidatorctor}
\func{}{wxValidator}{\void}
Constructor.
\func{}{wxValidator}{\void}
Constructor.
-\membersection{wxValidator::\destruct{wxValidator}}
+\membersection{wxValidator::\destruct{wxValidator}}\label{wxvalidatordtor}
\func{}{\destruct{wxValidator}}{\void}
\func{}{\destruct{wxValidator}}{\void}
Returns the window associated with the validator.
Returns the window associated with the validator.
-\membersection{wxValidator::SetBellOnError}{wxvalidatorsetbellonerror}
+\membersection{wxValidator::SetBellOnError}\label{wxvalidatorsetbellonerror}
\func{void}{SetBellOnError}{\param{bool}{ doIt = true}}
\func{void}{SetBellOnError}{\param{bool}{ doIt = true}}
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxTextValidator::wxTextValidator}\label{wxtextvalidatorconstr}
+\membersection{wxTextValidator::wxTextValidator}\label{wxtextvalidatorctor}
\func{}{wxTextValidator}{\param{const wxTextValidator\&}{ validator}}
\func{}{wxTextValidator}{\param{const wxTextValidator\&}{ validator}}
determined by the lifetime of the window). % If NULL, the validator uses its own internal storage for the value. NOT true
}
determined by the lifetime of the window). % If NULL, the validator uses its own internal storage for the value. NOT true
}
-\membersection{wxTextValidator::\destruct{wxTextValidator}}
+\membersection{wxTextValidator::\destruct{wxTextValidator}}\label{wxtextvalidatordtor}
\func{}{\destruct{wxTextValidator}}{\void}
\func{}{\destruct{wxTextValidator}}{\void}
\latexignore{\rtfignore{\wxheading{Function groups}}}
\latexignore{\rtfignore{\wxheading{Function groups}}}
-\membersection{Constructors and assignment operators}
+\membersection{Constructors and assignment operators}\label{constructorsinwxstring}
A string may be constructed either from a C string, (some number of copies of)
a single character or a wide (UNICODE) string. For all constructors (except the
A string may be constructed either from a C string, (some number of copies of)
a single character or a wide (UNICODE) string. For all constructors (except the
\helpref{operator $=$}{wxstringoperatorassign}\\
\helpref{\destruct{wxString}}{wxstringdestruct}
\helpref{operator $=$}{wxstringoperatorassign}\\
\helpref{\destruct{wxString}}{wxstringdestruct}
-\membersection{String length}
+\membersection{String length}\label{lengthfunctionsinwxstring}
These functions return the string length and check whether the string is empty
or empty it.
These functions return the string length and check whether the string is empty
or empty it.
\helpref{Empty}{wxstringempty}\\
\helpref{Clear}{wxstringclear}
\helpref{Empty}{wxstringempty}\\
\helpref{Clear}{wxstringclear}
-\membersection{Character access}
+\membersection{Character access}\label{characteraccessinwxstring}
Many functions in this section take a character index in the string. As with C
strings and/or arrays, the indices start from $0$, so the first character of a
Many functions in this section take a character index in the string. As with C
strings and/or arrays, the indices start from $0$, so the first character of a
\helpref{fn\_str}{wxstringfnstr}\\
\helpref{operator const char*}{wxstringoperatorconstcharpt}
\helpref{fn\_str}{wxstringfnstr}\\
\helpref{operator const char*}{wxstringoperatorconstcharpt}
-\membersection{Concatenation}
+\membersection{Concatenation}\label{concatenationinwxstring}
Anything may be concatenated (appended to) with a string. However, you can't
append something to a C string (including literal constants), so to do this it
Anything may be concatenated (appended to) with a string. However, you can't
append something to a C string (including literal constants), so to do this it
\helpref{Append}{wxstringappend}\\
\helpref{Prepend}{wxstringprepend}
\helpref{Append}{wxstringappend}\\
\helpref{Prepend}{wxstringprepend}
-\membersection{Comparison}
+\membersection{Comparison}\label{comparisoninwxstring}
The default comparison function \helpref{Cmp}{wxstringcmp} is case-sensitive and
so is the default version of \helpref{IsSameAs}{wxstringissameas}. For case
The default comparison function \helpref{Cmp}{wxstringcmp} is case-sensitive and
so is the default version of \helpref{IsSameAs}{wxstringissameas}. For case
\helpref{Matches}{wxstringmatches}\\
\helpref{StartsWith}{wxstringstartswith}
\helpref{Matches}{wxstringmatches}\\
\helpref{StartsWith}{wxstringstartswith}
-\membersection{Substring extraction}
+\membersection{Substring extraction}\label{substringextractioninwxstring}
These functions allow to extract substring from this string. All of them don't
modify the original string and return a new string containing the extracted
These functions allow to extract substring from this string. All of them don't
modify the original string and return a new string containing the extracted
\helpref{AfterLast}{wxstringafterlast}\\
\helpref{StartsWith}{wxstringstartswith}
\helpref{AfterLast}{wxstringafterlast}\\
\helpref{StartsWith}{wxstringstartswith}
-\membersection{Case conversion}
+\membersection{Case conversion}\label{caseconversioninwxstring}
The MakeXXX() variants modify the string in place, while the other functions
return a new string which contains the original text converted to the upper or
The MakeXXX() variants modify the string in place, while the other functions
return a new string which contains the original text converted to the upper or
\helpref{MakeLower}{wxstringmakelower}\\
\helpref{Lower}{wxstringlower}
\helpref{MakeLower}{wxstringmakelower}\\
\helpref{Lower}{wxstringlower}
-\membersection{Searching and replacing}
+\membersection{Searching and replacing}\label{searchingandreplacinginwxstring}
These functions replace the standard {\it strchr()} and {\it strstr()}
functions.
These functions replace the standard {\it strchr()} and {\it strstr()}
functions.
\helpref{Find}{wxstringfind}\\
\helpref{Replace}{wxstringreplace}
\helpref{Find}{wxstringfind}\\
\helpref{Replace}{wxstringreplace}
-\membersection{Conversion to numbers}
+\membersection{Conversion to numbers}\label{conversiontonumbersinwxstring}
The string provides functions for conversion to signed and unsigned integer and
floating point numbers. All three functions take a pointer to the variable to
The string provides functions for conversion to signed and unsigned integer and
floating point numbers. All three functions take a pointer to the variable to
\helpref{ToULong}{wxstringtoulong}\\
\helpref{ToDouble}{wxstringtodouble}
\helpref{ToULong}{wxstringtoulong}\\
\helpref{ToDouble}{wxstringtodouble}
-\membersection{Writing values into the string}
+\membersection{Writing values into the string}\label{writingintostringinwxstring}
Both formatted versions (\helpref{Printf}{wxstringprintf}) and stream-like
insertion operators exist (for basic types only). Additionally, the
Both formatted versions (\helpref{Printf}{wxstringprintf}) and stream-like
insertion operators exist (for basic types only). Additionally, the
\helpref{PrintfV}{wxstringprintfv}\\
\helpref{operator \cinsert}{wxstringoperatorout}
\helpref{PrintfV}{wxstringprintfv}\\
\helpref{operator \cinsert}{wxstringoperatorout}
-\membersection{Memory management}
+\membersection{Memory management}\label{memoryinwxstring}
These are "advanced" functions and they will be needed quite rarely.
\helpref{Alloc}{wxstringalloc} and \helpref{Shrink}{wxstringshrink} are only
These are "advanced" functions and they will be needed quite rarely.
\helpref{Alloc}{wxstringalloc} and \helpref{Shrink}{wxstringshrink} are only
\helpref{GetWriteBuf}{wxstringgetwritebuf}\\
\helpref{UngetWriteBuf}{wxstringungetwritebuf}
\helpref{GetWriteBuf}{wxstringgetwritebuf}\\
\helpref{UngetWriteBuf}{wxstringungetwritebuf}
-\membersection{Miscellaneous}
+\membersection{Miscellaneous}\label{miscellaneousinwxstring}
\helpref{Pad}{wxstringpad}\\
\helpref{Truncate}{wxstringtruncate}
\helpref{Pad}{wxstringpad}\\
\helpref{Truncate}{wxstringtruncate}
-\membersection{wxWidgets 1.xx compatibility functions}
+\membersection{wxWidgets 1.xx compatibility functions}\label{backwardcompatibilityinwxstring}
These functions are deprecated, please consider using new wxWidgets 2.0
functions instead of them (or, even better, std::string compatible variants).
These functions are deprecated, please consider using new wxWidgets 2.0
functions instead of them (or, even better, std::string compatible variants).
projects / wxWidgets.git / commitdiff
