From e2622169f41272d053f62f61243b8571fc6629ce Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sat, 2 Dec 2006 18:33:35 +0000 Subject: [PATCH] escape underscores to fix the docs build git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43748 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/auimanager.tex | 4 ++-- docs/latex/wx/auinotebook.tex | 5 +++-- docs/latex/wx/auipaneinfo.tex | 11 +++++++---- docs/latex/wx/htmllbox.tex | 4 ++-- docs/latex/wx/richtextstyleorganiserdialog.tex | 4 ++-- docs/latex/wx/symbolpickerdialog.tex | 4 ++-- docs/latex/wx/wxstring.tex | 4 ++-- 7 files changed, 20 insertions(+), 16 deletions(-) diff --git a/docs/latex/wx/auimanager.tex b/docs/latex/wx/auimanager.tex index f715271934..7f36a92960 100644 --- a/docs/latex/wx/auimanager.tex +++ b/docs/latex/wx/auimanager.tex @@ -166,7 +166,7 @@ Returns the current art provider being used. See also: \helpref{wxAuiDockArt}{wxauidockart}. -\func{void}{GetDockSizeConstraint}{\param{double* }{width_pct}, \param{double* }{height_pct}} +\func{void}{GetDockSizeConstraint}{\param{double* }{widthpct}, \param{double* }{heightpct}} Returns the current dock constraint values. See SetDockSizeConstraint() for more information. @@ -269,7 +269,7 @@ will be deleted by wxAuiManager. See also: \helpref{wxAuiDockArt}{wxauidockart}. -\func{void}{SetDockSizeConstraint}{\param{double }{width_pct}, \param{double }{height_pct}} +\func{void}{SetDockSizeConstraint}{\param{double }{widthpct}, \param{double }{heightpct}} When a user creates a new dock by dragging a window into a docked position, often times the large size of the window will create a dock that is unwieldly large. wxAuiManager by default limits the size of any diff --git a/docs/latex/wx/auinotebook.tex b/docs/latex/wx/auinotebook.tex index 31feb9fbb5..b7d3ba5921 100644 --- a/docs/latex/wx/auinotebook.tex +++ b/docs/latex/wx/auinotebook.tex @@ -103,7 +103,8 @@ Returns the number of pages in the notebook. \constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}} -Returns the page index for the specified window. If the window is not found in the notebook, wxNOT_FOUND is returned. +Returns the page index for the specified window. If the window is not found in +the notebook, wxNOT\_FOUND is returned. \membersection{wxAuiNotebook::GetPageText}\label{wxauinotebookgetpagetext} @@ -175,7 +176,7 @@ instruct the control to use dynamic tab height, which is the default behaviour. Under the default behaviour, when a tab with a large bitmap is added, the tab control's height will automatically increase to accommodate the larger bitmap. -\func{void}{Split}{\param{size_t }{page}, \param{int }{direction}} +\func{void}{Split}{\param{size\_t }{page}, \param{int }{direction}} Split performs a split operation programmatically. The argument \arg{page} indicates the page that will be split off. This page will also become the active page after the diff --git a/docs/latex/wx/auipaneinfo.tex b/docs/latex/wx/auipaneinfo.tex index 9a6235ce4d..d9bf847f94 100644 --- a/docs/latex/wx/auipaneinfo.tex +++ b/docs/latex/wx/auipaneinfo.tex @@ -63,7 +63,8 @@ BestSize() sets the ideal size for the pane. The docking manager will attempt t \func{wxAuiPaneInfo\&}{Bottom}{\void} -Bottom() sets the pane dock position to the bottom side of the frame. This is the same thing as calling Direction(wxAUI_DOCK_BOTTOM). +Bottom() sets the pane dock position to the bottom side of the frame. This is +the same thing as calling Direction(wxAUI\_DOCK\_BOTTOM). \membersection{wxAuiPaneInfo::BottomDockable}\label{wxauipaneinfobottomdockable} @@ -88,7 +89,8 @@ CaptionVisible indicates that a pane caption should be visible. If false, no pa \func{wxAuiPaneInfo\&}{Centre}{\void} \func{wxAuiPaneInfo\&}{Center}{\void} -Center() sets the pane dock position to the left side of the frame. This is the same thing as calling Direction(wxAUI_DOCK_CENTRE). +Center() sets the pane dock position to the left side of the frame. This is +the same thing as calling Direction(wxAUI\_DOCK\_CENTRE). \membersection{wxAuiPaneInfo::CentrePane}\label{wxauipaneinfocentrepane} @@ -338,7 +340,8 @@ Layer() determines the layer of the docked pane. The dock layer is similar to a \func{wxAuiPaneInfo\&}{Left}{\void} -Left() sets the pane dock position to the left side of the frame. This is the same thing as calling Direction(wxAUI_DOCK_LEFT). +Left() sets the pane dock position to the left side of the frame. This is the +same thing as calling Direction(wxAUI\_DOCK\_LEFT). \membersection{wxAuiPaneInfo::LeftDockable}\label{wxauipaneinfoleftdockable} @@ -437,7 +440,7 @@ used on loading perspectives etc. \func{wxAuiPaneInfo\&}{SetFlag}{\param{unsigned int }{flag}, \param{bool }{option\_state}} -SetFlag() turns the property given by flag on or off with the option_state parameter. +SetFlag() turns the property given by flag on or off with the option\_state parameter. \membersection{wxAuiPaneInfo::Show}\label{wxauipaneinfoshow} diff --git a/docs/latex/wx/htmllbox.tex b/docs/latex/wx/htmllbox.tex index 4e603c7e9f..06eec42efe 100644 --- a/docs/latex/wx/htmllbox.tex +++ b/docs/latex/wx/htmllbox.tex @@ -80,7 +80,7 @@ Creates the control and optionally sets the initial number of items in it \helpref{SetItemCount()}{wxvlistboxsetitemcount}). There are no special styles defined for wxHtmlListBox, in particular the -wxListBox styles (with the exception of {\tt wxLB_MULTIPLE}) can not be used here. +wxListBox styles (with the exception of {\tt wxLB\_MULTIPLE}) can not be used here. Returns {\tt true} on success or {\tt false} if the control couldn't be created @@ -231,7 +231,7 @@ or {\tt } tags. \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxHLB\_DEFAULT\_STYLE}}{The default style: wxSUNKEN_BORDER} +\twocolitem{\windowstyle{wxHLB\_DEFAULT\_STYLE}}{The default style: wxSUNKEN\_BORDER} \twocolitem{\windowstyle{wxHLB\_MULTIPLE}}{Multiple-selection list: the user can toggle multiple items on and off.} \end{twocollist} diff --git a/docs/latex/wx/richtextstyleorganiserdialog.tex b/docs/latex/wx/richtextstyleorganiserdialog.tex index e7d95c4b78..ccb828bdf1 100644 --- a/docs/latex/wx/richtextstyleorganiserdialog.tex +++ b/docs/latex/wx/richtextstyleorganiserdialog.tex @@ -17,7 +17,7 @@ present styles. \membersection{wxRichTextStyleOrganiserDialog::wxRichTextStyleOrganiserDialog}\label{wxrichtextstyleorganiserdialogwxrichtextstyleorganiserdialog} -\func{}{wxRichTextStyleOrganiserDialog}{\param{int }{flags}, \param{wxRichTextStyleSheet* }{sheet}, \param{wxRichTextCtrl* }{ctrl}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{caption = \_("Style Organiser")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX}} +\func{}{wxRichTextStyleOrganiserDialog}{\param{int }{flags}, \param{wxRichTextStyleSheet* }{sheet}, \param{wxRichTextCtrl* }{ctrl}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{caption = \_("Style Organiser")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT\_DIALOG\_STYLE|wxRESIZE\_BORDER|wxSYSTEM\_MENU|wxCLOSE\_BOX}} \func{}{wxRichTextStyleOrganiserDialog}{\void} @@ -67,7 +67,7 @@ Applies the selected style to selection in the given control or the control pass \membersection{wxRichTextStyleOrganiserDialog::Create}\label{wxrichtextstyleorganiserdialogcreate} -\func{bool}{Create}{\param{int }{flags}, \param{wxRichTextStyleSheet* }{sheet}, \param{wxRichTextCtrl* }{ctrl}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{caption = \_("Style Organiser")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX}} +\func{bool}{Create}{\param{int }{flags}, \param{wxRichTextStyleSheet* }{sheet}, \param{wxRichTextCtrl* }{ctrl}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{caption = \_("Style Organiser")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT\_DIALOG\_STYLE|wxRESIZE\_BORDER|wxSYSTEM\_MENU|wxCLOSE\_BOX}} Creates the dialog. See \membersection{wxRichTextStyleOrganiserDialog::wxRichTextStyleOrganiserDialog}{wxrichtextstyleorganiserdialogwxrichtextstyleorganiserdialog} for details. diff --git a/docs/latex/wx/symbolpickerdialog.tex b/docs/latex/wx/symbolpickerdialog.tex index 7030e7f6f5..7bb3c7f0e7 100644 --- a/docs/latex/wx/symbolpickerdialog.tex +++ b/docs/latex/wx/symbolpickerdialog.tex @@ -74,7 +74,7 @@ rich text control in either the current font or specified font. \membersection{wxSymbolPickerDialog::wxSymbolPickerDialog}\label{wxsymbolpickerdialogwxsymbolpickerdialog} -\func{}{wxSymbolPickerDialog}{\param{const wxString\& }{symbol}, \param{const wxString\& }{initialFont}, \param{const wxString\& }{normalTextFont}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{title = \_("Symbols")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxCLOSE_BOX}} +\func{}{wxSymbolPickerDialog}{\param{const wxString\& }{symbol}, \param{const wxString\& }{initialFont}, \param{const wxString\& }{normalTextFont}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{title = \_("Symbols")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT\_DIALOG\_STYLE|wxRESIZE\_BORDER|wxCLOSE\_BOX}} \func{}{wxSymbolPickerDialog}{\void} @@ -102,7 +102,7 @@ Constructors. \membersection{wxSymbolPickerDialog::Create}\label{wxsymbolpickerdialogcreate} -\func{bool}{Create}{\param{const wxString\& }{symbol}, \param{const wxString\& }{initialFont}, \param{const wxString\& }{normalTextFont}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{title = \_("Symbols")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxCLOSE_BOX}} +\func{bool}{Create}{\param{const wxString\& }{symbol}, \param{const wxString\& }{initialFont}, \param{const wxString\& }{normalTextFont}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{title = \_("Symbols")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT\_DIALOG\_STYLE|wxRESIZE\_BORDER|wxCLOSE\_BOX}} Creation: see \helpref{the constructor}{wxsymbolpickerdialogwxsymbolpickerdialog} for details about the parameters. diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 76a8e11235..ff14f5ff40 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -653,11 +653,11 @@ See also: \helpref{Clear()}{wxstringclear}. \constfunc{int}{Find}{\param{wxChar}{ ch}, \param{bool}{ fromEnd = false}} -Searches for the given character. Returns the starting index, or {\tt wxNOT_FOUND} if not found. +Searches for the given character. Returns the starting index, or {\tt wxNOT\_FOUND} if not found. \constfunc{int}{Find}{\param{const wxChar*}{ sz}} -Searches for the given string. Returns the starting index, or {\tt wxNOT_FOUND} if not found. +Searches for the given string. Returns the starting index, or {\tt wxNOT\_FOUND} if not found. \membersection{wxString::First}\label{wxstringfirst} -- 2.45.2