From: Francesco Montorsi Date: Tue, 19 Feb 2008 13:02:03 +0000 (+0000) Subject: adjusted topic links X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/8aa7f32da24c5e9de428d04bb659c80222b14947 adjusted topic links git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51909 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/categories.h b/docs/doxygen/categories.h index ce01161624..f0575d49c5 100644 --- a/docs/doxygen/categories.h +++ b/docs/doxygen/categories.h @@ -73,7 +73,7 @@ @li wxTipWindow: Shows text in a small window @li wxWizard: A wizard dialog - See also the \helpref{Common dialogs overview}{commondialogsoverview}. + See also the @ref commondialogs_overview. @section cat_miscwnd Miscellaneous windows @@ -99,7 +99,7 @@ @section cat_cmndlg Common dialogs - @ref commondialogsoverview + @ref commondialogs_overview Common dialogs are ready-made dialog classes which are frequently used in an application. @@ -151,7 +151,7 @@ @li wxStaticBox: A static, or group box for visually grouping related controls @li wxListBox: A list of strings for single or multiple selection @li wxListCtrl: A control for displaying lists of strings and/or icons, plus a multicolumn report view - @li wxListView: A simpler interface ({\it fa\c{c}ade}) for wxListCtrl in report mode + @li wxListView: A simpler interface (fa&?cedil;ade) for wxListCtrl in report mode @li wxOwnerDrawnComboBox: A combobox with owner-drawn list items @li wxRichTextCtrl: Generic rich text editing control @li wxTextCtrl: Single or multiline text editing control @@ -188,12 +188,13 @@ @li wxMenuItem: Represents a single menu item + @section cat_wxaui wxAUI - advanced user interface This is a new set of classes for writing a customizable application interface with built-in docking, floatable panes and a flexible MDI-like interface. Further classes for custom notebooks with - draggable tabs etc. are in progress. See also \helpref{wxAUI overview}{wxauioverview}. + draggable tabs etc. are in progress. See also @ref wxaui_overview. @li wxAuiManager: The central class for managing the interface @li wxAuiNotebook: A replacement notebook class with extra features @@ -210,7 +211,7 @@ and will in almost all cases produce dialogs looking equally well on all platforms, the other is based on so-called constraints and is deprecated, though still available. - @ref sizeroverview describes sizer-based layout. + @ref sizer_overview describes sizer-based layout. These are the classes relevant to sizer-based layout. @@ -222,7 +223,7 @@ @li wxStaticBoxSizer: Same as wxBoxSizer, but with a surrounding static box @li wxWrapSizer: A sizer which wraps its child controls as size permits - @ref constraintsoverview describes constraints-based layout. + @ref constraints_overview describes constraints-based layout. These are the classes relevant to constraints-based window layout. @@ -236,17 +237,17 @@ @section cat_dc Device contexts - @ref dcoverview + @ref dc_overview Device contexts are surfaces that may be drawn on, and provide an abstraction that allows parameterisation of your drawing code by passing different device contexts. - @li wxAutoBufferedPaintDC: A helper device context for double buffered drawing inside \textbf{OnPaint}. + @li wxAutoBufferedPaintDC: A helper device context for double buffered drawing inside @b OnPaint. @li wxBufferedDC: A helper device context for double buffered drawing. - @li wxBufferedPaintDC: A helper device context for double buffered drawing inside \textbf{OnPaint}. - @li wxClientDC: A device context to access the client area outside {\bf OnPaint} events - @li wxPaintDC: A device context to access the client area inside {\bf OnPaint} events + @li wxBufferedPaintDC: A helper device context for double buffered drawing inside @b OnPaint. + @li wxClientDC: A device context to access the client area outside @b OnPaint events + @li wxPaintDC: A device context to access the client area inside @b OnPaint events @li wxWindowDC: A device context to access the non-client area @li wxScreenDC: A device context to access the entire screen @li wxDC: The device context base class @@ -259,7 +260,7 @@ @section cat_gdi Graphics device interface - @ref wxbitmapoverview + @ref bitmap_overview These classes are related to drawing on device contexts and windows. @@ -284,25 +285,25 @@ @section cat_events Events - @ref eventhandlingoverview + @ref eventhandling_overview An event object contains information about a specific event. Event handlers (usually member functions) have a single, event argument. @li wxActivateEvent: A window or application activation event - @li wxCalendarEvent: Used with \helpref{wxCalendarCtrl}{wxcalendarctrl} + @li wxCalendarEvent: Used with wxCalendarCtrl @li wxCalculateLayoutEvent: Used to calculate window layout @li wxChildFocusEvent: A child window focus event @li wxClipboardTextEvent: A clipboard copy/cut/paste treebook event event @li wxCloseEvent: A close window or end session event @li wxCommandEvent: An event from a variety of standard controls @li wxContextMenuEvent: An event generated when the user issues a context menu command - @li wxDateEvent: Used with \helpref{wxDatePickerCtrl}{wxdatepickerctrl} - @li wxDialUpEvent: Event send by \helpref{wxDialUpManager}{wxdialupmanager} + @li wxDateEvent: Used with wxDatePickerCtrl + @li wxDialUpEvent: Event send by wxDialUpManager @li wxDropFilesEvent: A drop files event @li wxEraseEvent: An erase background event @li wxEvent: The event base class - @li wxFindDialogEvent: Event sent by \helpref{wxFindReplaceDialog}{wxfindreplacedialog} + @li wxFindDialogEvent: Event sent by wxFindReplaceDialog @li wxFocusEvent: A window focus event @li wxKeyEvent: A keypress event @li wxIconizeEvent: An iconize/restore event @@ -327,8 +328,8 @@ @li wxScrollWinEvent: A scroll event from scrolled windows @li wxSizeEvent: A size event @li wxSocketEvent: A socket event - @li wxSpinEvent: An event from \helpref{wxSpinButton}{wxspinbutton} - @li wxSplitterEvent: An event from \helpref{wxSplitterWindow}{wxsplitterwindow} + @li wxSpinEvent: An event from wxSpinButton + @li wxSplitterEvent: An event from wxSplitterWindow @li wxSysColourChangedEvent: A system colour change event @li wxTimerEvent: A timer expiration event @li wxTreebookEvent: A treebook control event @@ -341,7 +342,7 @@ @section cat_val Validators - @ref validatoroverview + @ref validator_overview These are the window validators, used for filtering and validating user input. @@ -376,13 +377,13 @@ @section cat_containers Container classes - @ref wxcontaineroverview + @ref container_overview These are classes, templates and class macros are used by wxWidgets. Most of these classes provide a subset or almost complete STL API. @li wxArray: A type-safe dynamic array implementation (macro based) - @li wxArrayString: An efficient container for storing \helpref{wxString}{wxstring} objects + @li wxArrayString: An efficient container for storing wxString objects @li wxHashMap: A type-safe hash map implementation (macro based) @li wxHashSet: A type-safe hash set implementation(macro based) @li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap) @@ -402,7 +403,7 @@ @section cat_rtti Run-time class information system - @ref runtimeclassoverview + @ref runtimeclass_overview wxWidgets supports run-time manipulation of class information, and dynamic creation of objects given class names. @@ -414,29 +415,28 @@ @section cat_logging Logging features - @ref wxlogoverview + @ref log_overview wxWidgets provides several classes and functions for message logging. - Please see the \helpref{wxLog overview}{wxlogoverview} for more details. + Please see the @ref log_overview for more details. @li wxLog: The base log class @li wxLogStderr: Log messages to a C STDIO stream @li wxLogStream: Log messages to a C++ iostream - @li wxLogTextCtrl: Log messages to a \helpref{wxTextCtrl}{wxtextctrl} + @li wxLogTextCtrl: Log messages to a wxTextCtrl @li wxLogWindow: Log messages to a log frame @li wxLogGui: Default log target for GUI programs @li wxLogNull: Temporarily suppress message logging @li wxLogChain: Allows to chain two log targets @li wxLogInterposer: Allows to filter the log messages @li wxLogInterposerTemp: Allows to filter the log messages - \twocolitem{\helpref{wxStreamToTextRedirector}{wxstreamtotextredirector}}{Allows - to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}} + @li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl @li Log functions: Error and warning logging functions @section cat_debugging Debugging features - @ref debuggingoverview + @ref debugging_overview wxWidgets supports some aspects of debugging an application through classes, functions and macros. @@ -470,7 +470,7 @@ @section cat_ipc Interprocess communication - @ref ipcoverview + @ref ipc_overview wxWidgets provides simple interprocess communications facilities based on Windows DDE, but available on most platforms using TCP. @@ -483,7 +483,7 @@ @section cat_dvf Document-view framework - @ref docviewoverview + @ref docview_overview wxWidgets supports a document/view framework which provides housekeeping for a document-centric application. @@ -500,7 +500,7 @@ @section cat_printing Printing framework - @ref printingoverview + @ref printing_overview A printing and previewing framework is implemented to make it relatively straightforward to provide document printing @@ -523,7 +523,7 @@ @section cat_dd Drag and drop and clipboard classes - @ref wxdndoverview + @ref dnd_overview @li wxDataObject: Data object class @li wxDataFormat: Represents a data format @@ -593,7 +593,7 @@ @section cat_threading Threading classes - @ref wxthreadoverview + @ref thread_overview wxWidgets provides a set of classes to make use of the native thread capabilities of the various platforms. @@ -676,7 +676,7 @@ @section cat_xrc XML-based resource system classes - @ref xrcoverview XML-based resource system (XRC) overview + @ref xrc_overview Resources allow your application to create controls and other user interface elements from specifications stored in an XML format. @@ -729,7 +729,7 @@ @li wxAutomationObject: OLE automation class @li wxFontMapper: Font mapping, finding suitable font for given encoding @li wxEncodingConverter: Encoding conversions - @li wxCalendarDateAttr: Used with \helpref{wxCalendarCtrl}{wxcalendarctrl} + @li wxCalendarDateAttr: Used with wxCalendarCtrl @li wxQuantize: Class to perform quantization, or colour reduction @li wxSingleInstanceChecker: Check that only single program instance is running diff --git a/docs/doxygen/manual.h b/docs/doxygen/manual.h index 83bb364b30..54aa016176 100644 --- a/docs/doxygen/manual.h +++ b/docs/doxygen/manual.h @@ -11,7 +11,7 @@ @mainpage wxWidgets 2.9.0: A portable C++ and Python GUI toolkit @author Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al - @date January, 2008 + @date February, 2008 @image html wx.png diff --git a/docs/doxygen/topics.h b/docs/doxygen/topics.h index 99e6cb2db8..ebf5248925 100644 --- a/docs/doxygen/topics.h +++ b/docs/doxygen/topics.h @@ -12,85 +12,95 @@ @page topic_page Topic overviews This chapter contains a selection of topic overviews. + The following are a basic categorization of them: + @li @ref topics_starting + @li @ref topics_programming + @li @ref topics_nongui + @li @ref topics_drawing + @li @ref topics_gui + @li @ref topics_indivctrl + + +
@section topics_starting Starting with wxWidgets - @li @ref referencenotes Notes on using the reference - @li @ref roughguide Writing a wxWidgets application: a rough guide - @li @ref helloworld wxWidgets Hello World sample - @li @ref samples wxWidgets samples - @li @ref wxpython Introduction to wxPython + @li @ref referencenotes_overview + @li @ref roughguide_overview + @li @ref helloworld_overview + @li @ref samples_overview + @li @ref python_overview @section topics_programming Programming with wxWidgets - @li @ref backwardcompatibility Backward compatibility - @li @ref runtimeclassoverview Runtime class information (RTTI) - @li @ref trefcount Reference counting - @li @ref wxappoverview Application class: wxApp - @li @ref unicode Unicode support in wxWidgets - @li @ref mbconvclasses Conversion between Unicode and multibyte strings - @li @ref internationalization Internationalization - @li @ref nonenglishoverview Writing non-English applications - @li @ref debuggingoverview Debugging overview - @li @ref wxlogoverview Logging overview - @li @ref eventhandlingoverview Event handling overview - @li @ref exceptionsoverview C++ exceptions overview - @li @ref windowstyles Window styles - @li @ref windowdeletionoverview Window deletion overview - @li @ref windowidsoverview Window IDs overview - @li @ref envvars Environment variables + @li @ref backwardcompatibility_overview + @li @ref runtimeclass_overview + @li @ref trefcount_overview + @li @ref app_overview + @li @ref unicode_overview + @li @ref mbconvclasses_overview + @li @ref internationalization_overview + @li @ref nonenglish_overview + @li @ref debugging_overview + @li @ref log_overview + @li @ref eventhandling_overview + @li @ref exceptions_overview + @li @ref windowstyles_overview + @li @ref windowdeletion_overview + @li @ref windowids_overview + @li @ref envvars_overview @section topics_nongui Overviews of non-GUI classes - @li @ref wxstringoverview String class: wxString - @li @ref bufferclasses Buffer classes - @li @ref wxdatetimeoverview Date and time classes - @li @ref wxcontaineroverview Container classes - @li @ref wxfileoverview File classes and functions - @li @ref wxstreamoverview Stream classes - @li @ref wxthreadoverview Multi-threaded applications - @li @ref wxconfigoverview Working with program options: wxConfig - @li @ref fs Virtual file system: wxFileSystem - @li @ref wxresyn Syntax of the built-in regular expression library - @li @ref wxarc Archive formats such as zip - @li @ref ipcoverview Interprocess communication + @li @ref string_overview + @li @ref bufferclasses_overview + @li @ref datetime_overview + @li @ref container_overview + @li @ref file_overview + @li @ref stream_overview + @li @ref thread_overview + @li @ref config_overview + @li @ref fs_overview + @li @ref resyn_overview + @li @ref arc_overview + @li @ref ipc_overview @section topics_drawing Drawing related classes - @li @ref dcoverview Device contexts - @li @ref wxbitmapoverview Bitmaps and icons - @li @ref wxfontoverview Fonts - @li @ref wxfontencodingoverview Fonts encodings - @li @ref printingoverview Printing - @li @ref unixprinting Printing under GTK+ + @li @ref dc_overview + @li @ref bitmap_overview + @li @ref font_overview + @li @ref fontencoding_overview + @li @ref printing_overview + @li @ref unixprinting_overview @section topics_gui Overviews of GUI classes - @li @ref sizeroverview Laying out window elements with sizers - @li @ref xrcoverview XML-based resource system - @li @ref windowsizingoverview Window sizing - @li @ref scrollingoverview Scrolling - @li @ref wxdialogoverview Dialogs - @li @ref validatoroverview Transferring and validating data - @li @ref wxdataobjectoverview Data exchange: wxDataObject - @li @ref wxdndoverview Drag and drop - @li @ref constraintsoverview Layout constraints + @li @ref sizer_overview + @li @ref xrc_overview + @li @ref windowsizing_overview + @li @ref scrolling_overview + @li @ref dialog_overview + @li @ref validator_overview + @li @ref dataobject_overview + @li @ref dnd_overview + @li @ref constraints_overview @section topics_indivctrl Overviews of individual controls - @li @ref wxhtml wxHTML - @li @ref wxrichtextctrloverview wxRichTextCtrl - @li @ref wxauioverview wxAUI (advanced user interface) - @li @ref commondialogsoverview Common dialogs - @li @ref wxtoolbaroverview Toolbar - @li @ref gridoverview wxGrid - @li @ref wxtreectrloverview wxTreeCtrl - @li @ref wxlistctrloverview wxListCtrl - @li @ref wxsplitterwindowoverview wxSplitterWindow - @li @ref wximagelistoverview wxImageList - @li @ref wxbookctrloverview wxBookCtrl - @li @ref wxtipprovider wxTipProvider - @li @ref docviewoverview Document/view + @li @ref html_overview + @li @ref richtextctrl_overview + @li @ref aui_overview + @li @ref commondialogs_overview + @li @ref toolbar_overview + @li @ref grid_overview + @li @ref treectrl_overview + @li @ref listctrl_overview + @li @ref splitterwindow_overview + @li @ref imagelist_overview + @li @ref bookctrl_overview + @li @ref tipprovider_overview + @li @ref docview_overview */