EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
-EXAMPLE_PATH =
+EXAMPLE_PATH = ../
EXAMPLE_PATTERNS = *
-EXAMPLE_RECURSIVE = YES
+EXAMPLE_RECURSIVE = NO
IMAGE_PATH = images
INPUT_FILTER =
FILTER_PATTERNS =
/**
-@defgroup group_class Classes by Category
+@defgroup group_class Full Class List by Category
-This group defines all class groups.
+This group contains all full class list groups. The @ref page_class_cat
+provides a quick summary of these groups on one page.
*/
--- /dev/null
+/////////////////////////////////////////////////////////////////////////////
+// Name: cat_classes.h
+// Purpose: Classes-by-category page of the Doxygen manual
+// Author: wxWidgets team
+// RCS-ID: $Id: cat_classes.h 52468 2008-03-13 16:30:38Z FM $
+// Licence: wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+
+@page page_class_cat Summarized Class List by Category
+
+This page contains a summarized listing of classes, please see the
+@ref group_class page for a full listing.
+
+@beginInvisibleTable
+<tr><td>
+@li @ref page_class_cat_managedwnd
+@li @ref page_class_cat_miscwnd
+@li @ref page_class_cat_aui
+@li @ref page_class_cat_winlayout
+@li @ref page_class_cat_cmndlg
+@li @ref page_class_cat_ctrl
+@li @ref page_class_cat_pickers
+@li @ref page_class_cat_menus
+@li @ref page_class_cat_dc
+@li @ref page_class_cat_gdi
+@li @ref page_class_cat_events
+@li @ref page_class_cat_validator
+@li @ref page_class_cat_data
+</td><td>
+@li @ref page_class_cat_containers
+@li @ref page_class_cat_smartpointers
+@li @ref page_class_cat_logging
+@li @ref page_class_cat_debugging
+@li @ref page_class_cat_net
+@li @ref page_class_cat_ipc
+@li @ref page_class_cat_dvf
+@li @ref page_class_cat_printing
+@li @ref page_class_cat_dnd
+@li @ref page_class_cat_file
+@li @ref page_class_cat_vfs
+@li @ref page_class_cat_streams
+</td><td>
+@li @ref page_class_cat_threading
+@li @ref page_class_cat_rtti
+@li @ref page_class_cat_appmanagement
+@li @ref page_class_cat_html
+@li @ref page_class_cat_richtext
+@li @ref page_class_cat_stc
+@li @ref page_class_cat_xml
+@li @ref page_class_cat_xrc
+@li @ref page_class_cat_help
+@li @ref page_class_cat_media
+@li @ref page_class_cat_gl
+@li @ref page_class_cat_archive
+@li @ref page_class_cat_misc
+</td></tr>
+@endTable
+
+
+<hr>
+
+
+@section page_class_cat_managedwnd Managed Windows
+
+There are several types of window that are directly controlled by the window
+manager (such as MS Windows, or the Motif Window Manager). Frames and dialogs
+are similar in wxWidgets, but only dialogs may be modal.
+
+Related Overviews: @ref overview_cmndlg
+
+@li wxTopLevelWindow: Any top level window, dialog or frame
+@li wxDialog: Dialog box
+@li wxFrame: Normal frame
+@li wxMDIChildFrame: MDI child frame
+@li wxMDIParentFrame: MDI parent frame
+@li wxMiniFrame: A frame with a small title bar
+@li wxPropertySheetDialog: Property sheet dialog
+@li wxSplashScreen: Splash screen class
+@li wxTipWindow: Shows text in a small window
+@li wxWizard: A wizard dialog
+
+
+
+@section page_class_cat_miscwnd Miscellaneous Windows
+
+The following are a variety of classes that are derived from wxWindow.
+
+@li wxPanel: A window whose colour changes according to current user settings
+@li wxScrolledWindow: Window with automatically managed scrollbars
+@li wxGrid: A grid (table) window
+@li wxSplitterWindow: Window which can be split vertically or horizontally
+@li wxStatusBar: Implements the status bar on a frame
+@li wxToolBar: Toolbar class
+@li wxNotebook: Notebook class
+@li wxListbook: Similar to notebook but using list control
+@li wxChoicebook: Similar to notebook but using choice control
+@li wxTreebook: Similar to notebook but using tree control
+@li wxSashWindow: Window with four optional sashes that can be dragged
+@li wxSashLayoutWindow: Window that can be involved in an IDE-like layout
+ arrangement
+@li wxVScrolledWindow: As wxScrolledWindow but supports lines of variable
+ height
+@li wxWizardPage: A base class for the page in wizard dialog.
+@li wxWizardPageSimple: A page in wizard dialog.
+
+
+
+@section page_class_cat_aui Window Docking (wxAUI)
+
+wxAUI is a set classes for writing a customizable application interface
+with built-in docking, floatable panes and a flexible MDI-like interface.
+
+Related Overviews: @ref overview_aui
+
+@li wxAuiManager: The central class for managing the interface
+@li wxAuiNotebook: A replacement notebook class with extra features
+@li wxAuiPaneInfo: Describes a single pane
+@li wxAuiDockArt: Art and metrics provider for customizing the docking user
+ interface
+@li wxAuiTabArt: Art and metrics provider for customizing the notebook user
+ interface
+
+
+
+@section page_class_cat_winlayout Window Layout
+
+There are two different systems for laying out windows (and dialogs in
+particular). One is based upon so-called sizers and it requires less typing,
+thinking and calculating 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.
+
+Related Overviews: @ref overview_sizer, @ref overview_constraints
+
+These are the classes relevant to sizer-based layout:
+
+@li wxSizer: Abstract base class
+@li wxGridSizer: A sizer for laying out windows in a grid with all fields
+ having the same size
+@li wxFlexGridSizer: A sizer for laying out windows in a flexible grid
+@li wxGridBagSizer: Another grid sizer that lets you specify the cell an item
+ is in, and items can span rows and/or columns.
+@li wxBoxSizer: A sizer for laying out windows in a row or column
+@li wxStaticBoxSizer: Same as wxBoxSizer, but with a surrounding static box
+@li wxWrapSizer: A sizer which wraps its child controls as size permits
+
+These are the classes relevant to constraints-based window layout:
+
+@li wxIndividualLayoutConstraint: Represents a single constraint dimension
+@li wxLayoutConstraints: Represents the constraints for a window class
+
+Other layout classes:
+
+@li wxLayoutAlgorithm: An alternative window layout facility
+
+
+
+@section page_class_cat_cmndlg Common Dialogs
+
+Common dialogs are ready-made dialog classes which are frequently used in an
+application.
+
+Related Overviews: @ref overview_cmndlg
+
+@li wxDialog: Base class for common dialogs
+@li wxColourDialog: Colour chooser dialog
+@li wxDirDialog: Directory selector dialog
+@li wxFileDialog: File selector dialog
+@li wxFindReplaceDialog: Text search/replace dialog
+@li wxMultiChoiceDialog: Dialog to get one or more selections from a list
+@li wxSingleChoiceDialog: Dialog to get a single selection from a list and
+ return the string
+@li wxTextEntryDialog: Dialog to get a single line of text from the user
+@li wxPasswordEntryDialog: Dialog to get a password from the user
+@li wxFontDialog: Font chooser dialog
+@li wxPageSetupDialog: Standard page setup dialog
+@li wxPrintDialog: Standard print dialog
+@li wxProgressDialog: Progress indication dialog
+@li wxMessageDialog: Simple message box dialog
+@li wxSymbolPickerDialog: Symbol selector dialog
+@li wxRichTextFormattingDialog: A dialog for formatting the content of a
+ wxRichTextCtrl
+@li wxWizard: A wizard dialog.
+
+
+
+@section page_class_cat_ctrl Controls
+
+Typically, these are small windows which provide interaction with the user.
+Controls that are not static can have wxValidator associated with them.
+
+@li wxAnimationCtrl: A control to display an animation
+@li wxControl: The base class for controls
+@li wxButton: Push button control, displaying text
+@li wxBitmapButton: Push button control, displaying a bitmap
+@li wxBitmapComboBox: A combobox with bitmaps next to text items
+@li wxToggleButton: A button which stays pressed when clicked by user.
+@li wxBitmapToggleButton: A toggle button with bitmaps.
+@li wxCalendarCtrl: Control showing an entire calendar month
+@li wxCheckBox: Checkbox control
+@li wxCheckListBox: A listbox with a checkbox to the left of each item
+@li wxChoice: Choice control (a combobox without the editable area)
+@li wxCollapsiblePane: A panel which can be shown/hidden by the user
+@li wxComboBox: A choice with an editable area
+@li wxComboCtrl: A combobox with application defined popup
+@li wxDataViewCtrl: A control to tabular or tree like data
+@li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with wxTreeCtrl-like API
+@li wxGauge: A control to represent a varying quantity, such as time remaining
+@li wxGenericDirCtrl: A control for displaying a directory tree
+@li wxHtmlListBox: An abstract class for creating listboxes showing HTML
+ content
+@li wxSimpleHtmlListBox: A listbox showing HTML content
+@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 (faç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
+@li wxTreeCtrl: Tree (hierarchy) control
+@li wxScrollBar: Scrollbar control
+@li wxSpinButton: A spin or `up-down' control
+@li wxSpinCtrl: A spin control - i.e. spin button and text control
+@li wxStaticText: One or more lines of non-editable text
+@li wxHyperlinkCtrl: A static text which opens an URL when clicked
+@li wxStaticBitmap: A control to display a bitmap
+@li wxRadioBox: A group of radio buttons
+@li wxRadioButton: A round button to be used with others in a mutually
+ exclusive way
+@li wxSlider: A slider that can be dragged by the user
+@li wxVListBox: A listbox supporting variable height rows
+
+
+
+@section page_class_cat_pickers Picker Controls
+
+A picker control is a control whose appearance and behaviour is highly
+platform-dependent.
+
+@li wxColourPickerCtrl: A control which allows the user to choose a colour
+@li wxDirPickerCtrl: A control which allows the user to choose a directory
+@li wxFilePickerCtrl: A control which allows the user to choose a file
+@li wxFontPickerCtrl: A control which allows the user to choose a font
+@li wxDatePickerCtrl: Small date picker control
+
+
+
+@section page_class_cat_menus Menus
+
+@li wxMenu: Displays a series of menu items for selection
+@li wxMenuBar: Contains a series of menus for use with a frame
+@li wxMenuItem: Represents a single menu item
+
+
+
+@section page_class_cat_dc Device Contexts
+
+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.
+
+Related Overviews: @ref overview_dc
+
+@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 @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
+@li wxMemoryDC: A device context for drawing into bitmaps
+@li wxMetafileDC: A device context for drawing into metafiles
+@li wxMirrorDC: A proxy device context allowing for simple mirroring.
+@li wxPostScriptDC: A device context for drawing into PostScript files
+@li wxPrinterDC: A device context for drawing to printers
+
+
+
+@section page_class_cat_gdi Graphics Device Interface
+
+These classes are related to drawing on device contexts and windows.
+
+Related Overviews: @ref overview_bitmap
+
+@li wxColour: Represents the red, blue and green elements of a colour
+@li wxDCClipper: Wraps the operations of setting and destroying the clipping
+ region
+@li wxBitmap: Represents a bitmap
+@li wxBrush: Used for filling areas on a device context
+@li wxBrushList: The list of previously-created brushes
+@li wxCursor: A small, transparent bitmap representing the cursor
+@li wxFont: Represents fonts
+@li wxFontList: The list of previously-created fonts
+@li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
+ device contexts
+@li wxImage: A platform-independent image class
+@li wxImageList: A list of images, used with some controls
+@li wxMask: Represents a mask to be used with a bitmap for transparent drawing
+@li wxPen: Used for drawing lines on a device context
+@li wxPenList: The list of previously-created pens
+@li wxPalette: Represents a table of indices into RGB values
+@li wxRegion: Represents a simple or complex region on a window or device
+ context
+@li wxAnimation: Represents an animation
+@li wxRendererNative: Abstracts high-level drawing primitives
+
+
+
+@section page_class_cat_events Events
+
+An event object contains information about a specific event. Event handlers
+(usually member functions) have a single, event argument.
+
+Related Overviews: @ref overview_eventhandling
+
+@li wxActivateEvent: A window or application activation event
+@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 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 wxFindReplaceDialog
+@li wxFocusEvent: A window focus event
+@li wxKeyEvent: A keypress event
+@li wxIconizeEvent: An iconize/restore event
+@li wxIdleEvent: An idle event
+@li wxInitDialogEvent: A dialog initialisation event
+@li wxJoystickEvent: A joystick event
+@li wxListEvent: A list control event
+@li wxMaximizeEvent: A maximize event
+@li wxMenuEvent: A menu event
+@li wxMouseCaptureChangedEvent: A mouse capture changed event
+@li wxMouseCaptureLostEvent: A mouse capture lost event
+@li wxMouseEvent: A mouse event
+@li wxMoveEvent: A move event
+@li wxNavigationKeyEvent: An event set by navigation keys such as tab
+@li wxNotebookEvent: A notebook control event
+@li wxNotifyEvent: A notification event, which can be vetoed
+@li wxPaintEvent: A paint event
+@li wxProcessEvent: A process ending event
+@li wxQueryLayoutInfoEvent: Used to query layout information
+@li wxRichTextEvent: A rich text editing event
+@li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin
+ buttons
+@li wxScrollWinEvent: A scroll event from scrolled windows
+@li wxSizeEvent: A size event
+@li wxSocketEvent: A socket event
+@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
+@li wxTreeEvent: A tree control event
+@li wxUpdateUIEvent: A user interface update event
+@li wxWindowCreateEvent: A window creation event
+@li wxWindowDestroyEvent: A window destruction event
+@li wxWizardEvent: A wizard event
+
+
+
+@section page_class_cat_validator Validators
+
+These are the window validators, used for filtering and validating user input.
+
+Related Overviews: @ref overview_validator
+
+@li wxValidator: Base validator class
+@li wxTextValidator: Text control validator class
+@li wxGenericValidator: Generic control validator class
+
+
+
+@section page_class_cat_data Data Structures
+
+These are the data structure classes supported by wxWidgets.
+
+@li wxCmdLineParser: Command line parser class
+@li wxDateSpan: A logical time interval.
+@li wxDateTime: A class for date/time manipulations
+@li wxLongLong: A portable 64 bit integer type
+@li wxObject: The root class for most wxWidgets classes
+@li wxPathList: A class to help search multiple paths
+@li wxPoint: Representation of a point
+@li wxRect: A class representing a rectangle
+@li wxRegEx: Regular expression support
+@li wxRegion: A class representing a region
+@li wxString: A string class
+@li wxStringTokenizer: A class for interpreting a string as a list of tokens or
+ words
+@li wxRealPoint: Representation of a point using floating point numbers
+@li wxSize: Representation of a size
+@li wxTimeSpan: A time interval.
+@li wxURI: Represents a Uniform Resource Identifier
+@li wxVariant: A class for storing arbitrary types that may change at run-time
+
+
+
+@section page_class_cat_containers Containers
+
+These are classes, templates and class macros are used by wxWidgets. Most of
+these classes provide a subset or almost complete STL API.
+
+Related Overviews: @ref overview_container
+
+@li wxArray<T>: A type-safe dynamic array implementation (macro based)
+@li wxArrayString: An efficient container for storing wxString objects
+@li wxHashMap<T>: A type-safe hash map implementation (macro based)
+@li wxHashSet<T>: A type-safe hash set implementation(macro based)
+@li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap)
+@li wxList<T>: A type-safe linked list implementation (macro based)
+@li wxVector<T>: Template base vector implementation identical to std::vector
+
+
+
+@section page_class_cat_smartpointers Smart Pointers
+
+wxWidgets provides a few smart pointer class templates.
+
+@li wxObjectDataPtr<T>: A shared pointer (using intrusive reference counting)
+@li wxScopedPtr<T>: A scoped pointer
+@li wxSharedPtr<T>: A shared pointer (using non-intrusive reference counting)
+@li wxWeakRef<T>: A weak reference
+
+
+
+@section page_class_cat_logging Logging
+
+wxWidgets provides several classes and functions for message logging.
+
+Related Overviews: @ref overview_log
+
+@see @ref group_funcmacro_log "Logging Functions and Macros"
+
+@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 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
+@li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl
+
+
+
+@section page_class_cat_debugging Debugging
+
+wxWidgets supports some aspects of debugging an application through classes,
+functions and macros.
+
+Related Overviews: @ref overview_debugging
+
+@see @ref group_funcmacro_debug "Debugging Functions and Macros"
+
+@li wxDebugContext: Provides memory-checking facilities
+@li wxDebugReport: Base class for creating debug reports in case of a program
+ crash.
+@li wxDebugReportCompress: Class for creating compressed debug reports.
+@li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.
+@li wxDebugReportPreview: Abstract base class for previewing the contents of a
+ debug report.
+@li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
+
+
+
+@section page_class_cat_net Networking
+
+wxWidgets provides its own classes for socket based networking.
+
+@li wxDialUpManager: Provides functions to check the status of network
+ connection and to establish one
+@li wxIPV4address: Represents an Internet address
+@li wxIPaddress: Represents an Internet address
+@li wxSocketBase: Represents a socket base object
+@li wxSocketClient: Represents a socket client
+@li wxSocketServer: Represents a socket server
+@li wxSocketEvent: A socket event
+@li wxFTP: FTP protocol class
+@li wxHTTP: HTTP protocol class
+@li wxURL: Represents a Universal Resource Locator
+
+
+
+@section page_class_cat_ipc Interprocess Communication
+
+wxWidgets provides simple interprocess communications facilities based on
+Windows DDE, but available on most platforms using TCP.
+
+Related Overviews: @ref overview_ipc
+
+@li wxClient, wxDDEClient: Represents a client
+@li wxConnection, wxDDEConnection: Represents the connection between a client
+ and a server
+@li wxServer, wxDDEServer: Represents a server
+
+
+
+@section page_class_cat_dvf Document/View Framework
+
+wxWidgets supports a document/view framework which provides housekeeping for a
+document-centric application.
+
+Related Overviews: @ref overview_docview
+
+@li wxCommand: Base class for undo/redo actions
+@li wxCommandProcessor: Maintains the undo/redo stack
+@li wxDocument: Represents a document
+@li wxView: Represents a view
+@li wxDocTemplate: Manages the relationship between a document class and a
+ view class
+@li wxDocManager: Manages the documents and views in an application
+@li wxDocChildFrame: A child frame for showing a document view
+@li wxDocParentFrame: A parent frame to contain views
+@li wxDocMDIChildFrame: An MDI child frame for showing a document view
+@li wxDocMDIParentFrame: An MDI parent frame to contain views
+@li wxFileHistory: Maintains a list of the most recently visited files
+
+
+
+@section page_class_cat_printing Printing Framework
+
+A printing and previewing framework is implemented to make it relatively
+straightforward to provide document printing facilities.
+
+Related Overviews: @ref overview_printing
+
+@li wxPreviewFrame: Frame for displaying a print preview
+@li wxPreviewCanvas: Canvas for displaying a print preview
+@li wxPreviewControlBar: Standard control bar for a print preview
+@li wxPrintDialog: Standard print dialog
+@li wxPageSetupDialog: Standard page setup dialog
+@li wxPrinter: Class representing the printer
+@li wxPrinterDC: Printer device context
+@li wxPrintout: Class representing a particular printout
+@li wxPrintPreview: Class representing a print preview
+@li wxPrintData: Represents information about the document being printed
+@li wxPrintDialogData: Represents information about the print dialog
+@li wxPageSetupDialogData: Represents information about the page setup dialog
+
+
+
+@section page_class_cat_dnd Clipboard and Drag & Drop
+
+Related Overviews: @ref overview_dnd
+
+@li wxDataObject: Data object class
+@li wxDataFormat: Represents a data format
+@li wxTextDataObject: Text data object class
+@li wxFileDataObject: File data object class
+@li wxBitmapDataObject: Bitmap data object class
+@li wxURLDataObject: URL data object class
+@li wxCustomDataObject: Custom data object class
+@li wxClipboard: Clipboard class
+@li wxDropTarget: Drop target class
+@li wxFileDropTarget: File drop target class
+@li wxTextDropTarget: Text drop target class
+@li wxDropSource: Drop source class
+
+
+
+@section page_class_cat_file File Handling
+
+wxWidgets has several small classes to work with disk files and directories.
+
+Related Overviews: @ref overview_file
+
+@li wxFileName: Operations with the file name and attributes
+@li wxDir: Class for enumerating files/subdirectories.
+@li wxDirTraverser: Class used together with wxDir for recursively enumerating
+ the files/subdirectories
+@li wxFile: Low-level file input/output class.
+@li wxFFile: Another low-level file input/output class.
+@li wxTempFile: Class to safely replace an existing file
+@li wxTextFile: Class for working with text files as with arrays of lines
+@li wxStandardPaths: Paths for standard directories
+@li wxPathList: A class to help search multiple paths
+
+
+
+@section page_class_cat_vfs Virtual File System
+
+wxWidgets provides a set of classes that implement an extensible virtual file
+system, used internally by the HTML classes.
+
+@li wxFSFile: Represents a file in the virtual file system
+@li wxFileSystem: Main interface for the virtual file system
+@li wxFileSystemHandler: Class used to announce file system type
+
+
+
+@section page_class_cat_streams Streams
+
+wxWidgets has its own set of stream classes, as an alternative to often buggy
+standard stream libraries, and to provide enhanced functionality.
+
+@li wxStreamBase: Stream base class
+@li wxStreamBuffer: Stream buffer class
+@li wxInputStream: Input stream class
+@li wxOutputStream: Output stream class
+@li wxCountingOutputStream: Stream class for querying what size a stream would
+ have.
+@li wxFilterInputStream: Filtered input stream class
+@li wxFilterOutputStream: Filtered output stream class
+@li wxBufferedInputStream: Buffered input stream class
+@li wxBufferedOutputStream: Buffered output stream class
+@li wxMemoryInputStream: Memory input stream class
+@li wxMemoryOutputStream: Memory output stream class
+@li wxDataInputStream: Platform-independent binary data input stream class
+@li wxDataOutputStream: Platform-independent binary data output stream class
+@li wxTextInputStream: Platform-independent text data input stream class
+@li wxTextOutputStream: Platform-independent text data output stream class
+@li wxFileInputStream: File input stream class
+@li wxFileOutputStream: File output stream class
+@li wxFFileInputStream: Another file input stream class
+@li wxFFileOutputStream: Another file output stream class
+@li wxTempFileOutputStream: Stream to safely replace an existing file
+@li wxStringInputStream: String input stream class
+@li wxStringOutputStream: String output stream class
+@li wxZlibInputStream: Zlib and gzip (compression) input stream class
+@li wxZlibOutputStream: Zlib and gzip (compression) output stream class
+@li wxZipInputStream: Input stream for reading from ZIP archives
+@li wxZipOutputStream: Output stream for writing from ZIP archives
+@li wxTarInputStream: Input stream for reading from tar archives
+@li wxTarOutputStream: Output stream for writing from tar archives
+@li wxSocketInputStream: Socket input stream class
+@li wxSocketOutputStream: Socket output stream class
+
+
+
+@section page_class_cat_threading Threading
+
+wxWidgets provides a set of classes to make use of the native thread
+capabilities of the various platforms.
+
+Related Overviews: @ref overview_thread
+
+@li wxThread: Thread class
+@li wxThreadHelper: Manages background threads easily
+@li wxMutex: Mutex class
+@li wxMutexLocker: Mutex locker utility class
+@li wxCriticalSection: Critical section class
+@li wxCriticalSectionLocker: Critical section locker utility class
+@li wxCondition: Condition class
+@li wxSemaphore: Semaphore class
+
+
+
+@section page_class_cat_rtti Runtime Type Information (RTTI)
+
+wxWidgets supports runtime manipulation of class information, and dynamic
+creation of objects given class names.
+
+Related Overviews: @ref overview_rtti
+
+@see @ref group_funcmacro_rtti "RTTI Functions and Macros"
+
+@li wxClassInfo: Holds runtime class information
+@li wxObject: Root class for classes with runtime information
+
+
+
+@section page_class_cat_appmanagement Application and Process Management
+
+@li wxApp: Application class
+@li wxCmdLineParser: Command line parser class
+@li wxDllLoader: Class to work with shared libraries.
+@li wxProcess: Process class
+
+
+
+@section page_class_cat_html HTML
+
+wxWidgets provides a set of classes to display text in HTML format. These
+classes include a help system based on the HTML widget.
+
+@li wxHtmlHelpController: HTML help controller class
+@li wxHtmlWindow: HTML window class
+@li wxHtmlEasyPrinting: Simple class for printing HTML
+@li wxHtmlPrintout: Generic HTML wxPrintout class
+@li wxHtmlParser: Generic HTML parser class
+@li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser
+@li wxHtmlWinParser: HTML parser class for wxHtmlWindow
+@li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
+
+
+
+@section page_class_cat_richtext Rich Text
+
+wxWidgets provides a set of generic classes to edit and print simple rich text
+with character and paragraph formatting.
+
+@li wxTextAttr: Attributes specifying text styling.
+@li wxRichTextCtrl: A rich text control.
+@li wxRichTextBuffer: The content of a rich text control.
+@li wxRichTextCharacterStyleDefinition: Definition of character styling.
+@li wxRichTextParagraphStyleDefinition: Definition of paragraph styling.
+@li wxRichTextListStyleDefinition: Definition of list styling.
+@li wxRichTextStyleSheet: A set of style definitions.
+@li wxRichTextStyleComboCtrl: A drop-down control for applying styles.
+@li wxRichTextStyleListBox: A listbox for applying styles.
+@li wxRichTextStyleOrganiserDialog: A dialog that can be used for managing or
+ browsing styles.
+@li wxRichTextEvent: A rich text event.
+@li wxRichTextRange: Specification for ranges in a rich text control or buffer.
+@li wxRichTextFileHandler: File handler base class.
+@li wxRichTextHTMLHandler: A handler for converting rich text to HTML.
+@li wxRichTextXMLHandler: A handler for loading and saving rich text XML.
+@li wxRichTextFormattingDialog: A dialog for rich text formatting.
+@li wxRichTextPrinting: A class for easy printing of rich text buffers.
+@li wxRichTextPrintout: A class used by wxRichTextPrinting.
+@li wxRichTextHeaderFooterData: Header and footer data specification.
+
+
+
+@section page_class_cat_stc Scintilla Text Editor
+
+wxWidgets also provides a wrapper around the Scintilla text editor control,
+which is a control for plain-text editing with support for highlighting, smart
+indentation, etc.
+
+@li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
+ editing component.
+
+
+
+@section page_class_cat_xml XML
+
+@li wxXmlDocument: A class to parse XML files
+@li wxXmlNode: A class which represents XML nodes
+@li wxXmlAttribute: A class which represent an XML attribute
+
+
+
+@section page_class_cat_xrc XML Based Resource System (XRC)
+
+Resources allow your application to create controls and other user interface
+elements from specifications stored in an XML format.
+
+Related Overviews: @ref overview_xrc
+
+@li wxXmlResource: The main class for working with resources
+@li wxXmlResourceHandler: The base class for XML resource handlers
+
+
+
+@section page_class_cat_help Help
+
+@li wxHelpController: Family of classes for controlling help windows
+@li wxHtmlHelpController: HTML help controller class
+@li wxContextHelp: Class to put application into context-sensitive help mode
+@li wxContextHelpButton: Button class for putting application into
+ context-sensitive help mode
+@li wxHelpProvider: Abstract class for context-sensitive help provision
+@li wxSimpleHelpProvider: Class for simple context-sensitive help provision
+@li wxHelpControllerHelpProvider: Class for context-sensitive help provision
+ via a help controller
+@li wxToolTip: Class implementing tooltips
+
+
+
+@section page_class_cat_media Multimedia
+
+@li wxMediaCtrl: Display multimedia contents.
+
+
+
+@section page_class_cat_gl OpenGL
+
+@li wxGLCanvas: Canvas that you can render OpenGL calls to.
+@li wxGLContext: Class to ease sharing of OpenGL data resources.
+
+
+
+@section page_class_cat_archive Archive
+
+@li wxArchiveInputStream
+@li wxArchiveOutputStream
+@li wxArchiveEntry
+
+
+
+@section page_class_cat_misc Miscellaneous
+
+@li wxCaret: A caret (cursor) object
+@li wxConfigBase: Classes for reading/writing the configuration settings
+@li wxTimer: Timer class
+@li wxStopWatch: Stop watch class
+@li wxMimeTypesManager: MIME-types manager class
+@li wxSystemSettings: System settings class for obtaining various global
+ parameters
+@li wxSystemOptions: System options class for run-time configuration
+@li wxAcceleratorTable: Accelerator table
+@li wxAutomationObject: OLE automation class
+@li wxFontMapper: Font mapping, finding suitable font for given encoding
+@li wxEncodingConverter: Encoding conversions
+@li wxCalendarDateAttr: Used with wxCalendarCtrl
+@li wxQuantize: Class to perform quantization, or colour reduction
+@li wxSingleInstanceChecker: Check that only single program instance is running
+
+*/
+
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
-
/**
-@page page_copyright Copyright and license
+@page page_copyright Copyrights and Licenses
-<center>
Copyright (c) 1992-2008 Julian Smart, Robert Roebling, Vadim Zeitlin and other
members of the wxWidgets team
Portions (c) 1996 Artificial Intelligence Applications Institute
-</center>
Please also see the wxWindows license files (preamble.txt, lgpl.txt, gpl.txt,
licence.txt, licendoc.txt) for conditions of software and documentation use.
@li @subpage page_copyright_wxlicense
@li @subpage page_copyright_gnulicense
-*/
-
-
-/**
-
-@page page_copyright_wxlicense wxWindows Library License, Version 3.1
-
-<!--
-
-NB: this is exact copy of docs/licence.txt file. DO NOT modify this
- section, it MUST be identical to docs/licence.txt!
-
--->
-
-Copyright (c) 1998-2008 Julian Smart, Robert Roebling et al
-
-Everyone is permitted to copy and distribute verbatim copies
-of this licence document, but changing it is not allowed.
-
-<center>
-WXWINDOWS LIBRARY LICENCE
-
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-</center>
-
-This library is free software; you can redistribute it and/or modify it
-under the terms of the GNU Library General Public Licence as published by
-the Free Software Foundation; either version 2 of the Licence, or (at
-your option) any later version.
-This library is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library
-General Public Licence for more details.
+@page page_copyright_wxlicense wxWindows Library License
-You should have received a copy of the GNU Library General Public Licence
-along with this software, usually in a file named COPYING.LIB. If not,
-write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
-Boston, MA 02111-1307 USA.
+@verbinclude "licence.txt"
-EXCEPTION NOTICE
+@page page_copyright_gnulicense GNU Library General Public License
-1. As a special exception, the copyright holders of this library give
-permission for additional uses of the text contained in this release of
-the library as licenced under the wxWindows Library Licence, applying
-either version 3.1 of the Licence, or (at your option) any later version of
-the Licence as published by the copyright holders of version 3.1 of the
-Licence document.
-
-2. The exception is that you may use, copy, link, modify and distribute
-under your own terms, binary object code versions of works based
-on the Library.
-
-3. If you copy code from files distributed under the terms of the GNU
-General Public Licence or the GNU Library General Public Licence into a
-copy of this library, as this licence permits, the exception does not
-apply to the code that you add in this way. To avoid misleading anyone as
-to the status of such modified files, you must delete this exception
-notice from such code and/or adjust the licensing conditions notice
-accordingly.
-
-4. If you write modifications of your own for this library, it is your
-choice whether to permit this exception to apply to your modifications.
-If you do not wish that, you must delete the exception notice from such
-code and/or adjust the licensing conditions notice accordingly.
+@verbinclude "lgpl.txt"
*/
-
-/**
-
-@page page_copyright_gnulicense GNU Library General Public License, Version 2
-
-Copyright (C) 1991 Free Software Foundation, Inc.
-675 Mass Ave, Cambridge, MA 02139, USA
-
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-
-[This is the first released version of the library GPL. It is
-numbered 2 because it goes with version 2 of the ordinary GPL.]
-
-@section page_copyright_gnulicense_preamble Preamble
-
-The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-Licenses are intended to guarantee your freedom to share and change
-free software -- to make sure the software is free for all its users.
-
-This license, the Library General Public License, applies to some
-specially designated Free Software Foundation software, and to any
-other libraries whose authors decide to use it. You can use it for
-your libraries, too.
-
-When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
-
-To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if
-you distribute copies of the library, or if you modify it.
-
-For example, if you distribute copies of the library, whether gratis
-or for a fee, you must give the recipients all the rights that we gave
-you. You must make sure that they, too, receive or can get the source
-code. If you link a program with the library, you must provide
-complete object files to the recipients so that they can relink them
-with the library, after making changes to the library and recompiling
-it. And you must show them these terms so they know their rights.
-
-Our method of protecting your rights has two steps: (1) copyright
-the library, and (2) offer you this license which gives you legal
-permission to copy, distribute and/or modify the library.
-
-Also, for each distributor's protection, we want to make certain
-that everyone understands that there is no warranty for this free
-library. If the library is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original
-version, so that any problems introduced by others will not reflect on
-the original authors' reputations.
-
-Finally, any free program is threatened constantly by software
-patents. We wish to avoid the danger that companies distributing free
-software will individually obtain patent licenses, thus in effect
-transforming the program into proprietary software. To prevent this,
-we have made it clear that any patent must be licensed for everyone's
-free use or not licensed at all.
-
-Most GNU software, including some libraries, is covered by the ordinary
-GNU General Public License, which was designed for utility programs. This
-license, the GNU Library General Public License, applies to certain
-designated libraries. This license is quite different from the ordinary
-one; be sure to read it in full, and don't assume that anything in it is
-the same as in the ordinary license.
-
-The reason we have a separate public license for some libraries is that
-they blur the distinction we usually make between modifying or adding to a
-program and simply using it. Linking a program with a library, without
-changing the library, is in some sense simply using the library, and is
-analogous to running a utility program or application program. However, in
-a textual and legal sense, the linked executable is a combined work, a
-derivative of the original library, and the ordinary General Public License
-treats it as such.
-
-Because of this blurred distinction, using the ordinary General
-Public License for libraries did not effectively promote software
-sharing, because most developers did not use the libraries. We
-concluded that weaker conditions might promote sharing better.
-
-However, unrestricted linking of non-free programs would deprive the
-users of those programs of all benefit from the free status of the
-libraries themselves. This Library General Public License is intended to
-permit developers of non-free programs to use free libraries, while
-preserving your freedom as a user of such programs to change the free
-libraries that are incorporated in them. (We have not seen how to achieve
-this as regards changes in header files, but we have achieved it as regards
-changes in the actual functions of the Library.) The hope is that this
-will lead to faster development of free libraries.
-
-The precise terms and conditions for copying, distribution and
-modification follow. Pay close attention to the difference between a
-"work based on the library" and a "work that uses the library". The
-former contains code derived from the library, while the latter only
-works together with the library.
-
-Note that it is possible for a library to be covered by the ordinary
-General Public License rather than by this special one.
-
-<center>
- GNU LIBRARY GENERAL PUBLIC LICENSE
-
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-</center>
-
-0. This License Agreement applies to any software library which
-contains a notice placed by the copyright holder or other authorized
-party saying it may be distributed under the terms of this Library
-General Public License (also called "this License"). Each licensee is
-addressed as "you".
-
-A "library" means a collection of software functions and/or data
-prepared so as to be conveniently linked with application programs
-(which use some of those functions and data) to form executables.
-
-The "Library", below, refers to any such software library or work
-which has been distributed under these terms. A "work based on the
-Library" means either the Library or any derivative work under
-copyright law: that is to say, a work containing the Library or a
-portion of it, either verbatim or with modifications and/or translated
-straightforwardly into another language. (Hereinafter, translation is
-included without limitation in the term "modification".)
-
-"Source code" for a work means the preferred form of the work for
-making modifications to it. For a library, complete source code means
-all the source code for all modules it contains, plus any associated
-interface definition files, plus the scripts used to control compilation
-and installation of the library.
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running a program using the Library is not restricted, and output from
-such a program is covered only if its contents constitute a work based
-on the Library (independent of the use of the Library in a tool for
-writing it). Whether that is true depends on what the Library does
-and what the program that uses the Library does.
-
-1. You may copy and distribute verbatim copies of the Library's
-complete source code as you receive it, in any medium, provided that
-you conspicuously and appropriately publish on each copy an
-appropriate copyright notice and disclaimer of warranty; keep intact
-all the notices that refer to this License and to the absence of any
-warranty; and distribute a copy of this License along with the
-Library.
-
-You may charge a fee for the physical act of transferring a copy,
-and you may at your option offer warranty protection in exchange for a
-fee.
-
-2. You may modify your copy or copies of the Library or any portion
-of it, thus forming a work based on the Library, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
-a) The modified work must itself be a software library.
-
-b) You must cause the files modified to carry prominent notices
-stating that you changed the files and the date of any change.
-
-c) You must cause the whole of the work to be licensed at no
-charge to all third parties under the terms of this License.
-
-d) If a facility in the modified Library refers to a function or a
-table of data to be supplied by an application program that uses
-the facility, other than as an argument passed when the facility
-is invoked, then you must make a good faith effort to ensure that,
-in the event an application does not supply such function or
-table, the facility still operates, and performs whatever part of
-its purpose remains meaningful.
-
-(For example, a function in a library to compute square roots has
-a purpose that is entirely well-defined independent of the
-application. Therefore, Subsection 2d requires that any
-application-supplied function or table used by this function must
-be optional: if the application does not supply it, the square
-root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Library,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Library, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Library.
-
-In addition, mere aggregation of another work not based on the Library
-with the Library (or with a work based on the Library) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-3. You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License. (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.) Do not make any other change in
-these notices.
-
-Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-
-This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-
-4. You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you accompany
-it with the complete corresponding machine-readable source code, which
-must be distributed under the terms of Sections 1 and 2 above on a
-medium customarily used for software interchange.
-
-If distribution of object code is made by offering access to copy
-from a designated place, then offering equivalent access to copy the
-source code from the same place satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-5. A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library". Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-
-However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library". The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-
-When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library. The
-threshold for this to be true is not precisely defined by law.
-
-If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work. (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-
-Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-
-6. As an exception to the Sections above, you may also compile or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
-You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License. You must supply a copy of this License. If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License. Also, you must do one
-of these things:
-
-a) Accompany the work with the complete corresponding
-machine-readable source code for the Library including whatever
-changes were used in the work (which must be distributed under
-Sections 1 and 2 above); and, if the work is an executable linked
-with the Library, with the complete machine-readable "work that
-uses the Library", as object code and/or source code, so that the
-user can modify the Library and then relink to produce a modified
-executable containing the modified Library. (It is understood
-that the user who changes the contents of definitions files in the
-Library will not necessarily be able to recompile the application
-to use the modified definitions.)
-
-b) Accompany the work with a written offer, valid for at
-least three years, to give the same user the materials
-specified in Subsection 6a, above, for a charge no more
-than the cost of performing this distribution.
-
-c) If distribution of the work is made by offering access to copy
-from a designated place, offer equivalent access to copy the above
-specified materials from the same place.
-
-d) Verify that the user has already received a copy of these
-materials or that you have already sent this user a copy.
-
-For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it. However, as a special exception,
-the source code distributed need not include anything that is normally
-distributed (in either source or binary form) with the major
-components (compiler, kernel, and so on) of the operating system on
-which the executable runs, unless that component itself accompanies
-the executable.
-
-It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system. Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-
-7. You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-
-a) Accompany the combined library with a copy of the same work
-based on the Library, uncombined with any other library
-facilities. This must be distributed under the terms of the
-Sections above.
-
-b) Give prominent notice with the combined library of the fact
-that part of it is a work based on the Library, and explaining
-where to find the accompanying uncombined form of the same work.
-
-8. You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License. Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library is void, and will automatically terminate your
-rights under this License. However, parties who have received copies,
-or rights, from you under this License will not have their licenses
-terminated so long as such parties remain in full compliance.
-
-9. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Library or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-
-10. Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-subject to these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
-11. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Library at all. For example, if a patent
-license would not permit royalty-free redistribution of the Library by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply,
-and the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-12. If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library under this License may add
-an explicit geographical distribution limitation excluding those countries,
-so that distribution is permitted only in or among countries not thus
-excluded. In such case, this License incorporates the limitation as if
-written in the body of this License.
-
-13. The Free Software Foundation may publish revised and/or new
-versions of the Library General Public License from time to time.
-Such new versions will be similar in spirit to the present version,
-but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Library
-specifies a version number of this License which applies to it and
-"any later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-the Free Software Foundation. If the Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-
-14. If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-write to the author to ask for permission. For software which is
-copyrighted by the Free Software Foundation, write to the Free
-Software Foundation; we sometimes make exceptions for this. Our
-decision will be guided by the two goals of preserving the free status
-of all derivatives of our free software and of promoting the sharing
-and reuse of software generally.
-
-<center>
-NO WARRANTY
-</center>
-
-15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
-KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
-LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
-AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
-FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
-CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
-LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-
-<center>
-END OF TERMS AND CONDITIONS
-</center>
-
-@section page_copyright_gnulicense_appendix Appendix: How to Apply These Terms to Your New Libraries
-
-If you develop a new library, and you want it to be of the greatest
-possible use to the public, we recommend making it free software that
-everyone can redistribute and change. You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms of the
-ordinary General Public License).
-
-To apply these terms, attach the following notices to the library. It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-@verbatim
-<one line to give the library's name and a brief idea of what it does.>
-Copyright (C) <year> <name of author>
-
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Library General Public
-License as published by the Free Software Foundation; either
-version 2 of the License, or (at your option) any later version.
-
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-Library General Public License for more details.
-
-You should have received a copy of the GNU Library General Public
-License along with this library; if not, write to the Free
-Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-@endverbatim
-
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary. Here is a sample; alter the names:
-
-@verbatim
-Yoyodyne, Inc., hereby disclaims all copyright interest in the
-library `Frob' (a library for tweaking knobs) written by James Random Hacker.
-
-<signature of Ty Coon>, 1 April 1990
-Ty Coon, President of Vice
-@endverbatim
-
-
-That's all there is to it!
-
-*/
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
-
/**
-@page page_multiplatform Multi-platform development
+@page page_multiplatform General Cross-Platform Development Tips
-This chapter describes some tips related to multi-platform development.
+This chapter describes some tips related to cross-platform development.
@li @ref page_multiplatform_includefiles
@li @ref page_multiplatform_libraries
@li @ref page_multiplatform_gui
@li @ref page_multiplatform_debug
+
<hr>
-@section page_multiplatform_includefiles Include files
+@section page_multiplatform_includefiles Include Files
-The main include file is @c "wx/wx.h"; this includes the most commonly
-used modules of wxWidgets.
+The main include file is @c "wx/wx.h"; this includes the most commonly used
+modules of wxWidgets.
To save on compilation time, include only those header files relevant to the
-source file. If you are using @b precompiled headers, you should include
-the following section before any other includes:
+source file. If you are using @b precompiled headers, you should include the
+following section before any other includes:
@verbatim
// For compilers that support precompilation, includes "wx.h".
#include <wx/wxprec.h>
#ifdef __BORLANDC__
-#pragma hdrstop
+# pragma hdrstop
#endif
#ifndef WX_PRECOMP
-// Include your minimal set of headers here, or wx.h
-#include <wx/wx.h>
+ // Include your minimal set of headers here, or wx.h
+# include <wx/wx.h>
#endif
... now your other include files ...
@endverbatim
-The file @c "wx/wxprec.h" includes @c "wx/wx.h". Although this incantation
-may seem quirky, it is in fact the end result of a lot of experimentation,
-and several Windows compilers to use precompilation which is largely automatic for
-compilers with necessary support. Currently it is used for Visual C++ (including
-embedded Visual C++), Borland C++, Open Watcom C++, Digital Mars C++
-and newer versions of GCC.
-Some compilers might need extra work from the application developer to set the
-build environment up as necessary for the support.
+The file @c "wx/wxprec.h" includes @c "wx/wx.h". Although this incantation may
+seem quirky, it is in fact the end result of a lot of experimentation, and
+several Windows compilers to use precompilation which is largely automatic for
+compilers with necessary support. Currently it is used for Visual C++
+(including embedded Visual C++), Borland C++, Open Watcom C++, Digital Mars C++
+and newer versions of GCC. Some compilers might need extra work from the
+application developer to set the build environment up as necessary for the
+support.
@section page_multiplatform_libraries Libraries
-All ports of wxWidgets can create either a @b static library or a @b shared library.
+All ports of wxWidgets can create either a @b static library or a @b shared
+library.
-When a program is linked against a @e static library, the machine code from the object
-files for any external functions used by the program is copied from the library into
-the final executable.
+When a program is linked against a @e static library, the machine code from the
+object files for any external functions used by the program is copied from the
+library into the final executable.
-@e Shared libraries are handled with a more advanced form of linking, which makes the
-executable file smaller. They use the extension @c \91.so\92 (Shared Object) under Linux
-and @c '.dll' (Dynamic Link Library) under Windows.
+@e Shared libraries are handled with a more advanced form of linking, which
+makes the executable file smaller. They use the extension @c ".so" (Shared
+Object) under Linux and @c ".dll" (Dynamic Link Library) under Windows.
-An executable file linked against a shared library contains only a small table of the
-functions it requires, instead of the complete machine code from the object files for
-the external functions.
-Before the executable file starts running, the machine code for the external functions
-is copied into memory from the shared library file on disk by the operating
-system - a process referred to as @e dynamic linking.
+An executable file linked against a shared library contains only a small table
+of the functions it requires, instead of the complete machine code from the
+object files for the external functions. Before the executable file starts
+running, the machine code for the external functions is copied into memory from
+the shared library file on disk by the operating system - a process referred to
+as @e dynamic linking.
-Dynamic linking makes executable files smaller and saves disk space, because one copy
-of a library can be shared between multiple programs.
-Most operating systems also provide a virtual memory mechanism which allows one copy
-of a shared library in physical memory to be used by all running programs, saving
+Dynamic linking makes executable files smaller and saves disk space, because
+one copy of a library can be shared between multiple programs. Most operating
+systems also provide a virtual memory mechanism which allows one copy of a
+shared library in physical memory to be used by all running programs, saving
memory as well as disk space.
-Furthermore, shared libraries make it possible to update a library without recompiling
-the programs which use it (provided the interface to the library does not change).
+Furthermore, shared libraries make it possible to update a library without
+recompiling the programs which use it (provided the interface to the library
+does not change).
-wxWidgets can also be built in @b multilib and @b monolithic variants.
-See the @ref page_libs for more information on these.
+wxWidgets can also be built in @b multilib and @b monolithic variants. See the
+@ref page_libs for more information on these.
@section page_multiplatform_configuration Configuration
-When using project files and makefiles directly to build wxWidgets,
-options are configurable in the file
-@c "wx/XXX/setup.h" where XXX is the required platform (such as @c msw, @c motif,
-@c gtk, @c mac).
+When using project files and makefiles directly to build wxWidgets, options are
+configurable in the file @c "wx/XXX/setup.h" where XXX is the required
+platform (such as @c msw, @c motif, @c gtk, @c mac).
-Some settings are a matter of taste, some help with platform-specific problems, and
-others can be set to minimize the size of the library. Please see the @c setup.h file
-and @c install.txt files for details on configuration.
+Some settings are a matter of taste, some help with platform-specific problems,
+and others can be set to minimize the size of the library. Please see the
+@c "setup.h" file and @c "install.txt" files for details on configuration.
-When using the @c 'configure' script to configure wxWidgets (on Unix and other platforms
-where configure is available), the corresponding @c setup.h files are generated automatically
-along with suitable makefiles.
+When using the @c "configure" script to configure wxWidgets (on Unix and other
+platforms where configure is available), the corresponding @c "setup.h" files
+are generated automatically along with suitable makefiles.
-When using the RPM packages (or DEB or other forms of @e binaries) for installing
-wxWidgets on Linux, a correct @c setup.h is shipped in the package and
-this must not be changed.
+When using the RPM packages (or DEB or other forms of @e binaries) for
+installing wxWidgets on Linux, a correct @c "setup.h" is shipped in the package
+and this must not be changed.
@section page_multiplatform_makefiles Makefiles
On Microsoft Windows, wxWidgets has a different set of makefiles for each
-compiler, because each compiler's @c 'make' tool is slightly different.
-Popular Windows compilers that we cater for, and the corresponding makefile
-extensions, include: Microsoft Visual C++ (.vc), Borland C++ (.bcc),
-OpenWatcom C++ (.wat) and MinGW/Cygwin (.gcc). Makefiles are provided
-for the wxWidgets library itself, samples, demos, and utilities.
-
-On Linux, Mac and OS/2, you use the @c 'configure' command to generate the
-necessary makefiles. You should also use this method when building with
+compiler, because each compiler's @c 'make' tool is slightly different. Popular
+Windows compilers that we cater for, and the corresponding makefile extensions,
+include: Microsoft Visual C++ (.vc), Borland C++ (.bcc), OpenWatcom C++ (.wat)
+and MinGW/Cygwin (.gcc). Makefiles are provided for the wxWidgets library
+itself, samples, demos, and utilities.
+
+On Linux, Mac and OS/2, you use the @c 'configure' command to generate the
+necessary makefiles. You should also use this method when building with
MinGW/Cygwin on Windows.
-We also provide project files for some compilers, such as Microsoft VC++.
-However, we recommend using makefiles to build the wxWidgets library itself,
-because makefiles can be more powerful and less manual intervention is required.
+We also provide project files for some compilers, such as Microsoft VC++.
+However, we recommend using makefiles to build the wxWidgets library itself,
+because makefiles can be more powerful and less manual intervention is
+required.
-On Windows using a compiler other than MinGW/Cygwin, you would build the wxWidgets
-library from the @c build/msw directory which contains the relevant makefiles.
+On Windows using a compiler other than MinGW/Cygwin, you would build the
+wxWidgets library from the @c "build/msw" directory which contains the relevant
+makefiles.
On Windows using MinGW/Cygwin, and on Unix, MacOS X and OS/2, you invoke
-'configure' (found in the top-level of the wxWidgets source hierarchy),
-from within a suitable empty directory for containing makefiles, object
-files and libraries.
+'configure' (found in the top-level of the wxWidgets source hierarchy), from
+within a suitable empty directory for containing makefiles, object files and
+libraries.
+
+For details on using makefiles, configure, and project files, please see
+@c "docs/xxx/install.txt" in your distribution, where @c "xxx" is the platform
+of interest, such as @c msw, @c gtk, @c x11, @c mac.
-For details on using makefiles, configure, and project files,
-please see @c docs/xxx/install.txt in your distribution, where
-@c xxx is the platform of interest, such as @c msw, @c gtk, @c x11, @c mac.
+All wxWidgets makefiles are generated using
+@link http://www.bakefile.org Bakefile @endlink. wxWidgets also provides (in
+the @c "build/bakefiles/wxpresets" folder) the wxWidgets bakefile presets.
+These files allow you to create bakefiles for your own wxWidgets-based
+applications very easily.
-All wxWidgets makefiles are generated using @link http://www.bakefile.org Bakefile @endlink.
-wxWidgets also provides (in the @c build/bakefiles/wxpresets) the
-<b>wxWidgets bakefile presets</b>: these files allow you to create bakefiles for
-your own wxWidgets-based applications very easily.
-@section page_multiplatform_winresources Windows Resource files
+@section page_multiplatform_winresources Windows Resource Files
-wxWidgets application compilation under MS Windows requires at least one
-extra file: a resource file.
+wxWidgets application compilation under MS Windows requires at least one extra
+file: a resource file.
-The least that must be defined in the Windows resource file (extension RC)
-is the following statement:
+The least that must be defined in the Windows resource file (extension RC) is
+the following statement:
@verbatim
#include "wx/msw/wx.rc"
wxicon icon wx.ico
@endverbatim
-The icon can then be referenced by name when creating a frame icon. See
-the MS Windows SDK documentation.
+The icon can then be referenced by name when creating a frame icon. See the
+Microsoft Windows SDK documentation.
-@note include wx.rc @e after any ICON statements
- so programs that search your executable for icons (such
- as the Program Manager) find your application icon first.
+@note Include "wx.rc" @e after any ICON statements so programs that search your
+ executable for icons (such as the Program Manager) find your application
+ icon first.
-@section page_multiplatform_allocatingobjects Allocating and deleting wxWidgets objects
+@section page_multiplatform_allocatingobjects Allocating and Deleting wxWidgets Objects
-In general, classes derived from wxWindow must dynamically allocated
-with @e new and deleted with @e delete. If you delete a window,
-all of its children and descendants will be automatically deleted,
-so you don't need to delete these descendants explicitly.
+In general, classes derived from wxWindow must dynamically allocated with
+@e new and deleted with @e delete. If you delete a window, all of its children
+and descendants will be automatically deleted, so you don't need to delete
+these descendants explicitly.
-When deleting a frame or dialog, use @b Destroy rather than @b delete so
-that the wxWidgets delayed deletion can take effect. This waits until idle time
+When deleting a frame or dialog, use @b Destroy rather than @b delete so that
+the wxWidgets delayed deletion can take effect. This waits until idle time
(when all messages have been processed) to actually delete the window, to avoid
problems associated with the GUI sending events to deleted windows.
-Don't create a window on the stack, because this will interfere
-with delayed deletion.
+Don't create a window on the stack, because this will interfere with delayed
+deletion.
-If you decide to allocate a C++ array of objects (such as wxBitmap) that may
-be cleaned up by wxWidgets, make sure you delete the array explicitly
-before wxWidgets has a chance to do so on exit, since calling @e delete on
-array members will cause memory problems.
+If you decide to allocate a C++ array of objects (such as wxBitmap) that may be
+cleaned up by wxWidgets, make sure you delete the array explicitly before
+wxWidgets has a chance to do so on exit, since calling @e delete on array
+members will cause memory problems.
wxColour can be created statically: it is not automatically cleaned
up and is unlikely to be shared between other objects; it is lightweight
enough for copies to be made.
-Beware of deleting objects such as a wxPen or wxBitmap if they are still in use.
-Windows is particularly sensitive to this: so make sure you
-make calls like wxDC::SetPen(wxNullPen) or wxDC::SelectObject(wxNullBitmap) before deleting
-a drawing object that may be in use. Code that doesn't do this will probably work
-fine on some platforms, and then fail under Windows.
+Beware of deleting objects such as a wxPen or wxBitmap if they are still in
+use. Windows is particularly sensitive to this, so make sure you make calls
+like wxDC::SetPen(wxNullPen) or wxDC::SelectObject(wxNullBitmap) before
+deleting a drawing object that may be in use. Code that doesn't do this will
+probably work fine on some platforms, and then fail under Windows.
-@section page_multiplatform_architecturedependency Architecture dependency
+@section page_multiplatform_architecturedependency Architecture Dependency
A problem which sometimes arises from writing multi-platform programs is that
the basic C types are not defined the same on all platforms. This holds true
for both the length in bits of the standard types (such as int and long) as
-well as their byte order, which might be little endian (typically
-on Intel computers) or big endian (typically on some Unix workstations). wxWidgets
+well as their byte order, which might be little endian (typically on Intel
+computers) or big endian (typically on some Unix workstations). wxWidgets
defines types and macros that make it easy to write architecture independent
code. The types are:
where wxInt32 stands for a 32-bit signed integer type etc. You can also check
which architecture the program is compiled on using the wxBYTE_ORDER define
-which is either wxBIG_ENDIAN or wxLITTLE_ENDIAN (in the future maybe wxPDP_ENDIAN
-as well).
+which is either wxBIG_ENDIAN or wxLITTLE_ENDIAN (in the future maybe
+wxPDP_ENDIAN as well).
The macros handling bit-swapping with respect to the applications endianness
are described in the @ref group_funcmacro_byteorder section.
-@section page_multiplatform_conditionalcompilation Conditional compilation
+@section page_multiplatform_conditionalcompilation Conditional Compilation
One of the purposes of wxWidgets is to reduce the need for conditional
compilation in source code, which can be messy and confusing to follow.
-However, sometimes it is necessary to incorporate platform-specific
-features (such as metafile use under MS Windows). The @ref page_wxusedef
-symbols listed in the file @c setup.h may be used for this purpose,
-along with any user-supplied ones.
+However, sometimes it is necessary to incorporate platform-specific features
+(such as metafile use under MS Windows). The @ref page_wxusedef symbols listed
+in the file @c setup.h may be used for this purpose, along with any
+user-supplied ones.
-@section page_multiplatform_cpp C++ issues
+@section page_multiplatform_cpp C++ Issues
The following documents some miscellaneous C++ issues.
@subsection page_multiplatform_cpp_templates Templates
-wxWidgets does not use templates (except for some advanced features that
-are switched off by default) since it is a notoriously unportable feature.
+wxWidgets does not use templates (except for some advanced features that are
+switched off by default) since it is a notoriously unportable feature.
-@subsection page_multiplatform_cpp_rtti RTTI
+@subsection page_multiplatform_cpp_rtti Runtime Type Information (RTTI)
wxWidgets does not use C++ run-time type information since wxWidgets provides
its own run-time type information system, implemented using macros.
@subsection page_multiplatform_cpp_null Type of NULL
-Some compilers (e.g. the native IRIX cc) define NULL to be 0L so that
-no conversion to pointers is allowed. Because of that, all these
-occurrences of NULL in the GTK+ port use an explicit conversion such
-as
+Some compilers (e.g. the native IRIX cc) define @NULL to be 0L so that no
+conversion to pointers is allowed. Because of that, all these occurrences of
+@NULL in the GTK+ port use an explicit conversion such as
@code
wxWindow *my_window = (wxWindow*) NULL;
@endcode
-It is recommended to adhere to this in all code using wxWidgets as
-this make the code (a bit) more portable.
+It is recommended to adhere to this in all code using wxWidgets as this make
+the code (a bit) more portable.
-@subsection page_multiplatform_cpp_precompiledheaders Precompiled headers
+@subsection page_multiplatform_cpp_precompiledheaders Precompiled Headers
-Some compilers, such as Borland C++ and Microsoft C++, support
-precompiled headers. This can save a great deal of compiling time. The
-recommended approach is to precompile @c "wx.h", using this
-precompiled header for compiling both wxWidgets itself and any
-wxWidgets applications. For Windows compilers, two dummy source files
-are provided (one for normal applications and one for creating DLLs)
-to allow initial creation of the precompiled header.
+Some compilers, such as Borland C++ and Microsoft C++, support precompiled
+headers. This can save a great deal of compiling time. The recommended approach
+is to precompile @c "wx.h", using this precompiled header for compiling both
+wxWidgets itself and any wxWidgets applications. For Windows compilers, two
+dummy source files are provided (one for normal applications and one for
+creating DLLs) to allow initial creation of the precompiled header.
-However, there are several downsides to using precompiled headers. One
-is that to take advantage of the facility, you often need to include
-more header files than would normally be the case. This means that
-changing a header file will cause more recompilations (in the case of
-wxWidgets, everything needs to be recompiled since everything includes @c "wx.h" !)
+However, there are several downsides to using precompiled headers. One is that
+to take advantage of the facility, you often need to include more header files
+than would normally be the case. This means that changing a header file will
+cause more recompilations (in the case of wxWidgets, everything needs to be
+recompiled since everything includes @c "wx.h").
-A related problem is that for compilers that don't have precompiled
-headers, including a lot of header files slows down compilation
-considerably. For this reason, you will find (in the common
-X and Windows parts of the library) conditional
-compilation that under Unix, includes a minimal set of headers;
-and when using Visual C++, includes @c wx.h. This should help provide
-the optimal compilation for each compiler, although it is
-biased towards the precompiled headers facility available
-in Microsoft C++.
+A related problem is that for compilers that don't have precompiled headers,
+including a lot of header files slows down compilation considerably. For this
+reason, you will find (in the common X and Windows parts of the library)
+conditional compilation that under Unix, includes a minimal set of headers; and
+when using Visual C++, includes @c "wx.h". This should help provide the optimal
+compilation for each compiler, although it is biased towards the precompiled
+headers facility available in Microsoft C++.
-@section page_multiplatform_filehandling File handling
+@section page_multiplatform_filehandling File Handling
-When building an application which may be used under different
-environments, one difficulty is coping with documents which may be
-moved to different directories on other machines. Saving a file which
-has pointers to full pathnames is going to be inherently unportable.
+When building an application which may be used under different environments,
+one difficulty is coping with documents which may be moved to different
+directories on other machines. Saving a file which has pointers to full
+pathnames is going to be inherently unportable.
-One approach is to store filenames on their own, with no directory
-information. The application then searches into a list of standard
-paths (platform-specific) through the use of wxStandardPaths.
+One approach is to store filenames on their own, with no directory information.
+The application then searches into a list of standard paths (platform-specific)
+through the use of wxStandardPaths.
Eventually you may want to use also the wxPathList class.
-Nowadays the limitations of DOS 8+3 filenames doesn't apply anymore.
-Most modern operating systems allow at least 255 characters in the filename;
-the exact maximum length, as well as the characters allowed in the filenames,
-are OS-specific so you should try to avoid extremely long (> 255 chars) filenames
+Nowadays the limitations of DOS 8+3 filenames doesn't apply anymore. Most
+modern operating systems allow at least 255 characters in the filename; the
+exact maximum length, as well as the characters allowed in the filenames, are
+OS-specific so you should try to avoid extremely long (> 255 chars) filenames
and/or filenames with non-ANSI characters.
Another thing you need to keep in mind is that all Windows operating systems
are case-insensitive, while Unix operating systems (Linux, Mac, etc) are
case-sensitive.
-Also, for text files, different OSes use different End Of Lines (EOL).
-Windows uses CR+LF convention, Linux uses LF only, Mac CR only.
+Also, for text files, different OSes use different End Of Lines (EOL). Windows
+uses CR+LF convention, Linux uses LF only, Mac CR only.
The wxTextFile, wxTextInputStream, wxTextOutputStream classes help to abstract
-from these differences.
-Of course, there are also 3rd party utilities such as @c dos2unix and @c unix2dos
-which do the EOL conversions.
+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 group_funcmacro_file section of the reference
-manual for the description of miscellaneous file handling functions.
+See also the @ref group_funcmacro_file section of the reference manual for the
+description of miscellaneous file handling functions.
-@section page_multiplatform_reducingerr Reducing programming errors
+
+@section page_multiplatform_reducingerr Reducing Programming Errors
@subsection page_multiplatform_reducingerr_useassert Use ASSERT
-It is good practice to use ASSERT statements liberally, that check for conditions
-that should or should not hold, and print out appropriate error messages.
+It is good practice to use ASSERT statements liberally, that check for
+conditions that should or should not hold, and print out appropriate error
+messages.
-These can be compiled out of a non-debugging version of wxWidgets
-and your application. Using ASSERT is an example of `defensive programming':
-it can alert you to problems later on.
+These can be compiled out of a non-debugging version of wxWidgets and your
+application. Using ASSERT is an example of `defensive programming': it can
+alert you to problems later on.
-See ::wxASSERT for more info.
+See wxASSERT() for more info.
-@subsection page_multiplatform_reducingerr_usewxstring Use wxString in preference to character arrays
+@subsection page_multiplatform_reducingerr_usewxstring Use wxString in Preference to Character Arrays
Using wxString can be much safer and more convenient than using @c wxChar*.
-You can reduce the possibility of memory leaks substantially, and it is much more
-convenient to use the overloaded operators than functions such as @c strcmp.
-wxString won't add a significant overhead to your program; the overhead is compensated
-for by easier manipulation (which means less code).
+You can reduce the possibility of memory leaks substantially, and it is much
+more convenient to use the overloaded operators than functions such as
+@c strcmp. wxString won't add a significant overhead to your program; the
+overhead is compensated for by easier manipulation (which means less code).
The same goes for other data types: use classes wherever possible.
-@section page_multiplatform_gui GUI design
-
-@subsection page_multiplatform_gui_usesizers Use sizers
+@section page_multiplatform_gui GUI Design
-Don't use absolute panel item positioning if you can avoid it. Different GUIs have
-very differently sized panel items. Consider using the @ref overview_sizer instead.
-
-@subsection page_multiplatform_gui_useresources Use wxWidgets resource files
-
-Use @c XRC (wxWidgets resource files) where possible, because they can be easily changed
-independently of source code. See the @ref overview_xrc for more info.
+@li <b>Use Sizers:</b> Don't use absolute panel item positioning if you can
+ avoid it. Every platform's native controls have very different sizes.
+ Consider using the @ref overview_sizer instead.
+@li <b>Use wxWidgets Resource Files:</b> Use @c XRC (wxWidgets resource files)
+ where possible, because they can be easily changed independently of source
+ code. See the @ref overview_xrc for more info.
@section page_multiplatform_debug Debugging
-@subsection page_multiplatform_debug_positivethinking Positive thinking
+@subsection page_multiplatform_debug_positivethinking Positive Thinking
-It is common to blow up the problem in one's imagination, so that it seems to threaten
-weeks, months or even years of work. The problem you face may seem insurmountable:
-but almost never is. Once you have been programming for some time, you will be able
-to remember similar incidents that threw you into the depths of despair. But
-remember, you always solved the problem, somehow!
+It is common to blow up the problem in one's imagination, so that it seems to
+threaten weeks, months or even years of work. The problem you face may seem
+insurmountable: but almost never is. Once you have been programming for some
+time, you will be able to remember similar incidents that threw you into the
+depths of despair. But remember, you always solved the problem, somehow!
-Perseverance is often the key, even though a seemingly trivial problem
-can take an apparently inordinate amount of time to solve. In the end,
-you will probably wonder why you worried so much. That's not to say it
-isn't painful at the time. Try not to worry -- there are many more important
-things in life.
+Perseverance is often the key, even though a seemingly trivial problem can take
+an apparently inordinate amount of time to solve. In the end, you will probably
+wonder why you worried so much. That's not to say it isn't painful at the time.
+Try not to worry -- there are many more important things in life.
-@subsection page_multiplatform_debug_simplifyproblem Simplify the problem
+@subsection page_multiplatform_debug_simplifyproblem Simplify the Problem
-Reduce the code exhibiting the problem to the smallest program possible
-that exhibits the problem. If it is not possible to reduce a large and
-complex program to a very small program, then try to ensure your code
-doesn't hide the problem (you may have attempted to minimize the problem
-in some way: but now you want to expose it).
+Reduce the code exhibiting the problem to the smallest program possible that
+exhibits the problem. If it is not possible to reduce a large and complex
+program to a very small program, then try to ensure your code doesn't hide the
+problem (you may have attempted to minimize the problem in some way: but now
+you want to expose it).
-With luck, you can add a small amount of code that causes the program
-to go from functioning to non-functioning state. This should give a clue
-to the problem. In some cases though, such as memory leaks or wrong
-deallocation, this can still give totally spurious results!
+With luck, you can add a small amount of code that causes the program to go
+from functioning to non-functioning state. This should give a clue to the
+problem. In some cases though, such as memory leaks or wrong deallocation, this
+can still give totally spurious results!
-@subsection page_multiplatform_debug_usedebugger Use a debugger
+@subsection page_multiplatform_debug_usedebugger Use a Debugger
-This sounds like facetious advice, but it is surprising how often people
-don't use a debugger. Often it is an overhead to install or learn how to
-use a debugger, but it really is essential for anything but the most
-trivial programs.
+This sounds like facetious advice, but it is surprising how often people don't
+use a debugger. Often it is an overhead to install or learn how to use a
+debugger, but it really is essential for anything but the most trivial
+programs.
-@subsection page_multiplatform_debug_uselogging Use logging functions
+@subsection page_multiplatform_debug_uselogging Use Logging Functions
-There is a variety of logging functions that you can use in your program:
-see @ref group_funcmacro_log.
+There is a variety of logging functions that you can use in your program: 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
-of debugging code, or you wish to print a bunch of variables).
+Using tracing statements may be more convenient than using the debugger in some
+circumstances (such as when your debugger doesn't support a lot of debugging
+code, or you wish to print a bunch of variables).
-@subsection page_multiplatform_debug_usedebuggingfacilities Use the wxWidgets debugging facilities
+@subsection page_multiplatform_debug_usedebuggingfacilities Use the wxWidgets Debugging Facilities
-You can use wxDebugContext to check for
-memory leaks and corrupt memory: in fact in debugging mode, wxWidgets will
-automatically check for memory leaks at the end of the program if wxWidgets is suitably
-configured. Depending on the operating system and compiler, more or less
-specific information about the problem will be logged.
+You can use wxDebugContext to check for memory leaks and corrupt memory: in
+fact in debugging mode, wxWidgets will automatically check for memory leaks at
+the end of the program if wxWidgets is suitably configured. Depending on the
+operating system and compiler, more or less specific information about the
+problem will be logged.
-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.
+You should also use @ref group_funcmacro_debugging as part of a "defensive
+programming" strategy, scattering wxASSERT()s 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.
See the @ref overview_debugging for further information.
-
*/
+
@image html main_wxlogo.png
-@section manual_user User manual:
+@section manual_user User Manual:
@li @subpage page_copyright
@li @subpage page_introduction
@li @subpage page_utils
@li @subpage page_samples
@li @subpage page_libs
+@li @subpage page_class_cat
@li @subpage page_topics
@li @subpage page_port
-@section manual_reference Reference manual:
+@section manual_reference Reference Manual:
@li @subpage page_constants
@li @subpage page_translations
/**
-@page page_port Platform details
+@page page_port Platform Details
wxWidgets defines a common API across platforms, but uses the native graphical
user interface (GUI) on each platform, so your program will take on the native
/**
-@page page_samples Samples supplied with wxWidgets
+@page page_samples Included Samples
Probably the best way to learn wxWidgets is by reading the source of some 70+
samples provided with it. Many aspects of wxWidgets programming can be learnt
wxWizardPage)
*/
+
/**
-@page page_utils Utilities supplied with wxWidgets
+@page page_utils Included Utilities
In addition to the wxWidgets libraries (see @ref page_libs), some utilities
are available to the users in the @c utils hierarchy (even if some of them are
You can find it under @c utils/wxrc.
-
*/
+
*/
#define wxConstCast( ptr, classname )
-/**
- This is defined in debug mode to be call the redefined new operator
- with filename and line number arguments. The definition is:
-
- @code
- #define WXDEBUG_NEW new(__FILE__,__LINE__)
- @endcode
-
- In non-debug mode, this is defined as the normal new operator.
-
- @header{wx/object.h}
-*/
-#define WXDEBUG_NEW( arg )
-
/**
This macro returns the pointer @e ptr cast to the type @e classname * if
the pointer is of this type (the check is done during the run-time) or
//@}
+/** @ingroup group_funcmacro_debug */
+//@{
+
+/**
+ This is defined in debug mode to be call the redefined new operator
+ with filename and line number arguments. The definition is:
+
+ @code
+ #define WXDEBUG_NEW new(__FILE__,__LINE__)
+ @endcode
+
+ In non-debug mode, this is defined as the normal new operator.
+
+ @header{wx/object.h}
+*/
+#define WXDEBUG_NEW( arg )
+
+//@}
+
projects / wxWidgets.git / commitdiff
