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

More doxygen topic overview cleanup.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52157 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-02-27 18:37:48 +00:00
parent 7005cf4407
commit 23114fe1ed
2 changed files with 122 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
// Name: splitterwindow // Name: splitterwindow.h
// Purpose: topic overview // Purpose: topic overview
// Author: wxWidgets team // Author: wxWidgets team
// RCS-ID: $Id$ // RCS-ID: $Id$
@@ -8,67 +8,68 @@
/*! /*!
@page splitterwindow_overview wxSplitterWindow overview @page overview_splitterwindow wxSplitterWindow Overview
Classes: #wxSplitterWindow Classes: wxSplitterWindow
The following screenshot shows the appearance of a splitter window with a horizontal split.
The following screenshot shows the appearance of a splitter window with a
horizontal split.
The style wxSP_3D has been used to show a 3D border and 3D sash. The style wxSP_3D has been used to show a 3D border and 3D sash.
#Example
@image html splitter.bmp
@section wxsplitterwindowexample Example @section overview_splitterwindow_example Example
The following fragment shows how to create a splitter window, creating two The following fragment shows how to create a splitter window, creating two
subwindows and hiding one of them. subwindows and hiding one of them.
@code @code
splitter = new wxSplitterWindow(this, -1, wxPoint(0, 0), wxSize(400, 400), wxSP_3D); splitter = new wxSplitterWindow(this, -1, wxPoint(0, 0),
wxSize(400, 400), wxSP_3D);
leftWindow = new MyWindow(splitter); leftWindow = new MyWindow(splitter);
leftWindow-SetScrollbars(20, 20, 50, 50); leftWindow->SetScrollbars(20, 20, 50, 50);
rightWindow = new MyWindow(splitter); rightWindow = new MyWindow(splitter);
rightWindow-SetScrollbars(20, 20, 50, 50); rightWindow->SetScrollbars(20, 20, 50, 50);
rightWindow-Show(@false); rightWindow->Show(false);
splitter-Initialize(leftWindow); splitter->Initialize(leftWindow);
// Set this to prevent unsplitting // Set this to prevent unsplitting
// splitter-SetMinimumPaneSize(20); // splitter->SetMinimumPaneSize(20);
@endcode @endcode
The next fragment shows how the splitter window can be manipulated after
The next fragment shows how the splitter window can be manipulated after creation. creation.
@code @code
void MyFrame::OnSplitVertical(wxCommandEvent& event) void MyFrame::OnSplitVertical(wxCommandEvent& event)
{ {
if ( splitter-IsSplit() ) if ( splitter->IsSplit() )
splitter-Unsplit(); splitter->Unsplit();
leftWindow-Show(@true); leftWindow->Show(true);
rightWindow-Show(@true); rightWindow->Show(true);
splitter-SplitVertically( leftWindow, rightWindow ); splitter->SplitVertically( leftWindow, rightWindow );
} }
void MyFrame::OnSplitHorizontal(wxCommandEvent& event) void MyFrame::OnSplitHorizontal(wxCommandEvent& event)
{ {
if ( splitter-IsSplit() ) if ( splitter->IsSplit() )
splitter-Unsplit(); splitter->Unsplit();
leftWindow-Show(@true); leftWindow->Show(true);
rightWindow-Show(@true); rightWindow->Show(true);
splitter-SplitHorizontally( leftWindow, rightWindow ); splitter->SplitHorizontally( leftWindow, rightWindow );
} }
void MyFrame::OnUnsplit(wxCommandEvent& event) void MyFrame::OnUnsplit(wxCommandEvent& event)
{ {
if ( splitter-IsSplit() ) if ( splitter->IsSplit() )
splitter-Unsplit(); splitter->Unsplit();
} }
@endcode @endcode
*/ */

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

@@ -1,5 +1,5 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
// Name: stream // Name: stream.h
// Purpose: topic overview // Purpose: topic overview
// Author: wxWidgets team // Author: wxWidgets team
// RCS-ID: $Id$ // RCS-ID: $Id$
@@ -8,51 +8,60 @@
/*! /*!
@page stream_overview wxStreams overview @page overview_stream wxStreams Overview
Classes:
@li wxStreamBase
@li wxStreamBuffer
@li wxInputStream
@li wxOutputStream
@li wxFilterInputStream
@li wxFilterOutputStream
Standard C++ streams can cause problems on several platforms: they work quite
well in most cases, but in the multi-threaded case, for example, they have many
problems. Some Borland compilers refuse to work at all with them and using
iostreams on Linux makes writing programs that are binary compatible across
different Linux distributions, impossible.
Classes: #wxStreamBase,
#wxStreamBuffer, #wxInputStream,
#wxOutputStream,
#wxFilterInputStream,
#wxFilterOutputStream
@b Purpose of wxStream
Standard C++ streams can cause problems on several platforms:
they work quite well in most cases, but in the multi-threaded case, for example,
they have many problems. Some Borland compilers refuse to work at all
with them and using iostreams on Linux makes writing programs that are
binary compatible across different Linux distributions, impossible.
Therefore, wxStreams have been added to wxWidgets so that applications can Therefore, wxStreams have been added to wxWidgets so that applications can
reliably compile and run on all supported platforms without dependence on a reliably compile and run on all supported platforms without dependence on a
particular release of libg++. particular release of libg++.
wxStreams is divided in two main parts: wxStreams is divided in two main parts:
@li The core: wxStreamBase, wxStreamBuffer, wxInputStream, wxOutputStream,
the core: wxStreamBase, wxStreamBuffer, wxInputStream, wxOutputStream,
wxFilterIn/OutputStream wxFilterIn/OutputStream
the "IO" classes: wxSocketIn/OutputStream, wxDataIn/OutputStream, wxFileIn/OutputStream, ... @li The "IO" classes: wxSocketIn/OutputStream, wxDataIn/OutputStream,
wxFileIn/OutputStream, ...
wxStreamBase is the base definition of a stream. It defines, for example, the
API of OnSysRead, OnSysWrite, OnSysSeek and OnSysTell. These functions are
really implemented by the "IO" classes. wxInputStream and wxOutputStream
inherit from it.
wxStreamBase is the base definition of a stream. It defines, for example,
the API of OnSysRead, OnSysWrite, OnSysSeek and OnSysTell. These functions
are really implemented by the "IO" classes.
wxInputStream and wxOutputStream inherit from it.
wxStreamBuffer is a cache manager for wxStreamBase: it manages a stream buffer wxStreamBuffer is a cache manager for wxStreamBase: it manages a stream buffer
linked to a stream. One stream can have multiple stream buffers but one stream linked to a stream. One stream can have multiple stream buffers but one stream
have always one autoinitialized stream buffer. have always one autoinitialized stream buffer.
wxInputStream is the base class for read-only streams. It implements Read, wxInputStream is the base class for read-only streams. It implements Read,
SeekI (I for Input), and all read or IO generic related functions. SeekI (I for Input), and all read or IO generic related functions.
wxOutputStream does the same thing but it is for write-only streams. wxOutputStream does the same thing but it is for write-only streams.
wxFilterIn/OutputStream is the base class definition for stream filtering. wxFilterIn/OutputStream is the base class definition for stream filtering.
Stream filtering means a stream which does no syscall but filters data Stream filtering means a stream which does no syscall but filters data which
which are passed to it and then pass them to another stream. are passed to it and then pass them to another stream. For example,
For example, wxZLibInputStream is an inline stream decompressor. wxZLibInputStream is an inline stream decompressor.
The "IO" classes implements the specific parts of the stream. This could be The "IO" classes implements the specific parts of the stream. This could be
nothing in the case of wxMemoryIn/OutputStream which bases itself on nothing in the case of wxMemoryIn/OutputStream which bases itself on
wxStreamBuffer. This could also be a simple link to the a @true syscall wxStreamBuffer. This could also be a simple link to the a true syscall (for
(for example read(...), write(...)). example read(...), write(...)).
@b Generic usage: an example
Usage is simple. We can take the example of wxFileInputStream and here is some sample @section overview_stream_example Example
code:
Usage is simple. We can take the example of wxFileInputStream and here is some
sample code:
@code @code
... ...
@@ -87,4 +96,3 @@
*/ */