Update to docs incl. wxString first stab; added a couple of palette-related events (wxMSW)
needed for wxGLCanvas git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@392 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
@@ -99,7 +99,7 @@ box.
|
||||
Under Windows, only dialog box buttons respond to this function. As
|
||||
normal under Windows and Motif, pressing return causes the default button to
|
||||
be depressed when the return key is pressed. See also \helpref{wxWindow::SetFocus}{wxwindowsetfocus}\rtfsp
|
||||
which sets the keyboard focus for windows and text panel items, \helpref{wxWindow::OnDefaultAction}{wxwindowondefaultaction}\rtfsp
|
||||
which sets the keyboard focus for windows and text panel items,\rtfsp
|
||||
and \helpref{wxWindow::GetDefaultItem}{wxwindowgetdefaultitem}.
|
||||
|
||||
Note that under Motif, calling this function immediately after
|
||||
|
||||
@@ -61,6 +61,8 @@ $$\image{14cm;0cm}{wxclass.ps}$$
|
||||
\input document.tex
|
||||
\input docchfrm.tex
|
||||
\input docmanag.tex
|
||||
\input docmdich.tex
|
||||
\input docmdipr.tex
|
||||
\input docprfrm.tex
|
||||
\input doctempl.tex
|
||||
\input dropevt.tex
|
||||
@@ -144,7 +146,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$
|
||||
\input statbox.tex
|
||||
\input stattext.tex
|
||||
\input statusbr.tex
|
||||
%\input wxstring.tex
|
||||
\input wxstring.tex
|
||||
\input strlist.tex
|
||||
\input sysclevt.tex
|
||||
\input settings.tex
|
||||
|
||||
@@ -6,7 +6,7 @@ Sparc or anything else.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDataStream::wxDataStream}\label{wxwaveconstr}
|
||||
\membersection{wxDataStream::wxDataStream}\label{wxdatastreamconstr}
|
||||
|
||||
\func{}{wxDataStream}{\param{istream\&}{ stream}}
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ The view associated with the frame.
|
||||
\membersection{wxDocChildFrame::wxDocChildFrame}
|
||||
|
||||
\func{}{wxDocChildFrame}{\param{wxDocument* }{doc}, \param{wxView* }{view}, \param{wxFrame* }{parent},
|
||||
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
|
||||
\param{wxWindowID}{ id}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
|
||||
\param{const wxSize\&}{ size = wxDefaultSize},
|
||||
\param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = ``frame"}}
|
||||
|
||||
|
||||
89
docs/latex/wx/docmdich.tex
Normal file
89
docs/latex/wx/docmdich.tex
Normal file
@@ -0,0 +1,89 @@
|
||||
\section{\class{wxDocMDIChildFrame}}\label{wxdocmdichildframe}
|
||||
|
||||
The wxDocMDIChildFrame class provides a default frame for displaying documents
|
||||
on separate windows. This class can only be used for MDI child frames.
|
||||
|
||||
The class is part of the document/view framework supported by wxWindows,
|
||||
and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument},
|
||||
\rtfsp\helpref{wxDocManager}{wxdocmanager} and \helpref{wxDocTemplate}{wxdoctemplate} classes.
|
||||
|
||||
See the example application in {\tt samples/docview}.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxMDIChildFrame}{wxmdichildframe}\\
|
||||
\helpref{wxFrame}{wxframe}\\
|
||||
\helpref{wxWindow}{wxwindow}\\
|
||||
\helpref{wxEvtHandler}{wxevthandler}\\
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIChildFrame}{wxmdichildframe}
|
||||
|
||||
\membersection{wxDocMDIChildFrame::m\_childDocument}
|
||||
|
||||
\member{wxDocument*}{m\_childDocument}
|
||||
|
||||
The document associated with the frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::m\_childView}
|
||||
|
||||
\member{wxView*}{m\_childView}
|
||||
|
||||
The view associated with the frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::wxDocMDIChildFrame}
|
||||
|
||||
\func{}{wxDocMDIChildFrame}{\param{wxDocument* }{doc}, \param{wxView* }{view}, \param{wxFrame* }{parent},
|
||||
\param{wxWindowID}{ id}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
|
||||
\param{const wxSize\&}{ size = wxDefaultSize},
|
||||
\param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = ``frame"}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::\destruct{wxDocMDIChildFrame}}
|
||||
|
||||
\func{}{\destruct{wxDocMDIChildFrame}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::GetDocument}
|
||||
|
||||
\constfunc{wxDocument*}{GetDocument}{\void}
|
||||
|
||||
Returns the document associated with this frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::GetView}
|
||||
|
||||
\constfunc{wxView*}{GetView}{\void}
|
||||
|
||||
Returns the view associated with this frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::OnActivate}
|
||||
|
||||
\func{void}{OnActivate}{\param{bool}{ active}}
|
||||
|
||||
Sets the currently active view to be the frame's view. You may need
|
||||
to override (but still call) this function in order to set the keyboard
|
||||
focus for your subwindow.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::OnClose}
|
||||
|
||||
\func{virtual bool}{OnClose}{\void}
|
||||
|
||||
Closes and deletes the current view and document.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::SetDocument}
|
||||
|
||||
\func{void}{SetDocument}{\param{wxDocument *}{doc}}
|
||||
|
||||
Sets the document for this frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::SetView}
|
||||
|
||||
\func{void}{SetView}{\param{wxView *}{view}}
|
||||
|
||||
Sets the view for this frame.
|
||||
|
||||
|
||||
79
docs/latex/wx/docmdipr.tex
Normal file
79
docs/latex/wx/docmdipr.tex
Normal file
@@ -0,0 +1,79 @@
|
||||
\section{\class{wxDocMDIParentFrame}}\label{wxdocmdiparentframe}
|
||||
|
||||
The wxDocMDIParentFrame class provides a default top-level frame for
|
||||
applications using the document/view framework. This class can only be used for MDI parent frames.
|
||||
|
||||
It cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument},
|
||||
\rtfsp\helpref{wxDocManager}{wxdocmanager} and \helpref{wxDocTemplates}{wxdoctemplate} classes.
|
||||
|
||||
See the example application in {\tt samples/docview}.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxMDIParentFrame}{wxmdiparentframe}\\
|
||||
\helpref{wxFrame}{wxframe}\\
|
||||
\helpref{wxWindow}{wxwindow}\\
|
||||
\helpref{wxEvtHandler}{wxevthandler}\\
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIParentFrame}{wxmdiparentframe}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDocMDIParentFrame::wxDocMDIParentFrame}
|
||||
|
||||
\func{}{wxDocMDIParentFrame}{\param{wxFrame *}{parent}, \param{wxWindowID}{ id},
|
||||
\param{const wxString\& }{title}, \param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height},
|
||||
\param{long}{ style}, \param{const wxString\& }{name}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxDocMDIParentFrame::\destruct{wxDocMDIParentFrame}}
|
||||
|
||||
\func{}{\destruct{wxDocMDIParentFrame}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxDocMDIParentFrame::OnClose}
|
||||
|
||||
\func{bool}{OnClose}{\void}
|
||||
|
||||
Deletes all views and documents. If no user input cancelled the
|
||||
operation, the function returns TRUE and the application will exit.
|
||||
|
||||
Since understanding how document/view clean-up takes place can be difficult,
|
||||
the implementation of this function is shown below.
|
||||
|
||||
\begin{verbatim}
|
||||
bool wxDocMDIParentFrame::OnClose(void)
|
||||
{
|
||||
// Delete all views and documents
|
||||
wxNode *node = docManager->GetDocuments().First();
|
||||
while (node)
|
||||
{
|
||||
wxDocument *doc = (wxDocument *)node->Data();
|
||||
wxNode *next = node->Next();
|
||||
|
||||
if (!doc->Close())
|
||||
return FALSE;
|
||||
|
||||
// Implicitly deletes the document when the last
|
||||
// view is removed (deleted)
|
||||
doc->DeleteAllViews();
|
||||
|
||||
// Check document is deleted
|
||||
if (docManager->GetDocuments().Member(doc))
|
||||
delete doc;
|
||||
|
||||
// This assumes that documents are not connected in
|
||||
// any way, i.e. deleting one document does NOT
|
||||
// delete another.
|
||||
node = next;
|
||||
}
|
||||
return TRUE;
|
||||
}
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ See the example application in {\tt samples/docview}.
|
||||
|
||||
\membersection{wxDocParentFrame::wxDocParentFrame}
|
||||
|
||||
\func{}{wxDocParentFrame}{\param{wxFrame *}{parent},
|
||||
\func{}{wxDocParentFrame}{\param{wxFrame *}{parent}, \param{wxWindowID}{ id},
|
||||
\param{const wxString\& }{title}, \param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height},
|
||||
\param{long}{ style}, \param{const wxString\& }{name}}
|
||||
|
||||
|
||||
@@ -479,113 +479,6 @@ This function is only available under Windows.
|
||||
Globally sets the cursor; only has an effect in MS Windows.
|
||||
See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
|
||||
|
||||
\section{System event functions}
|
||||
|
||||
The wxWindows system event implementation is incomplete and
|
||||
experimental, but is intended to be a platform-independent way of
|
||||
intercepting and sending events, including defining
|
||||
application-specific events and handlers.
|
||||
|
||||
Ultimately it is intended to be used as a way of testing wxWindows
|
||||
applications using scripts, although there are currently
|
||||
problems with this (especially with modal dialogs).
|
||||
|
||||
All this is documented more to provoke comments and suggestions, and
|
||||
jog my own memory, rather than to be used, since it has not been
|
||||
tested. However {\bf wxSendEvent} will probably work if you
|
||||
instantiate the event structure properly for a command event type (see
|
||||
the code in {\tt wb\_panel.cpp} for \helpref{wxWindow::OnDefaultAction}{wxwindowondefaultaction}\rtfsp
|
||||
which uses {\bf wxSendEvent} to send a command to the default button).
|
||||
|
||||
\membersection{::wxAddPrimaryEventHandler}
|
||||
|
||||
\func{bool}{wxAddPrimaryEventHandler}{\param{wxEventHandler}{ handlerFunc}}
|
||||
|
||||
Add a primary event handler---the normal event handler for this
|
||||
event. For built-in events, these would include moving and resizing
|
||||
windows. User-defined primary events might include the code to
|
||||
select an image in a diagram (which could of course be achieved by a series
|
||||
of external events for mouse-clicking, but would be more difficult to specify
|
||||
and less robust).
|
||||
|
||||
Returns TRUE if it succeeds.
|
||||
|
||||
An event handler takes a pointer to a wxEvent and a boolean flag which is
|
||||
TRUE if the event was externally generated, and returns a boolean which is
|
||||
TRUE if that event was handled.
|
||||
|
||||
\membersection{::wxAddSecondaryEventHandler}
|
||||
|
||||
\func{bool}{wxAddSecondaryEventHandler}{\param{wxEventHandler}{ handlerFunc}, \param{bool}{ pre},\\
|
||||
\param{bool}{ override}, \param{bool }{append}}
|
||||
|
||||
Add a secondary event handler, pre = TRUE iff it should be called before the
|
||||
event is executed. override = TRUE iff the handler is allowed to override
|
||||
all subsequent events by returning TRUE. Returns TRUE if succeeds.
|
||||
|
||||
A secondary event handler is an application-defined handler that may
|
||||
intercept normal events, possibly overriding them. A primary event handler
|
||||
provides the normal behaviour for the event.
|
||||
|
||||
An event handler takes a pointer to a wxEvent and a boolean flag which is
|
||||
TRUE if the event was externally generated, and returns a boolean which is
|
||||
TRUE if that event was handled.
|
||||
|
||||
\membersection{::wxNotifyEvent}
|
||||
|
||||
\func{bool}{wxNotifyEvent}{\param{wxEvent\&}{ event}, \param{bool}{ pre}}
|
||||
|
||||
Notify the system of the event you are about to execute/have just
|
||||
executed. If TRUE is returned and pre = TRUE, the calling code should
|
||||
not execute the event (since it has been intercepted by a handler and
|
||||
vetoed).
|
||||
|
||||
These events are always internal, because they're generated from within
|
||||
the main application code.
|
||||
|
||||
\membersection{::wxRegisterEventClass}
|
||||
|
||||
\func{void}{wxRegisterEventClass}{\param{WXTYPE}{ eventClassId},\param{WXTYPE}{ superClassId},\\
|
||||
\param{wxEventConstructor}{ constructor}, \param{const wxString\& }{description}}
|
||||
|
||||
Register a new event class (derived from wxEvent), giving the new
|
||||
event class type, its superclass, a function for creating a new event
|
||||
object of this class, and an optional description.
|
||||
|
||||
\membersection{::wxRegisterEventName}
|
||||
|
||||
\func{void}{wxRegisterEventName}{\param{WXTYPE}{ eventTypeId},\param{WXTYPE}{ eventClassId},\\
|
||||
\param{const wxString\& }{eventName}}
|
||||
|
||||
Register the name of the event. This will allow a simple command
|
||||
language where giving the event type name and some arguments will
|
||||
cause a new event of class {\it eventClassId} to be created, with given
|
||||
event type, and some arguments, allows an event to be dynamically
|
||||
constructed and sent.
|
||||
|
||||
\membersection{::wxRegisterExternalEventHandlers}
|
||||
|
||||
\func{void}{wxRegisterExternalEventHandlers}{\void}
|
||||
|
||||
Define this and link before wxWindows library to allow registering
|
||||
events from `outside' the main application.
|
||||
|
||||
\membersection{::wxRemoveSecondaryEventHandler}
|
||||
|
||||
\func{bool}{wxRemoveSecondaryEventHandler}{\param{wxEventHandler}{ handlerFunc}, \param{bool}{ pre}}
|
||||
|
||||
Remove a secondary event handler. Returns TRUE if it succeeds.
|
||||
|
||||
\membersection{::wxSendEvent}\label{wxsendevent}
|
||||
|
||||
\func{bool}{wxSendEvent}{\param{wxEvent\&}{ event}, \param{bool}{ external}}
|
||||
|
||||
Send an event to the system; usually it will be external, but set
|
||||
external to FALSE if calling from within the main application in
|
||||
response to other events.
|
||||
|
||||
Returns TRUE if the event was processed.
|
||||
|
||||
\section{Printer settings}\label{printersettings}
|
||||
|
||||
The following functions are used to control PostScript printing. Under
|
||||
|
||||
@@ -147,11 +147,11 @@ Gets the position of the fifth axis of the joystick, if it exists.
|
||||
|
||||
Returns the maximum V position.
|
||||
|
||||
\membersection{wxJoystick::GetUMin}\label{wxjoystickgetumin}
|
||||
\membersection{wxJoystick::GetVMin}\label{wxjoystickgetvmin}
|
||||
|
||||
\constfunc{int}{GetUMin}{\void}
|
||||
\constfunc{int}{GetVMin}{\void}
|
||||
|
||||
Returns the minimum U position.
|
||||
Returns the minimum V position.
|
||||
|
||||
\membersection{wxJoystick::GetVPosition}\label{wxjoystickgetvposition}
|
||||
|
||||
|
||||
@@ -188,7 +188,7 @@ Sets the client data for a tab.
|
||||
\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}{setimagelist}.
|
||||
the image list which was set with \helpref{wxTabCtrl::SetImageList}{wxtabctrlsetimagelist}.
|
||||
|
||||
\membersection{wxTabCtrl::SetImageList}\label{wxtabctrlsetimagelist}
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
Classes: \helpref{wxDocument}{wxdocument}, \helpref{wxView}{wxview}, \helpref{wxDocTemplate}{wxdoctemplate},\rtfsp
|
||||
\helpref{wxDocManager}{wxdocmanager}, \helpref{wxDocParentFrame}{wxdocparentframe}, \helpref{wxDocChildFrame}{wxdocchildframe},
|
||||
\rtfsp\helpref{wxDocMDIParentFrame}{wxdocmdiparentframe}, \helpref{wxDocMDIChildFrame}{wxdocmdichildframe},
|
||||
\rtfsp\helpref{wxCommand}{wxcommand}, \helpref{wxCommandProcessor}{wxcommandprocessor}
|
||||
|
||||
The document/view framework is found in most application frameworks, because it
|
||||
@@ -254,42 +255,28 @@ the file history, that will be used for appending the filenames. They are
|
||||
appended using menu identifiers in the range wxID\_FILE1 to wxID\_FILE9.
|
||||
|
||||
In order to respond to a file load command from one of these identifiers,
|
||||
you need to handle them in your wxFrame::OnMenuCommand. Below is the
|
||||
code used by the default document/view parent frame.
|
||||
you need to handle them using an event handler, for example:
|
||||
|
||||
{\small
|
||||
\begin{verbatim}
|
||||
void wxDocParentFrame::OnMenuCommand(int id)
|
||||
BEGIN_EVENT_TABLE(wxDocParentFrame, wxFrame)
|
||||
EVT_MENU(wxID_EXIT, wxDocParentFrame::OnExit)
|
||||
EVT_MENU_RANGE(wxID_FILE1, wxID_FILE9, wxDocParentFrame::OnMRUFile)
|
||||
END_EVENT_TABLE()
|
||||
|
||||
void wxDocParentFrame::OnExit(wxCommandEvent& WXUNUSED(event))
|
||||
{
|
||||
switch (id)
|
||||
{
|
||||
case wxID_EXIT:
|
||||
{
|
||||
if (GetEventHandler()->OnClose())
|
||||
delete this;
|
||||
break;
|
||||
}
|
||||
case wxID_FILE1:
|
||||
case wxID_FILE2:
|
||||
case wxID_FILE3:
|
||||
case wxID_FILE4:
|
||||
case wxID_FILE5:
|
||||
case wxID_FILE6:
|
||||
case wxID_FILE7:
|
||||
case wxID_FILE8:
|
||||
case wxID_FILE9:
|
||||
{
|
||||
char *f = docManager->GetHistoryFile(id-wxID_FILE1);
|
||||
if (f)
|
||||
(void)docManager->CreateDocument(f, wxDOC_SILENT);
|
||||
break;
|
||||
}
|
||||
default:
|
||||
{
|
||||
docManager->OnMenuCommand(id);
|
||||
}
|
||||
}
|
||||
Close();
|
||||
}
|
||||
|
||||
void wxDocParentFrame::OnMRUFile(wxCommandEvent& event)
|
||||
{
|
||||
wxString f(m_docManager->GetHistoryFile(event.GetSelection() - wxID_FILE1));
|
||||
if (f != "")
|
||||
(void)m_docManager->CreateDocument(f, wxDOC_SILENT);
|
||||
}
|
||||
\end{verbatim}
|
||||
}
|
||||
|
||||
\subsection{wxWindows predefined command identifiers}\label{predefinedids}
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ calling thread.
|
||||
|
||||
\func{wxThreadError}{Destroy}{\void}
|
||||
|
||||
Destroys the thread immediately unless the application has specified deferral via \helpref{wxThread::DeferDestroy}{deferdestroy}.
|
||||
Destroys the thread immediately unless the application has specified deferral via \helpref{wxThread::DeferDestroy}{wxthreaddeferdestroy}.
|
||||
|
||||
\wxheading{Return value}
|
||||
|
||||
|
||||
@@ -226,7 +226,7 @@ Enables or disables the tool.
|
||||
|
||||
\wxheading{Remarks}
|
||||
|
||||
For \helpref{wxToolBarSimple}{wxtoolbarsimple}, does nothing. Some other implementations
|
||||
For wxToolBarSimple, does nothing. Some other implementations
|
||||
will change the visible state of the tool to indicate that it is disabled.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
@@ -8,7 +8,6 @@ This chapter contains a selection of topic overviews.
|
||||
\input tbitmap.tex
|
||||
\input tdialog.tex
|
||||
\input tfont.tex
|
||||
\input tstring.tex
|
||||
\input tsplittr.tex
|
||||
\input ttreectl.tex
|
||||
\input tlistctl.tex
|
||||
@@ -33,5 +32,6 @@ This chapter contains a selection of topic overviews.
|
||||
\input tvalidat.tex
|
||||
\input texpr.tex
|
||||
\input tgrid.tex
|
||||
\input tstring.tex
|
||||
\input tusage.tex
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1585,10 +1585,8 @@ handling of pages and ranges.
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
|
||||
\helpref{wxWindow::SetScrollRange}{wxwindowsetscrollpage},\rtfsp
|
||||
\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
|
||||
\helpref{wxWindow::GetScrollRange}{wxwindowsetscrollrange},\rtfsp
|
||||
\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollrange},\rtfsp
|
||||
\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp
|
||||
\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
|
||||
\end{comment}
|
||||
|
||||
@@ -1615,8 +1613,7 @@ application to take note of scrollbar attributes and redraw contents accordingly
|
||||
|
||||
\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar},\rtfsp
|
||||
\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
|
||||
\helpref{wxWindow::GetScrollRange}{wxwindowsetscrollrange},\rtfsp
|
||||
\helpref{wxWindow::GetScrollThumb}{wxwindowsetscrollthumb},\rtfsp
|
||||
\helpref{wxWindow::GetScrollThumb}{wxwindowgetscrollthumb},\rtfsp
|
||||
\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
|
||||
|
||||
\begin{comment}
|
||||
@@ -1647,8 +1644,7 @@ and usually the scrollbar will be automatically hidden.
|
||||
\helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
|
||||
\helpref{wxWindow::SetScrollPage}{wxwindowsetscrollpage},\rtfsp
|
||||
\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
|
||||
\helpref{wxWindow::GetScrollRange}{wxwindowsetscrollrange},\rtfsp
|
||||
\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollrange},\rtfsp
|
||||
\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp
|
||||
\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
|
||||
\end{comment}
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ just before the first call to display something.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxHelpControllerBase}{wxwinhelpcontrollerbase}
|
||||
\helpref{wxHelpControllerBase}{wxhelpcontrollerbase}
|
||||
|
||||
\wxheading{Include file}
|
||||
|
||||
|
||||
@@ -75,6 +75,26 @@ Returns the empty string if {\it ch} is not found.
|
||||
Gets all characters before the last occurence of {\it ch}.
|
||||
Returns empty string if {\it ch} is not found.
|
||||
|
||||
\membersection{wxString::Cmp}\label{wxstringcmp}
|
||||
|
||||
\constfunc{int}{Cmp}{\param{const char*}{ psz}}
|
||||
|
||||
Case-sensitive comparison.
|
||||
|
||||
Returns 0 if equal, +1 if greater or -1 if less.
|
||||
|
||||
See also CmpNoCase, IsSameAs.
|
||||
|
||||
\membersection{wxString::CmpNoCase}\label{wxstringcmpnocase}
|
||||
|
||||
\constfunc{int}{CmpNoCase}{\param{const char*}{ psz}}
|
||||
|
||||
Case-insensitive comparison.
|
||||
|
||||
Returns 0 if equal, +1 if greater or -1 if less.
|
||||
|
||||
See also Cmp, IsSameAs.
|
||||
|
||||
\membersection{wxString::CompareTo}\label{wxstringCompareTo}
|
||||
|
||||
\begin{verbatim}
|
||||
@@ -92,9 +112,21 @@ Case-sensitive comparison. Returns 0 if equal, 1 if greater or -1 if less.
|
||||
|
||||
Returns 1 if target appears anyhere in wxString; else 0.
|
||||
|
||||
\membersection{wxString::IsEmpty}\label{wxstringisempty}
|
||||
\membersection{wxString::Empty}\label{wxstringempty}
|
||||
|
||||
\constfunc{bool}{IsEmpty}{\void}
|
||||
\func{void}{Empty}{\void}
|
||||
|
||||
Reinitializes the string and frees the data.
|
||||
|
||||
\membersection{wxString::Find}\label{wxstringfind}
|
||||
|
||||
\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = FALSE}}
|
||||
|
||||
Searches for the given character. Returns the starting index, or -1 if not found.
|
||||
|
||||
\constfunc{int}{Find}{\param{const char*}{ sz}}
|
||||
|
||||
Searches for the given string. Returns the starting index, or -1 if not found.
|
||||
|
||||
\membersection{wxString::First}\label{wxstringfirst}
|
||||
|
||||
@@ -106,383 +138,386 @@ Returns 1 if target appears anyhere in wxString; else 0.
|
||||
|
||||
\constfunc{size\_t}{First}{\param{const char}{ ch}}
|
||||
|
||||
Returns first occurrence of item.
|
||||
Returns the first occurrence of the item.
|
||||
|
||||
\membersection{wxString::GetChar}\label{wxstringgetchar}
|
||||
|
||||
\constfunc{char}{GetChar}{\param{size\_t}{ n}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
\membersection{wxString::Firstchar}\label{wxstringFirstchar}
|
||||
\func{char}{Firstchar}{\param{void}{}} \param{ const}{}
|
||||
|
||||
Element extraction.
|
||||
|
||||
\membersection{wxString::Freq}\label{wxstringFreq}
|
||||
|
||||
\func{int}{Freq}{\param{char}{ c}} \param{ const}{}\\
|
||||
\func{int}{Freq}{\param{const wxString\&}{ y}} \param{ const}{}\\
|
||||
\func{int}{Freq}{\param{const wxSubString\&}{ y}} \param{ const}{}\\
|
||||
\func{int}{Freq}{\param{const char*}{ t}} \param{ const}{}
|
||||
|
||||
Return number of occurrences of target in wxString.
|
||||
|
||||
\membersection{wxString::From}\label{wxstringFrom}
|
||||
|
||||
\func{wxSubString}{From}{\param{int}{ pos}}\\
|
||||
\func{wxSubString}{From}{\param{const wxString\&}{ x}, \param{int}{ startpos = 0}}\\
|
||||
\func{wxSubString}{From}{\param{const wxSubString\&}{ x}, \param{int}{ startpos = 0}}\\
|
||||
\func{wxSubString}{From}{\param{const char*}{ t}, \param{int}{ startpos = 0}}\\
|
||||
\func{wxSubString}{From}{\param{char}{ c}, \param{int}{ startpos = 0}}\\
|
||||
\func{wxSubString}{From}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}}
|
||||
Returns the character at position {\it n} (read-only).
|
||||
|
||||
\membersection{wxString::GetData}\label{wxstringGetData}
|
||||
|
||||
\func{char*}{GetData}{\param{void}{}}
|
||||
\constfunc{const char*}{GetData}{\void}
|
||||
|
||||
wxWindows compatibility conversion.
|
||||
wxWindows compatibility conversion. Returns a constant pointer to the data in the string.
|
||||
|
||||
\membersection{wxString::GSub}\label{wxstringGSub}
|
||||
\func{int}{GSub}{\param{const wxString\&}{ pat}, \param{const wxString\&}{ repl}}\\
|
||||
\func{int}{GSub}{\param{const wxSubString\&}{ pat}, \param{const wxString\&}{ repl}}\\
|
||||
\func{int}{GSub}{\param{const char*}{ pat}, \param{const wxString\&}{ repl}}\\
|
||||
\func{int}{GSub}{\param{const char*}{ pat}, \param{const char*}{ repl}}\\
|
||||
\func{int}{GSub}{\param{const wxRegex\&}{ pat}, \param{const wxString\&}{ repl}}
|
||||
\membersection{wxString::GetWritableChar}\label{wxstringgetwritablechar}
|
||||
|
||||
Global substitution: substitute all occurrences of {\it pat} with {\it repl},
|
||||
returning the number of matches.
|
||||
\func{char\&}{GetWritableChar}{\param{size\_t}{ n}}
|
||||
|
||||
Returns a reference to the character at position {\it n}.
|
||||
|
||||
\membersection{wxString::GetWriteBuf}\label{wxstringgetwritebuf}
|
||||
|
||||
\func{char*}{GetWriteBuf}{\param{uint}{ len}}
|
||||
|
||||
Returns a writable buffer of at least {\it len} bytes.
|
||||
|
||||
Call \helpref{wxString::UngetWriteBuf}{wxstringungetwritebuf} as soon as possible
|
||||
to put the string back into a reasonable state.
|
||||
|
||||
\membersection{wxString::Index}\label{wxstringIndex}
|
||||
|
||||
\func{int}{Index}{\param{char}{ c}, \param{int}{ startpos = 0}} \param{ const}{}\\
|
||||
\func{int}{Index}{\param{const wxString\&}{ y}, \param{int}{ startpos = 0}} \param{ const}{}\\
|
||||
\func{int}{Index}{\param{const wxString\&}{ y}, \param{int}{ startpos}, \param{CaseCompare}{ cmp}} \param{ const}{}\\
|
||||
\func{int}{Index}{\param{const wxSubString\&}{ y}, \param{int}{ startpos = 0}} \param{ const}{}\\
|
||||
\func{int}{Index}{\param{const char*}{ t}, \param{int}{ startpos = 0}} \param{ const}{}\\
|
||||
\func{int}{Index}{\param{const char*}{ t}, \param{int}{ startpos}, \param{CaseCompare}{ cmp}} \param{ const}{}\\
|
||||
\func{int}{Index}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}} \param{ const}{}
|
||||
\constfunc{size\_t}{Index}{\param{char}{ ch}, \param{int}{ startpos = 0}}
|
||||
|
||||
Return the position of target in string, or -1 for failure.
|
||||
Same as \helpref{wxString::Find}{wxstringfind}.
|
||||
|
||||
\constfunc{size\_t}{Index}{\param{const char*}{ sz}}
|
||||
|
||||
Same as \helpref{wxString::Find}{wxstringfind}.
|
||||
|
||||
\constfunc{size\_t}{Index}{\param{const char*}{ sz}, \param{bool}{ caseSensitive = TRUE}, \param{bool}{ fromEnd = FALSE}}
|
||||
|
||||
Search the element in the array, starting from either side.
|
||||
|
||||
If {\it fromEnd} is TRUE, reverse search direction.
|
||||
|
||||
If {\bf caseSensitive}, comparison is case sensitive (the default).
|
||||
|
||||
Returns the index of the first item matched, or NOT\_FOUND.
|
||||
|
||||
\membersection{wxString::Insert}\label{wxstringInsert}
|
||||
|
||||
\func{wxString\&}{Insert}{\param{int}{ pos}, \param{const char*}{ s}}\\
|
||||
\func{wxString\&}{Insert}{\param{int}{ pos}, \param{const wxString\&}{ s}}
|
||||
\func{void}{Insert}{\param{const wxString\&}{ str}, \param{uint}{ index}}
|
||||
|
||||
Insertion.
|
||||
Add new element at the given position.
|
||||
|
||||
\membersection{wxString::IsAscii}\label{wxstringIsAscii}
|
||||
|
||||
\func{int}{IsAscii}{\param{void}{}} \param{ const}{}
|
||||
\constfunc{bool}{IsAscii}{\void}
|
||||
|
||||
Classification (should be capital, because of ctype.h macros).
|
||||
Returns TRUE if the string is ASCII.
|
||||
|
||||
\membersection{wxString::IsDefined}\label{wxstringIsDefined}
|
||||
\membersection{wxString::IsEmpty}\label{wxstringisempty}
|
||||
|
||||
\func{int}{IsDefined}{\param{void}{}} \param{ const}{}
|
||||
\constfunc{bool}{IsEmpty}{\void}
|
||||
|
||||
Classification (should be capital, because of ctype.h macros).
|
||||
Returns TRUE if the string is NULL.
|
||||
|
||||
\membersection{wxString::IsNull}\label{wxstringIsNull}
|
||||
|
||||
\func{int}{IsNull}{\param{void}{}} \param{ const}{}
|
||||
\constfunc{bool}{IsNull}{\void}
|
||||
|
||||
Classification (should be capital, because of ctype.h macros).
|
||||
Returns TRUE if the string is NULL (same as IsEmpty).
|
||||
|
||||
\membersection{wxString::IsNumber}\label{wxstringIsNumber}
|
||||
|
||||
\func{int}{IsNumber}{\param{void}{}} \param{ const}{}
|
||||
\constfunc{bool}{IsNumber}{\void}
|
||||
|
||||
Classification (should be capital, because of ctype.h macros).
|
||||
Returns TRUE if the string is a number.
|
||||
|
||||
\membersection{wxString::IsSameAs}\label{wxstringissameas}
|
||||
|
||||
\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = TRUE}}
|
||||
|
||||
Test for string equality, case-sensitive (default) or not.
|
||||
|
||||
caseSensitive is TRUE by default (case matters).
|
||||
|
||||
Returns TRUE if strings are equal, FALSE otherwise.
|
||||
|
||||
See also Cmp, CmpNoCase.
|
||||
|
||||
\membersection{wxString::IsWord}\label{wxstringIsWord}
|
||||
|
||||
\func{int}{IsWord}{\param{void}{}} \param{ const}{}
|
||||
\constfunc{bool}{IsWord}{\void}
|
||||
|
||||
Classification (should be capital, because of ctype.h macros).
|
||||
Returns TRUE if the string is a word. TODO: what's the definition of a word?
|
||||
|
||||
\membersection{wxString::Last}\label{wxstringLast}
|
||||
|
||||
\func{int}{Last}{\param{char}{ c}} \param{ const}{}\\
|
||||
\func{int}{Last}{\param{const char*}{ cs}} \param{ const}{}\\
|
||||
\func{int}{Last}{\param{const wxString\&}{ cs}} \param{ const}{}
|
||||
\constfunc{char}{Last}{\void}
|
||||
|
||||
First or last occurrence of item.
|
||||
Returns the last character.
|
||||
|
||||
\membersection{wxString::Lastchar}\label{wxstringLastchar}
|
||||
\func{char\&}{Last}{\void}
|
||||
|
||||
\func{char}{Lastchar}{\param{void}{}} \param{ const}{}
|
||||
Returns a reference to the last character (writable).
|
||||
|
||||
Element extraction.
|
||||
\membersection{wxString::Left}\label{wxstringleft}
|
||||
|
||||
\membersection{wxString::Length}\label{wxstringLength}
|
||||
\constfunc{wxString}{Left}{\param{size\_t}{ count}}
|
||||
|
||||
\func{unsigned int}{Length}{\param{void}{}} \param{ const}{}
|
||||
Returns the first {\it count} characters.
|
||||
|
||||
\constfunc{wxString}{Left}{\param{char}{ ch}}
|
||||
|
||||
Returns all characters before the first occurence of {\it ch}.
|
||||
Returns the whole string if {\it ch} is not found.
|
||||
|
||||
\membersection{wxString::Len}\label{wxstringlen}
|
||||
|
||||
\constfunc{size\_t}{Len}{\void}
|
||||
|
||||
Returns the length of the string.
|
||||
|
||||
\membersection{wxString::Length}\label{wxstringlength}
|
||||
|
||||
\constfunc{size\_t}{Length}{\void}
|
||||
|
||||
Returns the length of the string (same as Len).
|
||||
|
||||
\membersection{wxString::LowerCase}\label{wxstringLowerCase}
|
||||
|
||||
\func{void}{LowerCase}{\param{void}{}}
|
||||
\func{void}{LowerCase}{\void}
|
||||
|
||||
Same as MakeLower.
|
||||
|
||||
\membersection{wxString::MakeLower}\label{wxstringmakelower}
|
||||
|
||||
\func{void}{MakeLower}{\void}
|
||||
|
||||
Converts all characters to lower case.
|
||||
|
||||
\membersection{wxString::MakeUpper}\label{wxstringmakeupper}
|
||||
|
||||
\func{void}{MakeUpper}{\void}
|
||||
|
||||
Converts all characters to upper case.
|
||||
|
||||
\membersection{wxString::Matches}\label{wxstringMatches}
|
||||
|
||||
\func{bool}{Matches}{\param{char}{ c}, \param{int}{ pos = 0}} \param{ const}{}\\
|
||||
\func{bool}{Matches}{\param{const wxString\&}{ y}, \param{int}{ pos = 0}} \param{ const}{}\\
|
||||
\func{bool}{Matches}{\param{const wxSubString\&}{ y}, \param{int}{ pos = 0}} \param{ const}{}\\
|
||||
\func{bool}{Matches}{\param{const char*}{ t}, \param{int}{ pos = 0}} \param{ const}{}\\
|
||||
\func{bool}{Matches}{\param{const wxRegex\&}{ r}, \param{int}{ pos = 0}} \param{ const}{}
|
||||
\constfunc{bool}{Matches}{\param{const char*}{ szMask}}
|
||||
|
||||
Return 1 if target appears at position {\it pos} in wxString; else 0.
|
||||
Returns TRUE if the string contents matches a mask containing '*' and '?'.
|
||||
|
||||
\membersection{wxString::OK}\label{wxstringOK}
|
||||
\membersection{wxString::Mid}\label{wxstringmid}
|
||||
|
||||
\func{int}{OK}{\param{void}{}} \param{ const}{}
|
||||
\constfunc{wxString}{Mid}{\param{size\_t}{ first}, \param{size\_t}{ count = STRING\_MAXLEN}}
|
||||
|
||||
Returns a substring starting at {\it first}, with length {\it count}, or the rest of
|
||||
the string if {\it count} is the default value.
|
||||
|
||||
\membersection{wxString::Pad}\label{wxstringpad}
|
||||
|
||||
\func{wxString\&}{Pad}{\param{size\_t}{ count}, \param{char}{ pad = ' '}, \param{bool}{ fromRight = TRUE}}
|
||||
|
||||
Adds {\it count} copies of {\it pad} to the beginning, or to the end of the string (the default).
|
||||
|
||||
Removes spaces from the left or from the right (default).
|
||||
|
||||
\membersection{wxString::Prepend}\label{wxstringPrepend}
|
||||
|
||||
\func{wxString\&}{Prepend}{\param{const wxString\&}{ y}}\\
|
||||
\func{wxString\&}{Prepend}{\param{const wxSubString\&}{ y}}\\
|
||||
\func{wxString\&}{Prepend}{\param{const char*}{ t}}\\
|
||||
\func{wxString\&}{Prepend}{\param{char}{ c}}
|
||||
\func{wxString\&}{Prepend}{\param{const wxString\&}{ str}}
|
||||
|
||||
Prepend.
|
||||
Prepends {\it str} to this string, returning a reference to this string.
|
||||
|
||||
\func{wxString\&}{Prepend}{\param{char}{ c}, \param{int}{ rep=1}}
|
||||
\membersection{wxString::Printf}\label{wxstringprintf}
|
||||
|
||||
Prepend {\it c}, {\it rep} times.
|
||||
|
||||
\membersection{wxString::Readline}\label{wxstringReadline}
|
||||
\func{int}{Printf}{\param{const char* }{pszFormat}, \param{}{...}}
|
||||
|
||||
\func{friend int}{Readline}{\param{istream\&}{ s}, \param{wxString\&}{ x},
|
||||
\param{char}{ terminator = '$\backslash$n'},
|
||||
\param{int}{ discard\_terminator = 1}}\\
|
||||
\func{friend int}{Readline}{\param{FILE *}{ f}, \param{wxString\&}{ x},
|
||||
\param{char}{ terminator = '$\backslash$n'},
|
||||
\param{int}{ discard\_terminator = 1}}
|
||||
Similar to sprintf. Returns the number of characters written, or an integer less than zero
|
||||
on error.
|
||||
|
||||
\membersection{wxString::PrintfV}\label{wxstringprintfv}
|
||||
|
||||
\func{int}{PrintfV}{\param{const char* }{pszFormat}, \param{va\_list}{ argPtr}}
|
||||
|
||||
Similar to vprintf. Returns the number of characters written, or an integer less than zero
|
||||
on error.
|
||||
|
||||
\membersection{wxString::Remove}\label{wxstringRemove}
|
||||
|
||||
\func{wxString\&}{RemoveLast}{\param{void}{}}\\
|
||||
\func{wxString\&}{Remove}{\param{int}{ pos}}\\
|
||||
\func{wxString\&}{Remove}{\param{int}{ pos}, \param{int}{ len}}
|
||||
\func{wxString\&}{Remove}{\param{size\_t}{ pos}}
|
||||
|
||||
Remove {\it pos} to end of string.
|
||||
Same as Truncate. Removes the portion from {\it pos} to the end of the string.
|
||||
|
||||
\func{wxString\&}{Remove}{\param{size\_t}{ pos}, \param{size\_t}{ len}}
|
||||
|
||||
Removes the last {\it len} characters from the string, starting at {\it pos}.
|
||||
|
||||
\membersection{wxString::RemoveLast}\label{wxstringremovelast}
|
||||
|
||||
\func{wxString\&}{RemoveLast}{\void}
|
||||
|
||||
Removes the last character.
|
||||
|
||||
\membersection{wxString::Replace}\label{wxstringReplace}
|
||||
|
||||
\func{wxString\&}{Replace}{\param{int}{ pos}, \param{int}{ n}, \param{const char*}{ s}}\\
|
||||
\func{wxString\&}{Replace}{\param{int}{ pos}, \param{int}{ n}, \param{const wxString\&}{ s}}
|
||||
\func{uint}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll}}
|
||||
|
||||
\membersection{wxString::Replicate}\label{wxstringReplicate}
|
||||
Replace first (or all) occurences of substring with another one.
|
||||
|
||||
\func{friend wxString}{Replicate}{\param{char}{ c}, \param{int}{ n}}\\
|
||||
\func{friend wxString}{Replicate}{\param{const wxString\&}{ y}, \param{int}{ n}}
|
||||
{\it replaceAll}: global replace (default), or only the first occurence.
|
||||
|
||||
Replication.
|
||||
Returns the number of replacements made.
|
||||
|
||||
\membersection{wxString::Reverse}\label{wxstringReverse}
|
||||
\membersection{wxString::Right}\label{wxstringright}
|
||||
|
||||
\func{void}{Reverse}{\param{void}{}}\\
|
||||
\func{friend wxString}{Reverse}{\param{wxString\&}{ x}}
|
||||
\constfunc{wxString}{Right}{\param{size\_t}{ count}}
|
||||
|
||||
Returns the last {\it count} characters.
|
||||
|
||||
\constfunc{wxString}{Right}{\param{char}{ ch}}
|
||||
|
||||
Returns all characters after the last occurence of {\it ch}.
|
||||
Returns the whole string if {\it ch} is not found.
|
||||
|
||||
\membersection{wxString::SetChar}\label{wxstringsetchar}
|
||||
|
||||
\func{void}{SetChar}{\param{size\_t}{ n}, \param{char}{ch}}
|
||||
|
||||
Sets the character at position {\it n}.
|
||||
|
||||
\membersection{wxString::Shrink}\label{wxstringshrink}
|
||||
|
||||
\func{void}{Shrink}{\void}
|
||||
|
||||
Minimizes the string's memory. Only works if the data of this string is not shared.
|
||||
|
||||
\membersection{wxString::sprintf}\label{wxstringsprintf}
|
||||
\func{void}{sprintf}{\param{const wxString\& }{ fmt}}
|
||||
|
||||
Formatted assignment. We do not use the 'sprintf' constructor anymore,
|
||||
because with that constructor, every initialisation with a string would
|
||||
go through sprintf and this is not desirable, because sprintf
|
||||
interprets some characters. With the above function we can write:
|
||||
\func{void}{sprintf}{\param{const char* }{ fmt}}
|
||||
|
||||
\begin{verbatim}
|
||||
wxString msg; msg.sprintf("Processing item %d\n", count);
|
||||
\end{verbatim}
|
||||
The same as Printf.
|
||||
|
||||
\membersection{wxString::Strip}\label{wxstringStrip}
|
||||
|
||||
\begin{verbatim}
|
||||
enumStripType {leading = 0x1, trailing = 0x2, both = 0x3};
|
||||
enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
|
||||
\end{verbatim}
|
||||
|
||||
\func{wxSubString}{Strip}{\param{StripType}{ s = trailing}, \param{char}{ c = ' '}}
|
||||
\constfunc{wxString}{Strip}{\param{stripType}{ s = trailing}}
|
||||
|
||||
Strip characterss at the front and/or end.
|
||||
StripType is defined for bitwise ORing.
|
||||
Strip characters at the front and/or end. The same as Trim except that it
|
||||
doesn't change this string.
|
||||
|
||||
\membersection{wxString::SubString}\label{wxstringSubString}
|
||||
\membersection{wxString::Trim}\label{wxstringtrim}
|
||||
|
||||
\func{wxString}{SubString}{\param{int}{ from}, \param{int}{ to}}
|
||||
\func{wxString\&}{Trim}{\param{bool}{ fromRight = TRUE}}
|
||||
|
||||
Edward Zimmermann's additions.
|
||||
Removes spaces from the left or from the right (default).
|
||||
|
||||
\membersection{wxString::Through}\label{wxstringThrough}
|
||||
\membersection{wxString::Truncate}\label{wxstringtruncate}
|
||||
|
||||
\func{wxSubString}{Through}{\param{int}{ pos}}\\
|
||||
\func{wxSubString}{Through}{\param{const wxString\&}{ x}, \param{int}{ startpos = 0}}\\
|
||||
\func{wxSubString}{Through}{\param{const wxSubString\&}{ x}, \param{int}{ startpos = 0}}\\
|
||||
\func{wxSubString}{Through}{\param{const char*}{ t}, \param{int}{ startpos = 0}}\\
|
||||
\func{wxSubString}{Through}{\param{char}{ c}, \param{int}{ startpos = 0}}\\
|
||||
\func{wxSubString}{Through}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}}
|
||||
\func{wxString\&}{Truncate}{\param{size\_t}{ len}}
|
||||
|
||||
\membersection{wxString::Upcase}\label{wxstringUpcase}
|
||||
Truncate the string to the given length.
|
||||
|
||||
\func{void}{Upcase}{\param{void}{}}\\
|
||||
\func{friend wxString}{Upcase}{\param{wxString\&}{ x}}
|
||||
\membersection{wxString::UngetWriteBuf}\label{wxstringungetwritebuf}
|
||||
|
||||
\func{void}{UngetWriteBuf}{\void}
|
||||
|
||||
Puts the string back into a reasonable state, after
|
||||
\rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called.
|
||||
|
||||
\membersection{wxString::UpperCase}\label{wxstringUpperCase}
|
||||
|
||||
\func{void}{UpperCase}{\param{void}{}}\\
|
||||
\func{void}{UpperCase}{\void}
|
||||
|
||||
The same as MakeUpper.
|
||||
|
||||
\membersection{wxString::operator $=$}\label{wxstringoperatorassign}
|
||||
|
||||
\func{wxString\&}{operator $=$}{\param{const wxString\&}{ y}}\\
|
||||
\func{wxString\&}{operator $=$}{\param{const char*}{ y}}\\
|
||||
\func{wxString\&}{operator $=$}{\param{char}{ c}}\\
|
||||
\func{wxString\&}{operator $=$}{\param{const wxSubString\&}{ y}}
|
||||
\func{wxString\&}{operator $=$}{\param{const wxString\&}{ str}}
|
||||
|
||||
\func{wxString\&}{operator $=$}{\param{const char*}{ psz}}
|
||||
|
||||
\func{wxString\&}{operator $=$}{\param{char}{ c}}
|
||||
|
||||
\func{wxString\&}{operator $=$}{\param{const unsigned char*}{ psz}}
|
||||
|
||||
\func{wxString\&}{operator $=$}{\param{const wchar\_t*}{ pwz}}
|
||||
|
||||
Assignment.
|
||||
|
||||
\membersection{wxString::operator $+=$}\label{wxstringPlusEqual}
|
||||
|
||||
\func{wxString\&}{operator $+=$}{\param{const wxString\&}{ y}}\\
|
||||
\func{wxString\&}{operator $+=$}{\param{const wxSubString\&}{ y}}\\
|
||||
\func{wxString\&}{operator $+=$}{\param{const char*}{ t}}\\
|
||||
\func{wxString\&}{operator $+=$}{\param{char}{ c}}
|
||||
\func{void}{operator $+=$}{\param{const wxString\&}{ str}}
|
||||
|
||||
\func{void}{operator $+=$}{\param{const char*}{ psz}}
|
||||
|
||||
\func{void}{operator $+=$}{\param{char}{ c}}
|
||||
|
||||
Concatenation.
|
||||
|
||||
\membersection{wxString::operator []}\label{wxstringoperatorbracket}
|
||||
|
||||
\func{char\&}{operator []}{\param{int}{ i}}
|
||||
\func{char\&}{operator []}{\param{size\_t}{ i}}
|
||||
|
||||
\func{char}{operator []}{\param{size\_t}{ i}}
|
||||
|
||||
\func{char}{operator []}{\param{int}{ i}}
|
||||
|
||||
Element extraction.
|
||||
|
||||
\membersection{wxString::operator ()}\label{wxstringoperatorparenth}
|
||||
|
||||
\func{char\&}{operator ()}{\param{int}{ i}}
|
||||
\func{wxString}{operator ()}{\param{size\_t}{ start}, \param{size\_t}{ len}}
|
||||
|
||||
Same as Mid (substring extraction).
|
||||
|
||||
\membersection{wxString::operator \cinsert}\label{wxstringoperatorout}
|
||||
\func{friend ostream\&}{operator \cinsert}{\param{ostream\&}{ s}, \param{const wxString\&}{ x}}\\
|
||||
\func{friend ostream\&}{operator \cinsert}{\param{ostream\&}{ s}, \param{const wxSubString\&}{ x}}
|
||||
|
||||
\func{wxString\&}{operator \cinsert}{\\param{const wxString\&}{ str}}
|
||||
|
||||
\func{wxString\&}{operator \cinsert}{\\param{const char*}{ psz}}
|
||||
|
||||
\func{wxString\&}{operator \cinsert}{\\param{char }{ch}}
|
||||
|
||||
Same as $+=$.
|
||||
|
||||
\membersection{wxString::operator \cextract}\label{wxstringoperatorin}
|
||||
\func{friend istream\&}{operator \cextract}{\param{istream\&}{ s}, \param{wxString\&}{ x}}
|
||||
|
||||
\func{friend istream\&}{operator \cextract}{\param{istream\&}{ is}, \param{wxString\&}{ str}}
|
||||
|
||||
Extraction from a stream.
|
||||
|
||||
\membersection{wxString::operator const char*}\label{wxstringoperatorconstcharpt}
|
||||
\constfunc{}{operator const char*}{\param{void}{}}
|
||||
|
||||
Conversion.
|
||||
\constfunc{}{operator const char*}{\void}
|
||||
|
||||
\membersection{wxCHARARG}\label{wxstringwxCHARARG}
|
||||
|
||||
\begin{verbatim}
|
||||
#define wxCHARARG(s) ((const wxString\& )(s).Chars())
|
||||
\end{verbatim}
|
||||
|
||||
Here is a very, very, very ugly macro, but it makes things more
|
||||
transparent in cases, where a library function requires a
|
||||
(const wxString\& ) argument. This is especially the case in wxWindows,
|
||||
where all char-arguments are (const wxString\& ) and not (const char* ).
|
||||
This macro should only be used in such cases and NOT to
|
||||
modify the internal data.
|
||||
The conventional way would be 'function((char*)string.Chars())'.
|
||||
With the wxCHARARG macro, this can be achieved by 'function(wxCHARARG(string))'.
|
||||
This makes it clearer that the usage should be confined
|
||||
to arguments.
|
||||
|
||||
\membersection{CommonPrefix}\label{wxstringCommonPrefix}
|
||||
|
||||
\func{friend wxString}{CommonPrefix}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y},\\
|
||||
\param{int}{ startpos = 0}}\\
|
||||
|
||||
\membersection{CommonSuffix}\label{wxstringCommonSuffix}
|
||||
|
||||
\func{friend wxString}{CommonSuffix}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y},\\
|
||||
\param{int}{ startpos = -1}}
|
||||
|
||||
\membersection{Compare}\label{wxstringCompare}
|
||||
|
||||
\func{int}{Compare}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{Compare}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{Compare}{\param{const wxString\&}{ x}, \param{const char*}{ y}}\\
|
||||
\func{int}{Compare}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{Compare}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{Compare}{\param{const wxSubString\&}{ x}, \param{const char*}{ y}}
|
||||
|
||||
Case dependent comparison. Returns 0 if the match succeeded.
|
||||
|
||||
\membersection{FCompare}\label{wxstringFCompare}
|
||||
|
||||
\func{int}{FCompare}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
|
||||
|
||||
Case independent comparison. Returns 0 if the match succeeded.
|
||||
Implicit conversion to a C string.
|
||||
|
||||
\membersection{Comparison operators}\label{wxstringComparison}
|
||||
|
||||
\func{int}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $!=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $>$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $>=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $<$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $<=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $!=$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $>$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $>=$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $<$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $<=$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $==$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $!=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $>$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $>=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $<$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $<=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $==$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $!=$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $>$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $>=$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $<$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $<=$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{int}{operator $==$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $!=$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $>$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $>=$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $<$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $<=$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{int}{operator $==$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $!=$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $>$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $>=$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $<$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\
|
||||
\func{int}{operator $<=$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}
|
||||
\func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
|
||||
|
||||
\func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
|
||||
|
||||
\func{bool}{operator $!=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
|
||||
|
||||
\func{bool}{operator $!=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
|
||||
|
||||
\func{bool}{operator $>$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
|
||||
|
||||
\func{bool}{operator $>$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
|
||||
|
||||
\func{bool}{operator $>=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
|
||||
|
||||
\func{bool}{operator $>=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
|
||||
|
||||
\func{bool}{operator $<$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
|
||||
|
||||
\func{bool}{operator $<$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
|
||||
|
||||
\func{bool}{operator $<=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
|
||||
|
||||
\func{bool}{operator $<=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}
|
||||
|
||||
\wxheading{Remarks}
|
||||
|
||||
These comparisons are case-sensitive.
|
||||
|
||||
\membersection{operator $+$}\label{wxstringoperatorplus}
|
||||
|
||||
\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const char*}{ y}}\\
|
||||
\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{char}{ y}}\\
|
||||
\func{wxString}{operator $+$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{wxString}{operator $+$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\
|
||||
\func{wxString}{operator $+$}{\param{const wxSubString\&}{ x}, \param{const char*}{ y}}\\
|
||||
\func{wxString}{operator $+$}{\param{const wxSubString\&}{ x}, \param{char}{ y}}\\
|
||||
\func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxString\&}{ y}}\\
|
||||
\func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxSubString\&}{ y}}
|
||||
\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
|
||||
|
||||
\membersection{Join}\label{wxstringJoin}
|
||||
\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const char*}{ y}}
|
||||
|
||||
\func{friend wxString}{Join}{\param{wxString}{ src[]}, \param{int}{ n}, \param{const wxString\&}{ sep}}
|
||||
|
||||
\membersection{Split}\label{wxstringSplit}
|
||||
|
||||
\func{friend int}{Split}{\param{const wxString\&}{ x}, \param{wxString}{ res[]}, \param{int}{ maxn},\\
|
||||
\param{const wxString\&}{ sep}}\\
|
||||
\func{friend int}{Split}{\param{const wxString\&}{ x}, \param{wxString}{ res[]}, \param{int}{ maxn},\\
|
||||
\param{const wxRegex\&}{ sep}}\\
|
||||
|
||||
Split string into array res at separators; return number of elements
|
||||
\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{char}{ y}}
|
||||
|
||||
\func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxString\&}{ y}}
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user