Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ensure all topic overviews have an horizontal rule with the list of the sections above

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52257 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-02 15:33:26 +00:00
parent 38b5b4938f
commit 30738aae14
20 changed files with 145 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/doxygen/Doxyfile.all
View File

@@ -19,7 +19,7 @@ GENERATE_XML = YES
GENERATE_LATEX = NO GENERATE_LATEX = NO
GENERATE_RTF = NO GENERATE_RTF = NO
GENERATE_MAN = NO GENERATE_MAN = NO
GENERATE_PERLMOD = NO GENERATE_PERLMOD = YES
GENERATE_AUTOGEN_DEF = NO GENERATE_AUTOGEN_DEF = NO
GENERATE_TAGFILE = GENERATE_TAGFILE =

2
docs/doxygen/Doxyfile.inc
View File

@@ -305,7 +305,7 @@ XML_PROGRAMLISTING = YES
# configuration options related to the Perl module output # configuration options related to the Perl module output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
GENERATE_PERLMOD = NO GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO PERLMOD_LATEX = YES
PERLMOD_PRETTY = YES PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX = PERLMOD_MAKEVAR_PREFIX =

6
docs/doxygen/htmlfooter.inc
View File

@@ -1,12 +1,14 @@
<!-- ******************************************************* --> <!-- ******************************************************* -->
<!-- Standard wxWidgets footer --> <!-- Standard wxWidgets footer -->
<br><hr> <!-- NOTE: <br/> must go inside <p> but <hr/> must go outside -->
<p><br/></p><hr/>
<table width="100%" border="0"> <table width="100%" border="0">
<tr> <tr>
<td align="left"> <td align="left">
<a href="http://www.wxwidgets.org" style="margin-left: 0px"> <a href="http://www.wxwidgets.org" style="margin-left: 0px">
<img src="powered-by-wxwidgets.png" alt="wxWidgets logo"> <img src="powered-by-wxwidgets.png" alt="wxWidgets logo"/>
</a> </a>
</td> </td>
<td valign="middle" align="center"><p class="footer">Page generated <tt>$datetime</tt> by <a href="http://www.doxygen.org">Doxygen</a> $doxygenversion</p></td> <td valign="middle" align="center"><p class="footer">Page generated <tt>$datetime</tt> by <a href="http://www.doxygen.org">Doxygen</a> $doxygenversion</p></td>

16
docs/doxygen/htmlheader.inc
View File

@@ -1,17 +1,17 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<!-- ****************************************************** --> <!-- ****************************************************** -->
<!-- Standard wxWidgets header --> <!-- Standard wxWidgets header -->
<html> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head> <head>
<meta http-equiv="content-type" content="text/html; charset=utf-8"> <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<title>$title</title> <title>$title</title>
<meta name="author" content="wxWidgets team"> <meta name="author" content="wxWidgets team"/>
<meta name="created" content="$datetime"> <meta name="created" content="$datetime"/>
<meta name="keywords" content="wxWidgets"> <meta name="keywords" content="wxWidgets"/>
<link href="wxwidgets.css" rel="stylesheet" type="text/css"> <link href="wxwidgets.css" rel="stylesheet" type="text/css"/>
<link href="tabs.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"/>
</head> </head>
<body> <body>

4
docs/doxygen/overviews/app.h
View File

@@ -12,13 +12,15 @@
Classes: wxApp Classes: wxApp
@li @ref overview_app_intro
@li @ref overview_app_shutdown @li @ref overview_app_shutdown
<hr> <hr>
@section overview_app_intro Introduction
A wxWidgets application does not have a @e main procedure; the equivalent is the A wxWidgets application does not have a @e main procedure; the equivalent is the
wxApp::OnInit member defined for a class derived from wxApp. wxApp::OnInit member defined for a class derived from wxApp.

6
docs/doxygen/overviews/bookctrl.h
View File

@@ -12,6 +12,12 @@
Classes: wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook Classes: wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook
@li @ref overview_bookctrl_intro
@li @ref overview_bookctrl_bestbookctrl
<hr>
@section overview_bookctrl_intro Introduction @section overview_bookctrl_intro Introduction

7
docs/doxygen/overviews/debugging.h
View File

@@ -19,6 +19,13 @@
defined. You can also test the __WXDEBUG__ symbol in your own applications to execute defined. You can also test the __WXDEBUG__ symbol in your own applications to execute
code that should be active only in debug mode. code that should be active only in debug mode.
@li @ref overview_debugging_dbgctx
@li @ref overview_debugging_dbgmacros
@li @ref overview_debugging_logging
@li @ref overview_debugging_dbgctx2
<hr>
@section overview_debugging_dbgctx wxDebugContext @section overview_debugging_dbgctx wxDebugContext

6
docs/doxygen/overviews/dialog.h
View File

@@ -28,6 +28,12 @@
member functions. Validation of data in controls is covered in @ref overview_validator. member functions. Validation of data in controls is covered in @ref overview_validator.
@li @ref overview_dialog_autoscrolling
<hr>
@section overview_dialog_autoscrolling Automatic scrolling dialogs @section overview_dialog_autoscrolling Automatic scrolling dialogs

12
docs/doxygen/overviews/font.h
View File

@@ -12,6 +12,14 @@
Class: wxFont, wxFontDialog Class: wxFont, wxFontDialog
@li @ref overview_font_intro
@li @ref overview_font_nativeinfo
<hr>
@section overview_font_intro Introduction
A font is an object which determines the appearance of text, primarily A font is an object which determines the appearance of text, primarily
when drawing text to a window or device context. A font is determined by when drawing text to a window or device context. A font is determined by
the following parameters (not all of them have to be specified, of course): the following parameters (not all of them have to be specified, of course):
@@ -53,10 +61,6 @@
current mapping mode. However, user scaling on a device context will also current mapping mode. However, user scaling on a device context will also
scale fonts under both environments. scale fonts under both environments.
@li @ref overview_font_nativeinfo
<hr>
@section overview_font_nativeinfo Native font information @section overview_font_nativeinfo Native font information

12
docs/doxygen/overviews/imagelist.h
View File

@@ -1,5 +1,5 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
// Name: imagelist // Name: imagelist.h
// Purpose: topic overview // Purpose: topic overview
// Author: wxWidgets team // Author: wxWidgets team
// RCS-ID: $Id$ // RCS-ID: $Id$
@@ -10,15 +10,15 @@
@page imagelist_overview wxImageList overview @page imagelist_overview wxImageList overview
Classes: #wxImageList Classes: wxImageList
An image list is a list of images that may have transparent areas. An image list is a list of images that may have transparent areas.
The class helps an application organise a collection of images The class helps an application organise a collection of images
so that they can be referenced by integer index instead of by so that they can be referenced by integer index instead of by
pointer. pointer.
Image lists are used in #wxNotebook,
#wxListCtrl, #wxTreeCtrl and Image lists are used in wxNotebook, wxListCtrl, wxTreeCtrl and
some other control classes. some other control classes.
*/ */

8
docs/doxygen/overviews/internationalization.h
View File

@@ -10,6 +10,14 @@
@page overview_i18n Internationalization @page overview_i18n Internationalization
@li @ref overview_i18n_intro
@li @ref overview_i18n_menuaccel
<hr>
@section overview_i18n_intro Introduction
Although internationalization of an application (i18n for short) involves far Although internationalization of an application (i18n for short) involves far
more than just translating its text messages to another message - date, time more than just translating its text messages to another message - date, time
and currency formats need changing too, some languages are written left to and currency formats need changing too, some languages are written left to

8
docs/doxygen/overviews/ipc.h
View File

@@ -12,6 +12,14 @@
Classes: wxServer, wxConnection, wxClient Classes: wxServer, wxConnection, wxClient
@li @ref overview_ipc_datatransfer
@li @ref overview_ipc_examples
@li @ref overview_ipc_dde
<hr>
wxWidgets has a number of different classes to help with interprocess wxWidgets has a number of different classes to help with interprocess
communication and network programming. This section only discusses one family communication and network programming. This section only discusses one family
of classes -- the DDE-like protocol -- but here's a list of other useful of classes -- the DDE-like protocol -- but here's a list of other useful

11
docs/doxygen/overviews/nonenglish.h
View File

@@ -10,6 +10,17 @@
@page overview_nonenglish Writing Non-English Applications @page overview_nonenglish Writing Non-English Applications
@li @ref overview_nonenglish_locales
@li @ref overview_nonenglish_strings
@li @ref overview_nonenglish_fontmapping
@li @ref overview_nonenglish_converting
@li @ref overview_nonenglish_help
<hr>
This article describes how to write applications that communicate with the user This article describes how to write applications that communicate with the user
in a language other than English. Unfortunately many languages use different in a language other than English. Unfortunately many languages use different
charsets under Unix and Windows (and other platforms, to make the situation charsets under Unix and Windows (and other platforms, to make the situation

16
docs/doxygen/overviews/printing.h
View File

@@ -22,6 +22,22 @@ Classes:
@li wxPageSetupDialog @li wxPageSetupDialog
@li wxPageSetupDialogData @li wxPageSetupDialogData
@li @ref overview_printing_printout
@li @ref overview_printing_printer
@li @ref overview_printing_printpreview
@li @ref overview_printing_printerdc
@li @ref overview_printing_postscriptdc
@li @ref overview_printing_printdialog
@li @ref overview_printing_printdata
@li @ref overview_printing_printdialogdata
@li @ref overview_printing_pagesetupdialog
@li @ref overview_printing_pagesetupdialogdata
<hr>
The printing framework relies on the application to provide classes whose The printing framework relies on the application to provide classes whose
member functions can respond to particular requests, such as 'print this page' member functions can respond to particular requests, such as 'print this page'
or 'does this page exist in the document?'. This method allows wxWidgets to or 'does this page exist in the document?'. This method allows wxWidgets to

6
docs/doxygen/overviews/scrolling.h
View File

@@ -15,6 +15,12 @@ Classes:
@li wxScrolledWindow @li wxScrolledWindow
@li wxScrollBar @li wxScrollBar
@li @ref overview_scrolling_model
@li @ref overview_scrolling_example
<hr>
Scrollbars come in various guises in wxWidgets. All windows have the potential Scrollbars come in various guises in wxWidgets. All windows have the potential
to show a vertical scrollbar and/or a horizontal scrollbar: it is a basic to show a vertical scrollbar and/or a horizontal scrollbar: it is a basic
capability of a window. However, in practice, not all windows do make use of capability of a window. However, in practice, not all windows do make use of

8
docs/doxygen/overviews/splitterwindow.h
View File

@@ -12,6 +12,14 @@
Classes: wxSplitterWindow Classes: wxSplitterWindow
@li @ref overview_splitterwindow_appearance
@li @ref overview_splitterwindow_example
<hr>
@section overview_splitterwindow_appearance Appearance
The following screenshot shows the appearance of a splitter window with a The following screenshot shows the appearance of a splitter window with a
horizontal split. horizontal split.

10
docs/doxygen/overviews/stream.h
View File

@@ -18,6 +18,15 @@ Classes:
@li wxFilterInputStream @li wxFilterInputStream
@li wxFilterOutputStream @li wxFilterOutputStream
@li @ref overview_stream_intro
@li @ref overview_stream_example
<hr>
@section overview_stream_intro Introduction
Standard C++ streams can cause problems on several platforms: they work quite Standard C++ streams can cause problems on several platforms: they work quite
well in most cases, but in the multi-threaded case, for example, they have many well in most cases, but in the multi-threaded case, for example, they have many
problems. Some Borland compilers refuse to work at all with them and using problems. Some Borland compilers refuse to work at all with them and using
@@ -58,6 +67,7 @@ nothing in the case of wxMemoryIn/OutputStream which bases itself on
wxStreamBuffer. This could also be a simple link to the a true syscall (for wxStreamBuffer. This could also be a simple link to the a true syscall (for
example read(...), write(...)). example read(...), write(...)).
@section overview_stream_example Example @section overview_stream_example Example
Usage is simple. We can take the example of wxFileInputStream and here is some Usage is simple. We can take the example of wxFileInputStream and here is some

9
docs/doxygen/overviews/toolbar.h
View File

@@ -12,6 +12,15 @@
Classes: wxToolBar Classes: wxToolBar
@li @ref overview_toolbar_intro
@li @ref overview_toolbar_library
<hr>
@section overview_toolbar_intro Introduction
The toolbar family of classes allows an application to use toolbars in a The toolbar family of classes allows an application to use toolbars in a
variety of configurations and styles. variety of configurations and styles.

8
docs/doxygen/overviews/validator.h
View File

@@ -24,6 +24,14 @@ data transfer, validation and filtering) and wxGenericValidator (which does
data transfer for a range of controls); or you can write your own. data transfer for a range of controls); or you can write your own.
@li @ref overview_validator_example
@li @ref overview_validator_anatomy
@li @ref overview_validator_dialogs
<hr>
@section overview_validator_example Example @section overview_validator_example Example
Here is an example of wxTextValidator usage. Here is an example of wxTextValidator usage.

11
docs/doxygen/overviews/windowdeletion.h
View File

@@ -16,6 +16,17 @@ Window deletion can be a confusing subject, so this overview is provided to
help make it clear when and how you delete windows, or respond to user requests help make it clear when and how you delete windows, or respond to user requests
to close windows. to close windows.
@li @ref overview_windowdeletion_sequence
@li @ref overview_windowdeletion_close
@li @ref overview_windowdeletion_default
@li @ref overview_windowdeletion_menuexit
@li @ref overview_windowdeletion_exitapp
@li @ref overview_windowdeletion_deletion
@li @ref overview_windowdeletion_windowkinds
<hr>
@section overview_windowdeletion_sequence Sequence of Events During Window Deletion @section overview_windowdeletion_sequence Sequence of Events During Window Deletion