Doc fixes A-M edition. Thanks to Arnout for pointing these out. Also I fixed some others as I went along...

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31801 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Ryan Norton
2005-02-06 17:27:04 +00:00
parent 3f029bd314
commit f6e9a8189c
29 changed files with 59 additions and 208 deletions

View File

@@ -98,12 +98,14 @@ Destructor, destroying the choice item.
\func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
\param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
\param{long}{ style = 0}, \param{const wxString\& }{name = ``choice"}}
\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``choice"}}
\func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
\param{const wxArrayString\& }{choices},\rtfsp
\param{long}{ style = 0}, \param{const wxString\& }{name = ``choice"}}
\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``choice"}}
Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoicector}.

View File

@@ -20,7 +20,7 @@ No parent class.
\membersection{wxClassInfo::wxClassInfo}\label{wxclassinfoctor}
\func{}{wxClassInfo}{\param{wxChar * }{className}, \param{wxChar * }{baseClass1}, \param{wxChar * }{baseClass2},
\func{}{wxClassInfo}{\param{const wxChar * }{className}, \param{const wxClassInfo * }{baseClass1}, \param{const wxClassInfo * }{baseClass2},
\param{int}{ size}, \param{wxObjectConstructorFn }{fn}}
Constructs a wxClassInfo object. The supplied macros implicitly construct objects of this

View File

@@ -69,12 +69,6 @@ force the application to exit, and so this function must be called to check this
Returns true if the user is logging off.
\membersection{wxCloseEvent::GetSessionEnding}\label{wxcloseeventgetsessionending}
\constfunc{bool}{GetSessionEnding}{\void}
Returns true if the session is ending.
\membersection{wxCloseEvent::GetForce}\label{wxcloseeventgetforce}
\constfunc{bool}{GetForce}{\void}

View File

@@ -328,25 +328,13 @@ removed in the next wxWidgets version, please don't use it.
\membersection{wxColourDatabase::Find}\label{wxcolourdatabasefind}
\func{wxColour}{FindColour}{\param{const wxString\& }{colourName}}
\func{wxColour}{Find}{\param{const wxString\& }{colourName}}
Finds a colour given the name. Returns an invalid colour object (that is, such
that its \helpref{Ok()}{wxcolourok} method returns \false) if the colour wasn't
found in the database.
\membersection{wxColourDatabase::FindColour}\label{wxcolourdatabasefindcolour}
\func{wxColour*}{FindColour}{\param{const wxString\& }{colourName}}
Finds a colour given the name. Returns {\tt NULL} if not found or a pointer which
must be deleted by the caller otherwise.
Please note that this method is deprecated and will be removed in the next
wxWidgets version, please use \helpref{Find}{wxcolourdatabasefind} instead of
it.
\membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname}
\constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}}

View File

@@ -2199,40 +2199,6 @@ WHERE and FROM clauses specified using \helpref{wxDbTable::SetWhereClause}{wxdbt
and \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} are ignored by
this function.
\membersection{wxDbTable::BuildWhereStmt}\label{wxdbtablebuildwherestmt}
\func{void}{BuildSelectStmt}{\param{wxString \&}{pWhereClause},
\param{int }{typeOfWhere}, \param{const wxString \&}{qualTableName=""},
\param{bool }{useLikeComparison=false}}
Constructs the portion of a SQL statement which would follow the word 'WHERE'
in a SQL statement to be passed to the datasource. The returned string
does NOT include the word 'WHERE'.
\wxheading{Parameters}
\docparam{pWhereClause}{Pointer to storage for the SQL statement retrieved.
To be sure you have adequate space allocated for the SQL statement, allocate
DB\_MAX\_STATEMENT\_LEN bytes.}
\docparam{typeOfWhere}{The type of where clause to generate. Can be one of
two values: DB\_WHERE\_KEYFIELDS or DB\_WHERE\_MATCHING.}
\docparam{qualTableName}{{\it OPTIONAL}. Prepended to all base table
column names. For use when a FROM clause has been specified with the
\helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause},
to clarify which table a column name reference belongs to. Default is "".}
\docparam{useLikeComparison}{{\it OPTIONAL}. Should the constructed WHERE
clause utilize the LIKE comparison operator. If false, then the '='
operator is used. Default is false.}
\wxheading{Remarks}
This member function allows you to see what the SQL WHERE clause looks like
that the ODBC class library builds. This can be used for debugging purposes
if you are having problems executing your own SQL statements.
If using 'typeOfWhere' set to DB\_WHERE\_MATCHING, any bound columns currently
containing a NULL value are not included in the WHERE clause's list of
columns to use in the comparison.
\membersection{wxDbTable::CanSelectForUpdate}\label{wxdbtablecanselectforupdate}
@@ -3618,7 +3584,7 @@ were to be copied over to another datasource or table.
\membersection{wxDbTable::SetCursor}\label{wxdbtablesetcursor}
\func{bool}{SetCursor}{\param{HSTMT *}{hstmtActivate = (void **) wxDB\_DEFAULT\_CURSOR}}
\func{void}{SetCursor}{\param{HSTMT *}{hstmtActivate = (void **) wxDB\_DEFAULT\_CURSOR}}
\wxheading{Parameters}

View File

@@ -115,20 +115,6 @@ supported by this display and match the mode parameter
Returns the display's name. A name is not available on all platforms.
\membersection{wxDisplay::IsColour}\label{wxdisplayiscolour}
\constfunc{bool }{IsColour}{\void}
Returns true if the display is color (has a depth greater than 1).
\membersection{wxDisplay::IsColor}\label{wxdisplayiscolor}
\constfunc{bool }{IsColor}{\void}
Same as \helpref{IsColour()}{wxdisplayiscolour}.
\membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}
\func{bool }{IsPrimary}{\void}

View File

@@ -92,7 +92,7 @@ Destructor.
\membersection{wxDocManager::ActivateView}\label{wxdocmanageractivateview}
\func{void}{ActivateView}{\param{wxView* }{doc}, \param{bool}{ activate}, \param{bool}{ deleting}}
\func{void}{ActivateView}{\param{wxView* }{doc}, \param{bool}{ activate = true}}
Sets the current view.
@@ -329,24 +329,6 @@ Saves the current document by calling wxDocument::Save for the current document.
Calls wxDocument::SaveAs for the current document.
\membersection{wxDocManager::OnMenuCommand}\label{wxdocmanageronmenucommand}
\func{void}{OnMenuCommand}{\param{int}{ cmd}}
Processes menu commands routed from child or parent frames. This deals
with the following predefined menu item identifiers:
\begin{itemize}\itemsep=0pt
\item wxID\_OPEN Creates a new document and opens a file into it.
\item wxID\_CLOSE Closes the current document.
\item wxID\_CLOSE\_ALL Closes all documents.
\item wxID\_NEW Creates a new document.
\item wxID\_SAVE Saves the document.
\item wxID\_SAVE\_AS Saves the document into a specified filename.
\end{itemize}
Unrecognized commands are routed to the currently active wxView's OnMenuCommand.
\membersection{wxDocManager::RemoveDocument}\label{wxdocmanagerremovedocument}
\func{void}{RemoveDocument}{\param{wxDocument *}{doc}}
@@ -356,7 +338,7 @@ Removes the document from the list of documents.
\membersection{wxDocManager::SelectDocumentPath}\label{wxdocmanagerselectdocumentpath}
\func{wxDocTemplate *}{SelectDocumentPath}{\param{wxDocTemplate **}{templates},
\param{int}{ noTemplates}, \param{const wxString\& }{path}, \param{const wxString\& }{bufSize},
\param{int}{ noTemplates}, \param{wxString\& }{path},
\param{long}{ flags}, \param{bool}{ save}}
Under Windows, pops up a file selector with a list of filters corresponding to document templates.

View File

@@ -144,7 +144,7 @@ Note that this method does not trigger relayout.
\membersection{wxFlexGridSizer::SetNonFlexibleGrowMode}\label{wxflexgridsizersetnonflexiblegrowmode}
\func{void}{SetNonFlexibleGrowMode}{\param{int }{mode}}
\func{void}{SetNonFlexibleGrowMode}{\param{wxFlexSizerGrowMode }{mode}}
Specifies how the sizer should grow in the non flexible direction if
there is one (so

View File

@@ -26,12 +26,6 @@ Constructor. Initializes {\it fontColour} to black, {\it showHelp} to black,
\rtfsp{\it allowSymbols} to true, {\it enableEffects} to true,
\rtfsp{\it minSize} to 0 and {\it maxSize} to 0.
\membersection{wxFontData::\destruct{wxFontData}}\label{wxfontdatadtor}
\func{}{\destruct{wxFontData}}{\void}
Destructor.
\membersection{wxFontData::EnableEffects}\label{wxfontdataenableeffects}
\func{void}{EnableEffects}{\param{bool}{ enable}}
@@ -178,8 +172,6 @@ shown.
\membersection{wxFontDialog::Create}\label{wxfontdialogcreate}
\func{bool}{Create}{\void}
\func{bool}{Create}{\param{wxWindow* }{parent}}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxFontData\& }{data}}
@@ -188,12 +180,6 @@ Creates the dialog if it the wxFontDialog object had been initialized using the
default constructor. Returns {\tt true} on success and {\tt false} if an error
occured.
\membersection{wxFontDialog::\destruct{wxFontDialog}}\label{wxfontdialogdtor}
\func{}{\destruct{wxFontDialog}}{\void}
Destructor.
\membersection{wxFontDialog::GetFontData}\label{wxfontdialoggetfontdata}
\constfunc{const wxFontData\&}{GetFontData}{\void}

View File

@@ -157,16 +157,6 @@ Centres the frame on the display.
\docparam{direction}{The parameter may be {\tt wxHORIZONTAL}, {\tt wxVERTICAL} or {\tt wxBOTH}.}
\membersection{wxFrame::Command}\label{wxframecommand}
\func{void}{Command}{\param{int }{id}}
Simulate a menu command.
\wxheading{Parameters}
\docparam{id}{The identifier for a menu item.}
\membersection{wxFrame::Create}\label{wxframecreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
@@ -368,6 +358,18 @@ implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
\helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}.
\membersection{wxFrame::ProcessCommand}\label{wxframeprocesscommand}
\func{void}{ProcessCommand}{\param{int }{id}}
Simulate a menu command.
\wxheading{Parameters}
\docparam{id}{The identifier for a menu item.}
\membersection{wxFrame::SendSizeEvent}\label{wxframesendsizeevent}
\func{void}{SendSizeEvent}{\void}

View File

@@ -33,7 +33,7 @@ pointers.
\membersection{wxFSFile::wxFSFile}\label{wxfsfilewxfsfile}
\func{}{wxFSFile}{\param{wxInputStream }{*stream}, \param{const wxString\& }{loc}, \param{const wxString\& }{mimetype}, \param{const wxString\& }{anchor}}
\func{}{wxFSFile}{\param{wxInputStream }{*stream}, \param{const wxString\& }{loc}, \param{const wxString\& }{mimetype}, \param{const wxString\& }{anchor}, \param{wxDateTime }{modif}}
Constructor. You probably won't use it. See Notes for details.

View File

@@ -45,7 +45,7 @@ function that takes a wxHelpEvent argument.
\membersection{wxHelpEvent::wxHelpEvent}\label{wxhelpeventctor}
\func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = true}, \param{wxWindowID }{id = 0},
\func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{wxWindowID }{id = 0},
\param{const wxPoint\& }{point}}
Constructor.

View File

@@ -93,12 +93,6 @@ information about the kind of the error.
\docparam{basepath}{base directory (html string would be stored there if it was in
file). It is used to determine path for loading images, for example.}
\membersection{wxHtmlEasyPrinting::PrinterSetup}\label{wxhtmleasyprintingprintersetup}
\func{void}{PrinterSetup}{\void}
Display printer setup dialog and allows the user to modify settings.
\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
\func{void}{PageSetup}{\void}

View File

@@ -5,7 +5,7 @@
\section{\class{wxHtmlFilter}}\label{wxhtmlfilter}
This class is an input filter for \helpref{wxHtmlWindow}{wxhtmlwindow}.
This class is the parent class of input filters for \helpref{wxHtmlWindow}{wxhtmlwindow}.
It allows you to read and display files of different file formats.
\wxheading{Derived from}

View File

@@ -62,16 +62,20 @@ for parameters description.
\membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents}
\func{void}{CreateContents}{\param{bool }{show\_progress = false}}
\func{void}{CreateContents}{\void}
Creates contents panel. (May take some time.)
Protected.
\membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex}
\func{void}{CreateIndex}{\param{bool }{show\_progress = false}}
\func{void}{CreateIndex}{\void}
Creates index panel. (May take some time.)
Protected.
\membersection{wxHtmlHelpFrame::CreateSearch}\label{wxhtmlhelpframecreatesearch}
\func{void}{CreateSearch}{\void}
@@ -134,10 +138,12 @@ Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCus
\membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists}
\func{void}{RefreshLists}{\param{bool }{show\_progress = false}}
\func{void}{RefreshLists}{\void}
Refresh all panels. This is necessary if a new book was added.
Protected.
\membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat}
\func{void}{SetTitleFormat}{\param{const wxString\& }{format}}

View File

@@ -5,7 +5,7 @@
\section{\class{wxHtmlParser}}\label{wxhtmlparser}
This class handles the {\bf generic} parsing of HTML document: it scans
Classes derived from this handle the {\bf generic} parsing of HTML documents: it scans
the document and divide it into blocks of tags (where one block
consists of beginning and ending tag and of text between these
two tags).

View File

@@ -20,7 +20,9 @@ wxObject
\membersection{wxHtmlTag::wxHtmlTag}\label{wxhtmltagwxhtmltag}
\func{}{wxHtmlTag}{\param{const wxString\& }{source}, \param{int }{pos}, \param{int }{end\_pos}, \param{wxHtmlTagsCache* }{cache}}
\func{}{wxHtmlTag}{\param{wxHtmlTag *}{parent}, \param{const wxString\& }{source},
\param{int }{pos}, \param{int }{end\_pos},
\param{wxHtmlTagsCache* }{cache}, \param{wxHtmlEntitiesParser *}{entParser}}
Constructor. You will probably never have to construct a wxHtmlTag object
yourself. Feel free to ignore the constructor parameters.
@@ -166,13 +168,6 @@ Example : {\tt <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
\docparam{par}{the parameter you're looking for.}
\membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending}
\constfunc{bool}{IsEnding}{\void}
Returns true if this tag is ending one.
({\tt </FONT>} is ending tag, {\tt <FONT>} is not)
\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam}
\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const wxChar *}{format}, \param{void *}{value}}

View File

@@ -341,16 +341,6 @@ Sets the height member (does not affect the icon data).
\docparam{height}{Icon height in pixels.}
\membersection{wxIcon::SetOk}\label{wxiconsetok}
\func{void}{SetOk}{\param{int }{isOk}}
Sets the validity member (does not affect the icon data).
\wxheading{Parameters}
\docparam{isOk}{Validity flag.}
\membersection{wxIcon::SetWidth}\label{wxiconsetwidth}
\func{void}{SetWidth}{\param{int }{width}}

View File

@@ -313,7 +313,7 @@ true if the call succeeded, false otherwise.
\membersection{wxImage::Destroy}\label{wximagedestroy}
\func{bool}{Destroy}{\void}
\func{void}{Destroy}{\void}
Destroys the image data.

View File

@@ -169,6 +169,8 @@ Removes all the images in the list.
Replaces the existing image with the new image.
Windows only.
\func{bool}{Replace}{\param{int}{ index}, \param{const wxIcon\&}{ icon}}
Replaces the existing image with the new image.

View File

@@ -186,7 +186,7 @@ Wx::LanguageInfo->new( language, canonicalName, WinLang, WinSubLang, Description
\membersection{wxLocale::FindLanguageInfo}\label{wxlocalefindlanguageinfo}
\constfunc{static wxLanguageInfo *}{FindLanguageInfo}{\param{const wxString\& }{locale}}
\func{static wxLanguageInfo *}{FindLanguageInfo}{\param{const wxString\& }{locale}}
This function may be used to find the language description structure for the
given locale, specified either as a two letter ISO language code (for example,

View File

@@ -51,7 +51,7 @@ into the DC before drawing on it.
\membersection{wxMemoryDC::SelectObject}\label{wxmemorydcselectobject}
\func{}{SelectObject}{\param{const wxBitmap\& }{bitmap}}
\func{void}{SelectObject}{\param{const wxBitmap\& }{bitmap}}
Selects the given bitmap into the device context, to use as the memory
bitmap. Selecting the bitmap into a memory DC allows you to draw into

View File

@@ -559,7 +559,7 @@ Inserts a radio item at position $0$.
\membersection{wxMenu::PrependSeparator}\label{wxmenuprependseparator}
\func{wxMenuItem*}{PrependSeparator}{\param{size\_t }{pos}}
\func{wxMenuItem*}{PrependSeparator}{\void}
Inserts a separator at position $0$.
@@ -686,11 +686,11 @@ menu shortcuts may cease to work.
\membersection{wxMenuBar::wxMenuBar}\label{wxmenubarctor}
\func{void}{wxMenuBar}{\param{long }{style = 0}}
\func{}{wxMenuBar}{\param{long }{style = 0}}
Default constructor.
\func{void}{wxMenuBar}{\param{int}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}}
\func{}{wxMenuBar}{\param{int}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}}
Construct a menu bar from arrays of menus and titles.

View File

@@ -43,7 +43,7 @@ highlighted, i.e. the currently selected menu item has changed.}
\membersection{wxMenuEvent::wxMenuEvent}\label{wxmenueventctor}
\func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxDC* }{dc = NULL}}
\func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxMenu* }{menu = NULL}}
Constructor.

View File

@@ -53,34 +53,6 @@ Constructs a wxModule object.
Destructor.
\membersection{wxModule::CleanupModules}\label{wxmodulecleanupmodules}
\func{static void}{CleanupModules}{\void}
Calls Exit for each module instance. Called by wxWidgets on exit, so there is no
need for an application to call it.
\membersection{wxModule::Exit}\label{wxmoduleexit}
\func{void}{Exit}{\void}
Calls OnExit. This function is called by wxWidgets and should not need to be called
by an application.
\membersection{wxModule::Init}\label{wxmoduleinit}
\func{bool}{Init}{\void}
Calls OnInit. This function is called by wxWidgets and should not need to be called
by an application.
\membersection{wxModule::InitializeModules}\label{wxmoduleinitializemodules}
\func{static bool}{InitializeModules}{\void}
Calls Init for each module instance. Called by wxWidgets on startup, so there is no
need for an application to call it.
\membersection{wxModule::OnExit}\label{wxmoduleonexit}
\func{virtual void}{OnExit}{\void}
@@ -94,17 +66,3 @@ Provide this function with appropriate cleanup for your module.
Provide this function with appropriate initialization for your module. If the function
returns false, wxWidgets will exit immediately.
\membersection{wxModule::RegisterModule}\label{wxmoduleregistermodule}
\func{static void}{RegisterModule}{\param{wxModule*}{ module}}
Registers this module with wxWidgets. Called by wxWidgets on startup, so there is no
need for an application to call it.
\membersection{wxModule::RegisterModules}\label{wxmoduleregistermodules}
\func{static bool}{RegisterModules}{\void}
Creates instances of and registers all modules. Called by wxWidgets on startup, so there is no
need for an application to call it.

View File

@@ -154,7 +154,7 @@ action.
\membersection{wxMouseEvent::wxMouseEvent}\label{wxmouseeventctor}
\func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}, \param{int}{ id = 0}}
\func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}}
Constructor. Valid event types are:

View File

@@ -1175,7 +1175,7 @@ problem initializing the printer device context (current printer not set, for ex
\membersection{wxPrintPreview::PaintPage}\label{wxprintpreviewpaintpage}
\func{bool}{PaintPage}{\param{wxWindow* }{window}}
\func{bool}{PaintPage}{\param{wxPreviewCanvas *}{canvas}, \param{wxDC& }{dc}}
This refreshes the preview window with the preview image.
It must be called from the preview window's OnPaint member.

View File

@@ -290,11 +290,11 @@ Returns the y value for the current region.
An alias for GetWidth.
\membersection{wxRegionIterator::GetWidth}\label{wxregioniteratorgetwidth}
\membersection{wxRegionIterator::GetHeight}\label{wxregioniteratorgetheight}
\constfunc{wxCoord}{GetWidth}{\void}
\constfunc{wxCoord}{GetHeight}{\void}
Returns the width value for the current region.
Returns the height value for the current region.
\membersection{wxRegionIterator::GetH}\label{wxregioniteratorgeth}
@@ -302,18 +302,18 @@ Returns the width value for the current region.
An alias for GetHeight.
\membersection{wxRegionIterator::GetHeight}\label{wxregioniteratorgetheight}
\constfunc{wxCoord}{GetWidth}{\void}
Returns the width value for the current region.
\membersection{wxRegionIterator::GetRect}\label{wxregioniteratorgetrect}
\constfunc{wxRect}{GetRect}{\void}
Returns the current rectangle.
\membersection{wxRegionIterator::GetWidth}\label{wxregioniteratorgetwidth}
\constfunc{wxCoord}{GetWidth}{\void}
Returns the width value for the current region.
\membersection{wxRegionIterator::HaveRects}\label{wxregioniteratorhaverects}
\constfunc{bool}{HaveRects}{\void}

View File

@@ -61,7 +61,7 @@ Searches for string and deletes from list, deallocating memory.
\membersection{wxStringList::ListToArray}\label{wxstringlistlisttoarray}
\func{char*}{ListToArray}{\param{bool}{ new\_copies = false}}
\func{wxChar**}{ListToArray}{\param{bool}{ new\_copies = false}}
Converts the list to an array of strings, only allocating new memory if
\rtfsp{\bf new\_copies} is true.