Remove obsolete symbols and platforms from the documentation
Don't mention pre-XP Windows versions and other obsolete platforms such as OS/2 and the symbols which were only useful for them. Closes https://github.com/wxWidgets/wxWidgets/pull/137
This commit is contained in:
@@ -546,7 +546,7 @@ public:
|
||||
Notice that, as with DrawText(), the @a text can contain multiple lines
|
||||
separated by the new line (@c '\\n') characters.
|
||||
|
||||
@note Under Win9x only TrueType fonts can be drawn by this function. In
|
||||
@note Under MSW only TrueType fonts can be drawn by this function. In
|
||||
particular, a font different from @c wxNORMAL_FONT should be used
|
||||
as the latter is not a TrueType font. @c wxSWISS_FONT is an
|
||||
example of a font which is.
|
||||
|
@@ -45,11 +45,11 @@ const char wxDirDialogNameStr[] = "wxDirCtrl";
|
||||
user.
|
||||
@endStyleTable
|
||||
|
||||
Notice that @c wxRESIZE_BORDER has special side effect under recent (i.e.
|
||||
later than Win9x) Windows where two different directory selection dialogs
|
||||
are available and this style also implicitly selects the new version as the
|
||||
old one always has fixed size. As the new version is almost always
|
||||
preferable, it is recommended that @c wxRESIZE_BORDER style be always used.
|
||||
Notice that @c wxRESIZE_BORDER has special side effect under Windows
|
||||
where two different directory selection dialogs are available and this
|
||||
style also implicitly selects the new version as the old one always has
|
||||
fixed size. As the new version is almost always preferable, it is
|
||||
recommended that @c wxRESIZE_BORDER style be always used.
|
||||
This is the case if the dialog is created with the default style value but
|
||||
if you need to use any additional styles you should still specify @c
|
||||
wxDD_DEFAULT_STYLE unless you explicitly need to use the old dialog version
|
||||
|
@@ -217,8 +217,8 @@ public:
|
||||
|
||||
This can be useful, for example, when a time-consuming process writes to a
|
||||
text window. Without an occasional yield, the text window will not be updated
|
||||
properly, and on systems with cooperative multitasking, such as Windows 3.1
|
||||
other processes will not respond.
|
||||
properly, and on systems with cooperative multitasking, other processes
|
||||
will not respond.
|
||||
|
||||
Caution should be exercised, however, since yielding may allow the
|
||||
user to perform actions which are not compatible with the current task.
|
||||
|
@@ -22,7 +22,7 @@ enum
|
||||
/**
|
||||
Default wildcard string used in wxFileDialog corresponding to all files.
|
||||
|
||||
It is defined as "*.*" under MSW and OS/2 and "*" everywhere else.
|
||||
It is defined as "*.*" under MSW and "*" everywhere else.
|
||||
*/
|
||||
const char wxFileSelectorDefaultWildcardStr[];
|
||||
|
||||
|
@@ -814,8 +814,7 @@ public:
|
||||
/**
|
||||
This function builds a volume path string, for example "C:\\".
|
||||
|
||||
Implemented for the platforms which use drive letters, i.e. DOS, MSW
|
||||
and OS/2 only.
|
||||
Implemented for the platforms which use drive letters, i.e. MSW only.
|
||||
|
||||
@since 2.9.0
|
||||
|
||||
|
@@ -112,7 +112,7 @@ public:
|
||||
HKUSR, ///< HKEY_USERS
|
||||
HKPD, ///< HKEY_PERFORMANCE_DATA
|
||||
HKCC, ///< HKEY_CURRENT_CONFIG
|
||||
HKDD, ///< HKEY_DYN_DATA (Obsolete: Windows 9x only)
|
||||
HKDD, ///< HKEY_DYN_DATA (Obsolete)
|
||||
HKMAX
|
||||
};
|
||||
|
||||
|
@@ -23,7 +23,6 @@ enum
|
||||
#define wxNB_FIXEDWIDTH 0x0100
|
||||
#define wxNB_MULTILINE 0x0200
|
||||
#define wxNB_NOPAGETHEME 0x0400
|
||||
#define wxNB_FLAT 0x0800
|
||||
|
||||
wxEventType wxEVT_NOTEBOOK_PAGE_CHANGED;
|
||||
wxEventType wxEVT_NOTEBOOK_PAGE_CHANGING;
|
||||
@@ -58,8 +57,6 @@ wxEventType wxEVT_NOTEBOOK_PAGE_CHANGING;
|
||||
@style{wxNB_NOPAGETHEME}
|
||||
(Windows only) Display a solid colour on notebook pages, and not a
|
||||
gradient, which can reduce performance.
|
||||
@style{wxNB_FLAT}
|
||||
(Windows CE only) Show tabs in a flat style.
|
||||
@endStyleTable
|
||||
|
||||
The styles wxNB_LEFT, RIGHT and BOTTOM are not supported under
|
||||
|
@@ -171,7 +171,6 @@ public:
|
||||
|
||||
@remarks Different versions of Windows and different versions of other
|
||||
platforms support very different subsets of the styles above
|
||||
- there is no similarity even between Windows95 and Windows98 -
|
||||
so handle with care.
|
||||
|
||||
@see SetStyle(), SetColour(), SetWidth()
|
||||
|
@@ -28,16 +28,10 @@ enum wxOperatingSystemId
|
||||
//! A combination of all @c wxOS_MAC_* values previously listed.
|
||||
wxOS_MAC = wxOS_MAC_OS|wxOS_MAC_OSX_DARWIN,
|
||||
|
||||
wxOS_WINDOWS_9X = 1 << 2, //!< Windows 9x family (95/98/ME)
|
||||
wxOS_WINDOWS_NT = 1 << 3, //!< Windows NT family (XP/Vista/7/8/10)
|
||||
wxOS_WINDOWS_MICRO = 1 << 4, //!< MicroWindows
|
||||
wxOS_WINDOWS_CE = 1 << 5, //!< Windows CE (Windows Mobile)
|
||||
|
||||
//! A combination of all @c wxOS_WINDOWS_* values previously listed.
|
||||
wxOS_WINDOWS = wxOS_WINDOWS_9X |
|
||||
wxOS_WINDOWS_NT |
|
||||
wxOS_WINDOWS_MICRO |
|
||||
wxOS_WINDOWS_CE,
|
||||
//! Any Windows system, currently can be only wxOS_WINDOWS_NT.
|
||||
wxOS_WINDOWS = wxOS_WINDOWS_NT,
|
||||
|
||||
wxOS_UNIX_LINUX = 1 << 6, //!< Linux
|
||||
wxOS_UNIX_FREEBSD = 1 << 7, //!< FreeBSD
|
||||
@@ -54,10 +48,7 @@ enum wxOperatingSystemId
|
||||
wxOS_UNIX_NETBSD |
|
||||
wxOS_UNIX_SOLARIS |
|
||||
wxOS_UNIX_AIX |
|
||||
wxOS_UNIX_HPUX,
|
||||
|
||||
wxOS_DOS = 1 << 15, //!< Microsoft DOS
|
||||
wxOS_OS2 = 1 << 16 //!< OS/2
|
||||
wxOS_UNIX_HPUX
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -73,13 +64,12 @@ enum wxPortId
|
||||
|
||||
wxPORT_MSW = 1 << 1, //!< wxMSW, native toolkit is Windows API
|
||||
wxPORT_MOTIF = 1 << 2, //!< wxMotif, using [Open]Motif or Lesstif
|
||||
wxPORT_GTK = 1 << 3, //!< wxGTK, using GTK+ 1.x, 2.x, GPE or Maemo
|
||||
wxPORT_GTK = 1 << 3, //!< wxGTK, using GTK+ 1.x, 2.x, 3.x, GPE
|
||||
wxPORT_DFB = 1 << 4, //!< wxDFB, using wxUniversal
|
||||
wxPORT_X11 = 1 << 5, //!< wxX11, using wxUniversal
|
||||
wxPORT_OS2 = 1 << 6, //!< wxOS2, using OS/2 Presentation Manager
|
||||
wxPORT_MAC = 1 << 7, //!< wxMac, using Carbon or Classic Mac API
|
||||
wxPORT_COCOA = 1 << 8, //!< wxCocoa, using Cocoa NextStep/Mac API
|
||||
wxPORT_WINCE = 1 << 9 //!< wxWinCE, toolkit is WinCE SDK API
|
||||
wxPORT_QT = 1 << 10 //!< wxQT, using QT4
|
||||
};
|
||||
|
||||
|
||||
@@ -285,8 +275,8 @@ public:
|
||||
|
||||
/**
|
||||
Returns the operating system family name for the given wxOperatingSystemId
|
||||
enumeration value: @c Unix for @c wxOS_UNIX, @c Macintosh for @c wxOS_MAC,
|
||||
@c Windows for @c wxOS_WINDOWS, @c DOS for @c wxOS_DOS, @c OS/2 for @c wxOS_OS2.
|
||||
enumeration value: @c Unix for @c wxOS_UNIX, @c OSX for @c wxOS_MAC_OS,
|
||||
@c Windows for @c wxOS_WINDOWS.
|
||||
*/
|
||||
static wxString GetOperatingSystemFamilyName(wxOperatingSystemId os);
|
||||
|
||||
|
@@ -960,11 +960,10 @@ public:
|
||||
@style{wxTE_READONLY}
|
||||
The text will not be user-editable.
|
||||
@style{wxTE_RICH}
|
||||
Use rich text control under Win32, this allows to have more than
|
||||
64KB of text in the control even under Win9x. This style is ignored
|
||||
under other platforms.
|
||||
Use rich text control under MSW, this allows to have more than 64KB
|
||||
of text in the control. This style is ignored under other platforms.
|
||||
@style{wxTE_RICH2}
|
||||
Use rich text control version 2.0 or 3.0 under Win32, this style is
|
||||
Use rich text control version 2.0 or higher under MSW, this style is
|
||||
ignored under other platforms
|
||||
@style{wxTE_AUTO_URL}
|
||||
Highlight the URLs and generate the wxTextUrlEvents when mouse
|
||||
|
@@ -1034,19 +1034,6 @@ public:
|
||||
something with the thread (e.g. pass its ID to an external library)
|
||||
before it starts.
|
||||
|
||||
@warning
|
||||
It is a good idea to explicitly specify a value as systems'
|
||||
default values vary from just a couple of KB on some systems (BSD and
|
||||
OS/2 systems) to one or several MB (Windows, Solaris, Linux).
|
||||
So, if you have a thread that requires more than just a few KB of memory, you
|
||||
will have mysterious problems on some platforms but not on the common ones.
|
||||
On the other hand, just indicating a large stack size by default will give you
|
||||
performance issues on those systems with small default stack since those
|
||||
typically use fully committed memory for the stack.
|
||||
On the contrary, if you use a lot of threads (say several hundred),
|
||||
virtual address space can get tight unless you explicitly specify a
|
||||
smaller amount of thread stack space for each thread.
|
||||
|
||||
@return One of:
|
||||
- @b wxTHREAD_NO_ERROR - No error.
|
||||
- @b wxTHREAD_NO_RESOURCE - There were insufficient resources to create the thread.
|
||||
|
@@ -24,9 +24,6 @@ enum
|
||||
wxTB_VERTICAL = wxVERTICAL,
|
||||
wxTB_LEFT = wxTB_VERTICAL,
|
||||
|
||||
/** show 3D buttons (wxToolBarSimple only) */
|
||||
wxTB_3DBUTTONS,
|
||||
|
||||
/** "flat" buttons (Win32/GTK only) */
|
||||
wxTB_FLAT,
|
||||
|
||||
|
@@ -292,8 +292,8 @@ typedef enum
|
||||
cout << 1.23456;
|
||||
@endcode
|
||||
|
||||
The wxTextOutputStream writes text files (or streams) on DOS, Macintosh and
|
||||
Unix in their native formats (concerning the line ending).
|
||||
The wxTextOutputStream writes text files (or streams) on Windows or Unix in
|
||||
their native formats (concerning the line ending).
|
||||
|
||||
@library{wxbase}
|
||||
@category{streams}
|
||||
|
Reference in New Issue
Block a user