From 75b31b23fd0930eb7f002bc6da4fa55064ebc789 Mon Sep 17 00:00:00 2001 From: Stefan Csomor Date: Sun, 24 Feb 2008 17:08:13 +0000 Subject: [PATCH] first round, connecting overviews properly to main page git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52042 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/overviews/thread.h | 6 +++++- docs/doxygen/overviews/tips.h | 2 +- docs/doxygen/overviews/toolbar.h | 2 +- docs/doxygen/overviews/treectrl.h | 2 +- docs/doxygen/overviews/unicode.h | 2 +- docs/doxygen/overviews/unixprinting.h | 2 +- docs/doxygen/overviews/validator.h | 2 +- docs/doxygen/overviews/windowdeletion.h | 2 +- docs/doxygen/overviews/windowids.h | 2 +- docs/doxygen/overviews/windowsizing.h | 2 +- docs/doxygen/overviews/windowstyles.h | 2 +- docs/doxygen/overviews/xrc.h | 2 +- 12 files changed, 16 insertions(+), 12 deletions(-) diff --git a/docs/doxygen/overviews/thread.h b/docs/doxygen/overviews/thread.h index 15fe0a5d18..0796e62932 100644 --- a/docs/doxygen/overviews/thread.h +++ b/docs/doxygen/overviews/thread.h @@ -8,11 +8,12 @@ /*! - @page thread_overview Multithreading overview + @page overview_thread Multithreading overview Classes: #wxThread, #wxMutex, #wxCriticalSection, #wxCondition + wxWidgets provides a complete set of classes encapsulating objects necessary in multithreaded (MT) programs: the #thread class itself and different synchronization objects: #mutexes and @@ -21,6 +22,7 @@ POSIX1.c threads API (a.k.a. pthreads), although several functions have different names and some features inspired by Win32 thread API are there as well. + These classes will hopefully make writing MT programs easier and they also provide some extra error checking (compared to the native (be it Win32 or Posix) thread API), however it is still a non-trivial undertaking especially for large @@ -35,6 +37,7 @@ @ref idleevent_overview or even simply do everything at once but call wxWindow::Update() periodically to update the screen. + If you do decide to use threads in your application, it is strongly recommended that no more than one thread calls GUI functions. The thread sample shows that it @e is possible for many different threads to call GUI functions at once @@ -44,6 +47,7 @@ more robust and will undoubtedly save you countless problems (example: under Win32 a thread can only access GDI objects such as pens, brushes, c created by itself and not by the other threads). + For communication between secondary threads and the main thread, you may use wxEvtHandler::AddPendingEvent or its short version #wxPostEvent. These functions diff --git a/docs/doxygen/overviews/tips.h b/docs/doxygen/overviews/tips.h index 3aaf24d8b0..ac2cf02b9f 100644 --- a/docs/doxygen/overviews/tips.h +++ b/docs/doxygen/overviews/tips.h @@ -8,7 +8,7 @@ /*! - @page tips_overview wxTipProvider overview + @page overview_tips wxTipProvider overview Many "modern" Windows programs have a feature (some would say annoyance) of presenting the user tips at program startup. While this is probably useless to diff --git a/docs/doxygen/overviews/toolbar.h b/docs/doxygen/overviews/toolbar.h index 3948b99366..0598e1c091 100644 --- a/docs/doxygen/overviews/toolbar.h +++ b/docs/doxygen/overviews/toolbar.h @@ -8,7 +8,7 @@ /*! - @page toolbar_overview Toolbar overview + @page overview_toolbar Toolbar overview Classes: #wxToolBar The toolbar family of classes allows an application to use toolbars diff --git a/docs/doxygen/overviews/treectrl.h b/docs/doxygen/overviews/treectrl.h index 7409ec6154..fb192aa963 100644 --- a/docs/doxygen/overviews/treectrl.h +++ b/docs/doxygen/overviews/treectrl.h @@ -8,7 +8,7 @@ /*! - @page treectrl_overview wxTreeCtrl overview + @page overview_treectrl wxTreeCtrl overview Classes: #wxTreeCtrl, #wxImageList The tree control displays its items in a tree like structure. Each item has its diff --git a/docs/doxygen/overviews/unicode.h b/docs/doxygen/overviews/unicode.h index ad8af01ec1..fb944794d8 100644 --- a/docs/doxygen/overviews/unicode.h +++ b/docs/doxygen/overviews/unicode.h @@ -8,7 +8,7 @@ /*! - @page unicode_overview Unicode support in wxWidgets + @page overview_unicode Unicode support in wxWidgets This section briefly describes the state of the Unicode support in wxWidgets. Read it if you want to know more about how to write programs able to work with diff --git a/docs/doxygen/overviews/unixprinting.h b/docs/doxygen/overviews/unixprinting.h index d4c429d0b0..c520e0b73b 100644 --- a/docs/doxygen/overviews/unixprinting.h +++ b/docs/doxygen/overviews/unixprinting.h @@ -8,7 +8,7 @@ /*! - @page unixprinting_overview Printing under Unix (GTK+) + @page overview_unixprinting Printing under Unix (GTK+) Printing under Unix has always been a cause of problems as Unix does not provide a standard way to display text and graphics diff --git a/docs/doxygen/overviews/validator.h b/docs/doxygen/overviews/validator.h index 73381692b7..e7e13e1650 100644 --- a/docs/doxygen/overviews/validator.h +++ b/docs/doxygen/overviews/validator.h @@ -8,7 +8,7 @@ /*! - @page validator_overview wxValidator overview + @page overview_validator wxValidator overview Classes: #wxValidator, #wxTextValidator, #wxGenericValidator diff --git a/docs/doxygen/overviews/windowdeletion.h b/docs/doxygen/overviews/windowdeletion.h index 9ab084fa97..72603ca5bf 100644 --- a/docs/doxygen/overviews/windowdeletion.h +++ b/docs/doxygen/overviews/windowdeletion.h @@ -8,7 +8,7 @@ /*! - @page windowdeletion_overview Window deletion overview + @page overview_windowdeletion Window deletion overview Classes: #wxCloseEvent, #wxWindow Window deletion can be a confusing subject, so this overview is provided diff --git a/docs/doxygen/overviews/windowids.h b/docs/doxygen/overviews/windowids.h index 2e0c735b5a..ae71d5d173 100644 --- a/docs/doxygen/overviews/windowids.h +++ b/docs/doxygen/overviews/windowids.h @@ -8,7 +8,7 @@ /*! - @page windowids_overview Window IDs overview + @page overview_windowids Window IDs overview @b See Also #wxIdManager diff --git a/docs/doxygen/overviews/windowsizing.h b/docs/doxygen/overviews/windowsizing.h index ed666cb0f1..c3840435e2 100644 --- a/docs/doxygen/overviews/windowsizing.h +++ b/docs/doxygen/overviews/windowsizing.h @@ -8,7 +8,7 @@ /*! - @page windowsizing_overview Window Sizing Overview + @page overview_windowsizing Window Sizing Overview It can sometimes be confusing to keep track of the various size-related attributes of a #wxWindow, how they diff --git a/docs/doxygen/overviews/windowstyles.h b/docs/doxygen/overviews/windowstyles.h index 3260c521ee..4eb99a7e8b 100644 --- a/docs/doxygen/overviews/windowstyles.h +++ b/docs/doxygen/overviews/windowstyles.h @@ -8,7 +8,7 @@ /*! - @page windowstyles_overview Window styles + @page overview_windowstyles Window styles Window styles are used to specify alternative behaviour and appearances for windows, when they are created. The symbols are defined in such a way that they can be combined in a 'bit-list' using the diff --git a/docs/doxygen/overviews/xrc.h b/docs/doxygen/overviews/xrc.h index 2cfddd9936..0c3e288739 100644 --- a/docs/doxygen/overviews/xrc.h +++ b/docs/doxygen/overviews/xrc.h @@ -8,7 +8,7 @@ /*! - @page xrc_overview XML-based resource system overview + @page overview_xrc XML-based resource system overview Classes: #wxXmlResource, #wxXmlResourceHandler The XML-based resource system, known as XRC, allows user interface elements such as -- 2.45.2