Updated border style names

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@47878 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2007-08-05 10:10:37 +00:00
parent de34bb081b
commit 0a42e3b6ac
14 changed files with 25 additions and 26 deletions

View File

@@ -38,7 +38,7 @@ It is only available if \texttt{wxUSE\_ANIMATIONCTRL} is set to $1$ (the default
\twocolwidtha{5cm}% \twocolwidtha{5cm}%
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxAC\_DEFAULT\_STYLE}}{The default style: wxNO\_BORDER.} \twocolitem{\windowstyle{wxAC\_DEFAULT\_STYLE}}{The default style: wxBORDER\_NONE.}
\twocolitem{\windowstyle{wxAC\_NO\_AUTORESIZE}}{By default, the control will adjust \twocolitem{\windowstyle{wxAC\_NO\_AUTORESIZE}}{By default, the control will adjust
its size to exactly fit to the size of the animation when \helpref{SetAnimation}{wxanimationctrlsetanimation} its size to exactly fit to the size of the animation when \helpref{SetAnimation}{wxanimationctrlsetanimation}
is called. If this style flag is given, the control will not change its size} is called. If this style flag is given, the control will not change its size}

View File

@@ -29,7 +29,7 @@ almost any other window.
\twocolitem{\windowstyle{wxBU\_RIGHT}}{Right-justifies the bitmap label. Windows and GTK+ only.} \twocolitem{\windowstyle{wxBU\_RIGHT}}{Right-justifies the bitmap label. Windows and GTK+ only.}
\twocolitem{\windowstyle{wxBU\_BOTTOM}}{Aligns the label to the bottom of the button. Windows and GTK+ only.} \twocolitem{\windowstyle{wxBU\_BOTTOM}}{Aligns the label to the bottom of the button. Windows and GTK+ only.}
\twocolitem{\windowstyle{wxBU\_EXACTFIT}}{Creates the button as small as possible instead of making it of the standard size (which is the default behaviour ).} \twocolitem{\windowstyle{wxBU\_EXACTFIT}}{Creates the button as small as possible instead of making it of the standard size (which is the default behaviour ).}
\twocolitem{\windowstyle{wxNO\_BORDER}}{Creates a flat button. Windows and GTK+ only.} \twocolitem{\windowstyle{wxBORDER\_NONE}}{Creates a flat button. Windows and GTK+ only.}
\end{twocollist} \end{twocollist}
See also \helpref{window styles overview}{windowstyles}. See also \helpref{window styles overview}{windowstyles}.

View File

@@ -400,8 +400,7 @@ itself can be custom painted.}
\twocolitem{{\tt wxComboCtrlFeatures::PaintWritable}}{A variable- \twocolitem{{\tt wxComboCtrlFeatures::PaintWritable}}{A variable-
width area in front of writable combo control's textctrl can width area in front of writable combo control's textctrl can
be custom painted.} be custom painted.}
\twocolitem{{\tt wxComboCtrlFeatures::Borderless}}{wxNO\_BORDER \twocolitem{{\tt wxComboCtrlFeatures::Borderless}}{wxBORDER\_NONE window style works.}
window style works.}
\twocolitem{{\tt wxComboCtrlFeatures::All}}{All of the \twocolitem{{\tt wxComboCtrlFeatures::All}}{All of the
above.} above.}
\end{twocollist} \end{twocollist}

View File

@@ -40,7 +40,7 @@ Default constructor.
\func{}{wxGenericDirCtrl}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id = -1}, \func{}{wxGenericDirCtrl}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id = -1},
\param{const wxString\& }{dir = wxDirDialogDefaultFolderStr}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxString\& }{dir = wxDirDialogDefaultFolderStr}, \param{const wxPoint\& }{pos = wxDefaultPosition},
\param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDIRCTRL\_3D\_INTERNAL|wxSUNKEN\_BORDER}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDIRCTRL\_3D\_INTERNAL|wxBORDER\_SUNKEN},
\param{const wxString\& }{filter = wxEmptyString}, \param{const wxString\& }{filter = wxEmptyString},
\param{int }{defaultFilter = 0}, \param{int }{defaultFilter = 0},
\param{const wxString\& }{name = wxTreeCtrlNameStr}} \param{const wxString\& }{name = wxTreeCtrlNameStr}}
@@ -78,7 +78,7 @@ Destructor.
\membersection{wxGenericDirCtrl::Create}\label{wxgenericdirctrlcreate} \membersection{wxGenericDirCtrl::Create}\label{wxgenericdirctrlcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id = -1}, \param{const wxString\& }{dir = wxDirDialogDefaultFolderStr}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDIRCTRL\_3D\_INTERNAL|wxSUNKEN\_BORDER}, \param{const wxString\& }{filter = wxEmptyString}, \param{int }{defaultFilter = 0}, \param{const wxString\& }{name = wxTreeCtrlNameStr}} \func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id = -1}, \param{const wxString\& }{dir = wxDirDialogDefaultFolderStr}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDIRCTRL\_3D\_INTERNAL|wxBORDER\_SUNKEN}, \param{const wxString\& }{filter = wxEmptyString}, \param{int }{defaultFilter = 0}, \param{const wxString\& }{name = wxTreeCtrlNameStr}}
Create function for two-step construction. See \helpref{wxGenericDirCtrl::wxGenericDirCtrl}{wxgenericdirctrlwxgenericdirctrl} for details. Create function for two-step construction. See \helpref{wxGenericDirCtrl::wxGenericDirCtrl}{wxgenericdirctrlwxgenericdirctrl} for details.

View File

@@ -215,7 +215,7 @@ Note that you can put controls and other windows on the status bar if you wish.
\membersection{wxFrame::CreateToolBar}\label{wxframecreatetoolbar} \membersection{wxFrame::CreateToolBar}\label{wxframecreatetoolbar}
\func{virtual wxToolBar*}{CreateToolBar}{\param{long}{ style = wxNO\_BORDER \pipe wxTB\_HORIZONTAL}, \func{virtual wxToolBar*}{CreateToolBar}{\param{long}{ style = wxBORDER\_NONE \pipe wxTB\_HORIZONTAL},
\param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "toolBar"}} \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "toolBar"}}
Creates a toolbar at the top or left of the frame. Creates a toolbar at the top or left of the frame.

View File

@@ -173,7 +173,7 @@ For example:
m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config object here m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config object here
m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow); m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
m_embeddedHelpWindow->Create(this, m_embeddedHelpWindow->Create(this,
wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxNO_BORDER, wxHF_DEFAULT_STYLE); wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);
m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip"))); m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip")));
\end{verbatim} \end{verbatim}
@@ -198,7 +198,7 @@ the embedded window to be destroyed independently of the help controller.
\func{}{wxHtmlHelpWindow}{\param{wxHtmlHelpData* }{data = NULL}} \func{}{wxHtmlHelpWindow}{\param{wxHtmlHelpData* }{data = NULL}}
\func{}{wxHtmlHelpWindow}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ pos = wxDefaultSize}, \param{int }{style = wxTAB\_TRAVERSAL|wxTAB\_wxNO\_BORDER}, \param{int }{helpStyle = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}} \func{}{wxHtmlHelpWindow}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ pos = wxDefaultSize}, \param{int }{style = wxTAB\_TRAVERSAL|wxBORDER\_NONE}, \param{int }{helpStyle = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}}
Constructor. Constructor.
@@ -206,7 +206,7 @@ Constructor. For the values of {\it helpStyle}, please see the documentation for
\membersection{wxHtmlHelpWindow::Create}\label{wxhtmlhelpwindowcreate} \membersection{wxHtmlHelpWindow::Create}\label{wxhtmlhelpwindowcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ pos = wxDefaultSize}, \param{int }{style = wxTAB\_TRAVERSAL|wxTAB\_wxNO\_BORDER}, \param{int }{helpStyle = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}} \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ pos = wxDefaultSize}, \param{int }{style = wxTAB\_TRAVERSAL|wxBORDER\_NONE}, \param{int }{helpStyle = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}}
Creates the help window. See \helpref{the constructor}{wxhtmlhelpwindowwxhtmlhelpwindow} Creates the help window. See \helpref{the constructor}{wxhtmlhelpwindowwxhtmlhelpwindow}
for a description of the parameters. for a description of the parameters.

View File

@@ -239,7 +239,7 @@ or {\tt <body>} tags.
\twocolwidtha{5cm}% \twocolwidtha{5cm}%
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxHLB\_DEFAULT\_STYLE}}{The default style: wxSUNKEN\_BORDER} \twocolitem{\windowstyle{wxHLB\_DEFAULT\_STYLE}}{The default style: wxBORDER\_SUNKEN}
\twocolitem{\windowstyle{wxHLB\_MULTIPLE}}{Multiple-selection list: the user can toggle multiple \twocolitem{\windowstyle{wxHLB\_MULTIPLE}}{Multiple-selection list: the user can toggle multiple
items on and off.} items on and off.}
\end{twocollist} \end{twocollist}

View File

@@ -47,7 +47,7 @@ Note that standard \helpref{wxWindow}{wxwindow} functions like \helpref{SetBackg
\twocolitem{\windowstyle{wxHL\_ALIGN\_RIGHT}}{Align the text to the right.} \twocolitem{\windowstyle{wxHL\_ALIGN\_RIGHT}}{Align the text to the right.}
\twocolitem{\windowstyle{wxHL\_ALIGN\_CENTRE}}{Center the text (horizontally).} \twocolitem{\windowstyle{wxHL\_ALIGN\_CENTRE}}{Center the text (horizontally).}
\twocolitem{\windowstyle{wxHL\_CONTEXTMENU}}{Pop up a context menu when the hyperlink is right-clicked. The context menu contains a \texttt{``Copy URL"} menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control.} \twocolitem{\windowstyle{wxHL\_CONTEXTMENU}}{Pop up a context menu when the hyperlink is right-clicked. The context menu contains a \texttt{``Copy URL"} menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control.}
\twocolitem{\windowstyle{wxHL\_DEFAULT\_STYLE}}{The default style for wxHyperlinkCtrl: \texttt{wxNO\_BORDER|wxHL\_CONTEXTMENU|wxHL\_ALIGN\_CENTRE}.} \twocolitem{\windowstyle{wxHL\_DEFAULT\_STYLE}}{The default style for wxHyperlinkCtrl: \texttt{wxBORDER\_NONE|wxHL\_CONTEXTMENU|wxHL\_ALIGN\_CENTRE}.}
\end{twocollist} \end{twocollist}
See also \helpref{window styles overview}{windowstyles}. See also \helpref{window styles overview}{windowstyles}.

View File

@@ -70,7 +70,7 @@ The following code is taken from the sample, and adds text and styles to a rich
{\small {\small
\begin{verbatim} \begin{verbatim}
wxRichTextCtrl* richTextCtrl = new wxRichTextCtrl(splitter, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(200, 200), wxVSCROLL|wxHSCROLL|wxNO_BORDER|wxWANTS_CHARS); wxRichTextCtrl* richTextCtrl = new wxRichTextCtrl(splitter, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(200, 200), wxVSCROLL|wxHSCROLL|wxBORDER_NONE|wxWANTS_CHARS);
wxFont textFont = wxFont(12, wxROMAN, wxNORMAL, wxNORMAL); wxFont textFont = wxFont(12, wxROMAN, wxNORMAL, wxNORMAL);
wxFont boldFont = wxFont(12, wxROMAN, wxNORMAL, wxBOLD); wxFont boldFont = wxFont(12, wxROMAN, wxNORMAL, wxBOLD);

View File

@@ -13,7 +13,7 @@ Example usage:
wxSplashScreen* splash = new wxSplashScreen(bitmap, wxSplashScreen* splash = new wxSplashScreen(bitmap,
wxSPLASH_CENTRE_ON_SCREEN|wxSPLASH_TIMEOUT, wxSPLASH_CENTRE_ON_SCREEN|wxSPLASH_TIMEOUT,
6000, NULL, -1, wxDefaultPosition, wxDefaultSize, 6000, NULL, -1, wxDefaultPosition, wxDefaultSize,
wxSIMPLE_BORDER|wxSTAY_ON_TOP); wxBORDER_SIMPLE|wxSTAY_ON_TOP);
} }
wxYield(); wxYield();
\end{verbatim} \end{verbatim}
@@ -37,7 +37,7 @@ Example usage:
\membersection{wxSplashScreen::wxSplashScreen}\label{wxsplashscreenwxsplashscreen} \membersection{wxSplashScreen::wxSplashScreen}\label{wxsplashscreenwxsplashscreen}
\func{}{wxSplashScreen}{\param{const wxBitmap\& }{bitmap}, \param{long }{splashStyle}, \param{int }{milliseconds}, \param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxSIMPLE\_BORDER|wxFRAME\_NO\_TASKBAR|wxSTAY\_ON\_TOP}} \func{}{wxSplashScreen}{\param{const wxBitmap\& }{bitmap}, \param{long }{splashStyle}, \param{int }{milliseconds}, \param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxBORDER\_SIMPLE|wxFRAME\_NO\_TASKBAR|wxSTAY\_ON\_TOP}}
Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position
and size, and a window style. and size, and a window style.

View File

@@ -149,7 +149,7 @@ bool MyApp::OnInit(void)
frame->SetMenuBar(menuBar); frame->SetMenuBar(menuBar);
// Create the toolbar // Create the toolbar
frame->CreateToolBar(wxNO_BORDER|wxHORIZONTAL|wxTB_FLAT, ID_TOOLBAR); frame->CreateToolBar(wxBORDER\_NONE|wxHORIZONTAL|wxTB_FLAT, ID_TOOLBAR);
frame->GetToolBar()->SetMargins( 2, 2 ); frame->GetToolBar()->SetMargins( 2, 2 );

View File

@@ -320,7 +320,7 @@ This is the XML file (resource.xrc) for the XRC sample.
<object class="wxStaticText"> <object class="wxStaticText">
<label>fdgdfgdfgdfg</label> <label>fdgdfgdfgdfg</label>
</object> </object>
<style>wxSUNKEN_BORDER</style> <style>wxBORDER\_SUNKEN</style>
</object> </object>
<flag>wxALIGN_CENTER</flag> <flag>wxALIGN_CENTER</flag>
</object> </object>
@@ -379,7 +379,7 @@ This is the XML file (resource.xrc) for the XRC sample.
<object class="sizeritem" name="dfgdfg"> <object class="sizeritem" name="dfgdfg">
<object class="wxTextCtrl"> <object class="wxTextCtrl">
<size>200,200d</size> <size>200,200d</size>
<style>wxTE_MULTILINE|wxSUNKEN_BORDER</style> <style>wxTE_MULTILINE|wxBORDER_SUNKEN</style>
<value>Hello, this is an ordinary multiline\n textctrl....</value> <value>Hello, this is an ordinary multiline\n textctrl....</value>
</object> </object>
<option>1</option> <option>1</option>
@@ -544,7 +544,7 @@ IMPLEMENT_DYNAMIC_CLASS(MyControlXmlHandler, wxXmlResourceHandler)
MyControlXmlHandler::MyControlXmlHandler() MyControlXmlHandler::MyControlXmlHandler()
{ {
// this call adds support for all wxWindows class styles // this call adds support for all wxWindows class styles
// (e.g. wxSIMPLE_BORDER, wxSUNKEN_BORDER, wxWS_EX_* etc etc) // (e.g. wxBORDER_SIMPLE, wxBORDER_SUNKEN, wxWS_EX_* etc etc)
AddWindowStyles(); AddWindowStyles();
// if MyControl class supports e.g. MYCONTROL_DEFAULT_STYLE // if MyControl class supports e.g. MYCONTROL_DEFAULT_STYLE

View File

@@ -52,13 +52,13 @@ window class or on all platforms.
\twocolwidtha{5cm}% \twocolwidtha{5cm}%
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name \twocolitem{\windowstyle{wxBORDER\_SIMPLE}}{Displays a thin border around the window. wxBORDER is the old name
for this style. } for this style. }
\twocolitem{\windowstyle{wxDOUBLE\_BORDER}}{Displays a double border. Windows and Mac only.} \twocolitem{\windowstyle{wxBORDER\_DOUBLE}}{Displays a double border. Windows and Mac only.}
\twocolitem{\windowstyle{wxSUNKEN\_BORDER}}{Displays a sunken border.} \twocolitem{\windowstyle{wxBORDER\_SUNKEN}}{Displays a sunken border.}
\twocolitem{\windowstyle{wxRAISED\_BORDER}}{Displays a raised border.} \twocolitem{\windowstyle{wxBORDER\_RAISED}}{Displays a raised border.}
\twocolitem{\windowstyle{wxSTATIC\_BORDER}}{Displays a border suitable for a static control. Windows only. } \twocolitem{\windowstyle{wxBORDER\_STATIC}}{Displays a border suitable for a static control. Windows only. }
\twocolitem{\windowstyle{wxNO\_BORDER}}{Displays no border, overriding the default border style for the window.} \twocolitem{\windowstyle{wxBORDER\_NONE}}{Displays no border, overriding the default border style for the window.}
\twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint \twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint
events. Windows only.} events. Windows only.}
\twocolitem{\windowstyle{wxTAB\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.} \twocolitem{\windowstyle{wxTAB\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.}

View File

@@ -267,7 +267,7 @@ tooltips are distinct controls, and it will be hard to add dynamic
tooltip support. tooltip support.
Control borders on PocketPC and Smartphone should normally be specified with Control borders on PocketPC and Smartphone should normally be specified with
wxSIMPLE\_BORDER instead of wxSUNKEN\_BORDER. Controls will usually adapt wxBORDER\_SIMPLE instead of wxBORDER\_SUNKEN. Controls will usually adapt
appropriately by virtue of their GetDefaultBorder() function, but if you appropriately by virtue of their GetDefaultBorder() function, but if you
wish to specify a style explicitly you can use wxDEFAULT\_CONTROL\_BORDER wish to specify a style explicitly you can use wxDEFAULT\_CONTROL\_BORDER
which will give a simple border on PocketPC and Smartphone, and the sunken border on which will give a simple border on PocketPC and Smartphone, and the sunken border on