Mirrors_UI_SDK/wxWidgets
1
0
Fork 0
mirror of https://github.com/wxWidgets/wxWidgets.git synced 2026-09-28 15:50:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Removed the old, manual entry function, macro, and class category pages and replaced them with the new, finished versions auto-generated by Doxygen.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52800 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-03-25 07:57:30 +00:00
parent cbe733bdec
commit 409e6ce4dc
11 changed files with 23 additions and 1374 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/doxygen/mainpages/cat_classes.h
-816
View File
File diff suppressed because it is too large Load Diff
docs/doxygen/mainpages/cat_functions.h
-367
View File
File diff suppressed because it is too large Load Diff
docs/doxygen/mainpages/cat_macros.h
-165
View File
@@ -1,165 +0,0 @@
/////////////////////////////////////////////////////////////////////////////
// Name: cat_macros.h
// Purpose: Macros-by-category page of the Doxygen manual
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@page page_macro_cat Macros by Category
@li @ref page_macro_cat_version
@li @ref page_macro_cat_byteorder
@li @ref page_macro_cat_rtti
@li @ref page_macro_cat_debugging
@li @ref page_macro_cat_misc
<hr>
@section page_macro_cat_version Versioning
The following constants are defined in wxWidgets:
@beginDefList
@itemdef{ wxMAJOR_VERSION, The major version of wxWidgets }
@itemdef{ wxMINOR_VERSION, The minor version of wxWidgets }
@itemdef{ wxRELEASE_NUMBER, The release number }
@itemdef{ wxSUBRELEASE_NUMBER, The subrelease number which is 0 for all
official releases }
@endDefList
For example, the values or these constants for wxWidgets 2.8.7
are 2, 8, 7 and 0.
Additionally, wxVERSION_STRING is a user-readable string containing the full
wxWidgets version and wxVERSION_NUMBER is a combination of the three version
numbers above: for 2.1.15, it is 2115 and it is 2200 for wxWidgets 2.2.
The subrelease number is only used for the sources in between official releases
and so normally is not useful.
@header{wx/version.h}
@header{wx/defs.h}
@li wxCHECK_GCC_VERSION()
@li wxCHECK_SUNCC_VERSION()
@li wxCHECK_VERSION()
@li wxCHECK_VERSION_FULL()
@li wxCHECK_VISUALC_VERSION()
@li wxCHECK_W32API_VERSION()
@section page_macro_cat_misc Miscellaneous
@header{FIXME}
@li wxCONCAT()
@li wxDECLARE_APP()
@li wxDYNLIB_FUNCTION()
@li wxDEPRECATED()
@li wxDEPRECATED_BUT_USED_INTERNALLY()
@li wxDEPRECATED_INLINE()
@li wxEXPLICIT()
@li wxON_BLOCK_EXIT()
@li wxON_BLOCK_EXIT_OBJ()
@li wxSTRINGIZE()
@li wxSTRINGIZE_T()
@li wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING()
@li __WXFUNCTION__()
@li wxS()
@li wxT()
@li wxTRANSLATE()
@li _()
@li wxPLURAL()
@li _T()
@li WXTRACE()
@li WXTRACELEVEL()
@section page_macro_cat_byteorder Byte Order
@header{FIXME}
The endian-ness issues (that is the difference between big-endian and
little-endian architectures) are important for the portable programs working
with the external binary data (for example, data files or data coming from
network) which is usually in some fixed, platform-independent format.
The macros are helpful for transforming the data to the correct format.
@li wxINTXX_SWAP_ALWAYS()
@li wxINTXX_SWAP_ON_BE()
@li wxINTXX_SWAP_ON_LE()
@li wxFORCE_LINK_THIS_MODULE()
@li wxFORCE_LINK_MODULE()
@li wxIMPLEMENT_APP()
@section page_macro_cat_rtti Runtime Type Information (RTTI)
wxWidgets uses its own RTTI ("run-time type identification") system which
predates the current standard C++ RTTI and so is kept for backwards
compatibility reasons but also because it allows some things which the standard
RTTI doesn't directly support (such as creating a class from its name). The
standard C++ RTTI can be used in the user code without any problems and in
general you shouldn't need to use the functions and the macros in this section
unless you are thinking of modifying or adding any wxWidgets classes.
Related Overviews: @ref overview_rtti
@li CLASSINFO()
@li DECLARE_ABSTRACT_CLASS()
@li DECLARE_APP()
@li DECLARE_CLASS()
@li DECLARE_DYNAMIC_CLASS()
@li IMPLEMENT_ABSTRACT_CLASS()
@li IMPLEMENT_ABSTRACT_CLASS2()
@li IMPLEMENT_APP()
@li IMPLEMENT_CLASS()
@li IMPLEMENT_CLASS2()
@li IMPLEMENT_DYNAMIC_CLASS()
@li IMPLEMENT_DYNAMIC_CLASS2()
@li wxConstCast()
@li wxCreateDynamicObject()
@li WXDEBUG_NEW()
@li wxDynamicCast()
@li wxDynamicCastThis()
@li wxStaticCast()
@li wx_const_cast()
@li wx_reinterpret_cast()
@li wx_static_cast()
@li wx_truncate_cast()
@section page_macro_cat_debugging Debugging
Useful macros and functions for error checking and defensive programming.
wxWidgets defines three families of the assert-like macros: the wxASSERT and
wxFAIL macros only do anything if __WXDEBUG__ is defined (in other words, in
the debug build) but disappear completely in the release build. On the other
hand, the wxCHECK macros stay event in release builds but a check failure
doesn't generate any user-visible effects then. Finally, the compile time
assertions don't happen during the run-time but result in the compilation error
messages if the condition they check fail.
@header{wx/debug.h}
@li wxASSERT()
@li wxASSERT_MIN_BITSIZE()
@li wxASSERT_MSG()
@li wxCOMPILE_TIME_ASSERT()
@li wxCOMPILE_TIME_ASSERT2()
@li wxFAIL()
@li wxFAIL_MSG()
@li wxCHECK()
@li wxCHECK_MSG()
@li wxCHECK_RET()
@li wxCHECK2()
@li wxCHECK2_MSG()
*/
docs/doxygen/mainpages/devtips.h
+2 -2
View File
@@ -203,7 +203,7 @@ which is either wxBIG_ENDIAN or wxLITTLE_ENDIAN (in the future maybe wxPDP_ENDIA
as well).
The macros handling bit-swapping with respect to the applications endianness
are described in the @ref page_macro_cat_byteorder section.
are described in the @ref group_funcmacro_byteorder section.
@@ -305,7 +305,7 @@ from these differences.
Of course, there are also 3rd party utilities such as @c dos2unix and @c unix2dos
which do the EOL conversions.
See also the @ref page_func_cat_file section of the reference
See also the @ref group_funcmacro_file section of the reference
manual for the description of miscellaneous file handling functions.
*/
docs/doxygen/mainpages/manual.h
+2 -3
View File
@@ -24,9 +24,8 @@
@li @subpage page_strategies
@li @subpage page_libs
@li @subpage page_constants
@li @subpage page_class_cat
@li @subpage page_func_cat
@li @subpage page_macro_cat
@li @subpage group_class
@li @subpage group_funcmacro
@li @subpage page_topics
@li @subpage page_port
docs/doxygen/mainpages/strategies.h
+2 -2
View File
@@ -102,7 +102,7 @@ trivial programs.
@subsection page_strategies_debug_uselogging Use logging functions
There is a variety of logging functions that you can use in your program:
see @ref page_func_cat_log.
see @ref group_funcmacro_log.
Using tracing statements may be more convenient than using the debugger
in some circumstances (such as when your debugger doesn't support a lot
@@ -116,7 +116,7 @@ automatically check for memory leaks at the end of the program if wxWidgets is s
configured. Depending on the operating system and compiler, more or less
specific information about the problem will be logged.
You should also use @ref page_macro_cat_debugging as part of a `defensive programming' strategy,
You should also use @ref group_funcmacro_debugging as part of a `defensive programming' strategy,
scattering wxASSERTs liberally to test for problems in your code as early as possible.
Forward thinking will save a surprising amount of time in the long run.
docs/doxygen/overviews/debugging.h
+2 -2
View File
@@ -11,7 +11,7 @@
@page overview_debugging Debugging
Classes, functions and macros: wxDebugContext, wxObject, wxLog,
@ref page_func_cat_log, @ref page_macro_cat_debugging
@ref group_funcmacro_log, @ref group_funcmacro_debugging
Various classes, functions and macros are provided in wxWidgets to help you debug
your application. Most of these are only available if you compile both wxWidgets,
@@ -73,7 +73,7 @@ compilers allow this definition to work properly, but most do.
@section overview_debugging_dbgmacros Debug macros
You should also use @ref page_macro_cat_debugging as part of a 'defensive programming'
You should also use @ref group_funcmacro_debugging as part of a 'defensive programming'
strategy, scattering wxASSERTs liberally to test for problems in your code as early as
possible.
Forward thinking will save a surprising amount of time in the long run.
docs/doxygen/overviews/dialog.h
+1 -1
View File
@@ -22,7 +22,7 @@ be used for placing controls, with the following exceptions:
until the dialog box is dismissed.
For a set of dialog convenience functions, including file selection, see
@ref page_func_cat_dialog.
@ref group_funcmacro_dialog.
See also wxTopLevelWindow and wxWindow for inherited
member functions. Validation of data in controls is covered in @ref overview_validator.
docs/doxygen/overviews/eventhandling.h
+10 -12
View File
@@ -99,7 +99,7 @@ connect the events to the handlers dynamically, during run-time. See the
@section overview_eventhandling_processing How events are processed
@section overview_eventhandling_processing How Events are Processed
When an event is received from the windowing system, wxWidgets calls
wxEvtHandler::ProcessEvent on the first
@@ -228,7 +228,7 @@ will have to be written that will override ProcessEvent() in order to pass
all events (or any selection of them) to the parent window.
@section overview_eventhandling_prog Events generated by the user vs programmatically generated events
@section overview_eventhandling_prog User Generated Events vs Programmatically Generated Events
While generically wxEvents can be generated both by user
actions (e.g. resize of a wxWindow) and by calls to functions
@@ -251,7 +251,7 @@ equivalents.
@section overview_eventhandling_pluggable Pluggable event handlers
@section overview_eventhandling_pluggable Pluggable Event Handlers
In fact, you don't have to derive a new class from a window class
if you don't want to. You can derive a new class from wxEvtHandler instead,
@@ -283,7 +283,7 @@ range of events independently from the other handlers.
@section overview_eventhandling_winid Window identifiers
@section overview_eventhandling_winid Window Identifiers
Window identifiers are integers, and are used to
uniquely determine window identity in the event system (though you can use it
@@ -311,7 +311,7 @@ If you use wxNewId() consistently in your application, you can be sure that
the your identifiers don't conflict accidentally.
@section overview_eventhandling_custom Custom event summary
@section overview_eventhandling_custom Custom Event Summary
@subsection overview_eventhandling_custom_general General approach
@@ -346,7 +346,7 @@ See also the @ref page_samples_event for an example of code
defining and working with the custom event types.
@subsection overview_eventhandling_custom_existing Using existing event classes
@subsection overview_eventhandling_custom_existing Using Existing Event Classes
If you just want to use a wxCommandEvent with
a new event type, you can then use one of the generic event table macros
@@ -388,7 +388,7 @@ void MyWindow::SendEvent()
@endcode
@subsection overview_eventhandling_custom_generic Generic event table macros
@subsection overview_eventhandling_custom_generic Generic Event Table Macros
@beginTable
@row2col{EVT_CUSTOM(event\, id\, func),
@@ -412,7 +412,7 @@ void MyWindow::SendEvent()
@endTable
@subsection overview_eventhandling_custom_ownclass Defining your own event class
@subsection overview_eventhandling_custom_ownclass Defining Your Own Event Class
Under certain circumstances, it will be required to define your own event
class e.g. for sending more complex data from one place to another. Apart
@@ -480,12 +480,10 @@ void MyWindow::SendEvent()
@endcode
@section overview_eventhandling_macros Event macros summary
@section overview_eventhandling_macros Event Handling Summary
For the full list of event classes, please see the
@ref page_class_cat_events page.
@ref group_class_events "event classes group page".
*/
docs/doxygen/overviews/file.h
+1 -1
View File
@@ -12,7 +12,7 @@
Classes: wxFile, wxDir, wxTempFile, wxTextFile
Functions: see @ref page_func_cat_file.
Functions: see @ref group_funcmacro_file.
wxWidgets provides some functions and classes to facilitate working with files.
As usual, the accent is put on cross-platform features which explains, for
docs/doxygen/overviews/roughguide.h
+3 -3
View File
@@ -50,13 +50,13 @@ you need wxHelp and the wxHelpController class to control wxHelp.
GUI applications aren't all graphical wizardry. List and hash table needs are
catered for by wxList and wxHashMap. You will undoubtedly need some
platform-independent @ref page_func_cat_file, and you may find it handy to
platform-independent @ref group_funcmacro_file, and you may find it handy to
maintain and search a list of paths using wxPathList. There's many
@ref page_func_cat_misc of operating system methods and other functions.
@ref group_funcmacro_misc of operating system methods and other functions.
@see
@li @ref page_class_cat
@li @ref group_class
*/