More doxygen topic overview cleanup.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52157 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
parent
7005cf4407
commit
23114fe1ed
@ -1,5 +1,5 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: splitterwindow
|
||||
// Name: splitterwindow.h
|
||||
// Purpose: topic overview
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
@ -8,67 +8,68 @@
|
||||
|
||||
/*!
|
||||
|
||||
@page splitterwindow_overview wxSplitterWindow overview
|
||||
@page overview_splitterwindow wxSplitterWindow Overview
|
||||
|
||||
Classes: #wxSplitterWindow
|
||||
The following screenshot shows the appearance of a splitter window with a horizontal split.
|
||||
Classes: wxSplitterWindow
|
||||
|
||||
The style wxSP_3D has been used to show a 3D border and 3D sash.
|
||||
#Example
|
||||
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.
|
||||
|
||||
@image html splitter.bmp
|
||||
|
||||
|
||||
@section wxsplitterwindowexample Example
|
||||
@section overview_splitterwindow_example Example
|
||||
|
||||
The following fragment shows how to create a splitter window, creating two
|
||||
subwindows and hiding one of them.
|
||||
The following fragment shows how to create a splitter window, creating two
|
||||
subwindows and hiding one of them.
|
||||
|
||||
@code
|
||||
splitter = new wxSplitterWindow(this, -1, wxPoint(0, 0),
|
||||
wxSize(400, 400), wxSP_3D);
|
||||
|
||||
@code
|
||||
splitter = new wxSplitterWindow(this, -1, wxPoint(0, 0), wxSize(400, 400), wxSP_3D);
|
||||
leftWindow = new MyWindow(splitter);
|
||||
leftWindow->SetScrollbars(20, 20, 50, 50);
|
||||
|
||||
leftWindow = new MyWindow(splitter);
|
||||
leftWindow-SetScrollbars(20, 20, 50, 50);
|
||||
rightWindow = new MyWindow(splitter);
|
||||
rightWindow->SetScrollbars(20, 20, 50, 50);
|
||||
rightWindow->Show(false);
|
||||
|
||||
rightWindow = new MyWindow(splitter);
|
||||
rightWindow-SetScrollbars(20, 20, 50, 50);
|
||||
rightWindow-Show(@false);
|
||||
splitter->Initialize(leftWindow);
|
||||
|
||||
splitter-Initialize(leftWindow);
|
||||
// Set this to prevent unsplitting
|
||||
// splitter->SetMinimumPaneSize(20);
|
||||
@endcode
|
||||
|
||||
// Set this to prevent unsplitting
|
||||
// splitter-SetMinimumPaneSize(20);
|
||||
@endcode
|
||||
The next fragment shows how the splitter window can be manipulated after
|
||||
creation.
|
||||
|
||||
@code
|
||||
void MyFrame::OnSplitVertical(wxCommandEvent& event)
|
||||
{
|
||||
if ( splitter->IsSplit() )
|
||||
splitter->Unsplit();
|
||||
leftWindow->Show(true);
|
||||
rightWindow->Show(true);
|
||||
splitter->SplitVertically( leftWindow, rightWindow );
|
||||
}
|
||||
|
||||
The next fragment shows how the splitter window can be manipulated after creation.
|
||||
void MyFrame::OnSplitHorizontal(wxCommandEvent& event)
|
||||
{
|
||||
if ( splitter->IsSplit() )
|
||||
splitter->Unsplit();
|
||||
leftWindow->Show(true);
|
||||
rightWindow->Show(true);
|
||||
splitter->SplitHorizontally( leftWindow, rightWindow );
|
||||
}
|
||||
|
||||
void MyFrame::OnUnsplit(wxCommandEvent& event)
|
||||
{
|
||||
if ( splitter->IsSplit() )
|
||||
splitter->Unsplit();
|
||||
}
|
||||
@endcode
|
||||
|
||||
@code
|
||||
void MyFrame::OnSplitVertical(wxCommandEvent& event)
|
||||
{
|
||||
if ( splitter-IsSplit() )
|
||||
splitter-Unsplit();
|
||||
leftWindow-Show(@true);
|
||||
rightWindow-Show(@true);
|
||||
splitter-SplitVertically( leftWindow, rightWindow );
|
||||
}
|
||||
|
||||
void MyFrame::OnSplitHorizontal(wxCommandEvent& event)
|
||||
{
|
||||
if ( splitter-IsSplit() )
|
||||
splitter-Unsplit();
|
||||
leftWindow-Show(@true);
|
||||
rightWindow-Show(@true);
|
||||
splitter-SplitHorizontally( leftWindow, rightWindow );
|
||||
}
|
||||
|
||||
void MyFrame::OnUnsplit(wxCommandEvent& event)
|
||||
{
|
||||
if ( splitter-IsSplit() )
|
||||
splitter-Unsplit();
|
||||
}
|
||||
@endcode
|
||||
|
||||
*/
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: stream
|
||||
// Name: stream.h
|
||||
// Purpose: topic overview
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
@ -8,83 +8,91 @@
|
||||
|
||||
/*!
|
||||
|
||||
@page stream_overview wxStreams overview
|
||||
@page overview_stream wxStreams Overview
|
||||
|
||||
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
|
||||
reliably compile and run on all supported platforms without dependence on a
|
||||
particular release of libg++.
|
||||
wxStreams is divided in two main parts:
|
||||
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.
|
||||
|
||||
the core: wxStreamBase, wxStreamBuffer, wxInputStream, wxOutputStream,
|
||||
wxFilterIn/OutputStream
|
||||
the "IO" classes: wxSocketIn/OutputStream, wxDataIn/OutputStream, wxFileIn/OutputStream, ...
|
||||
Therefore, wxStreams have been added to wxWidgets so that applications can
|
||||
reliably compile and run on all supported platforms without dependence on a
|
||||
particular release of libg++.
|
||||
|
||||
wxStreams is divided in two main parts:
|
||||
|
||||
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
|
||||
linked to a stream. One stream can have multiple stream buffers but one stream
|
||||
have always one autoinitialized stream buffer.
|
||||
wxInputStream is the base class for read-only streams. It implements Read,
|
||||
SeekI (I for Input), and all read or IO generic related functions.
|
||||
wxOutputStream does the same thing but it is for write-only streams.
|
||||
wxFilterIn/OutputStream is the base class definition for stream filtering.
|
||||
Stream filtering means a stream which does no syscall but filters data
|
||||
which are passed to it and then pass them to another stream.
|
||||
For example, wxZLibInputStream is an inline stream decompressor.
|
||||
The "IO" classes implements the specific parts of the stream. This could be
|
||||
nothing in the case of wxMemoryIn/OutputStream which bases itself on
|
||||
wxStreamBuffer. This could also be a simple link to the a @true syscall
|
||||
(for example read(...), write(...)).
|
||||
@b Generic usage: an example
|
||||
Usage is simple. We can take the example of wxFileInputStream and here is some sample
|
||||
code:
|
||||
@li The core: wxStreamBase, wxStreamBuffer, wxInputStream, wxOutputStream,
|
||||
wxFilterIn/OutputStream
|
||||
@li The "IO" classes: wxSocketIn/OutputStream, wxDataIn/OutputStream,
|
||||
wxFileIn/OutputStream, ...
|
||||
|
||||
@code
|
||||
...
|
||||
// The constructor initializes the stream buffer and open the file descriptor
|
||||
// associated to the name of the file.
|
||||
wxFileInputStream in_stream("the_file_to_be_read");
|
||||
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.
|
||||
|
||||
// Ok, read some bytes ... nb_datas is expressed in bytes.
|
||||
in_stream.Read(data, nb_datas);
|
||||
if (in_stream.LastError() != wxSTREAM_NOERROR) {
|
||||
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
|
||||
have always one autoinitialized stream buffer.
|
||||
|
||||
wxInputStream is the base class for read-only streams. It implements Read,
|
||||
SeekI (I for Input), and all read or IO generic related functions.
|
||||
wxOutputStream does the same thing but it is for write-only streams.
|
||||
|
||||
wxFilterIn/OutputStream is the base class definition for stream filtering.
|
||||
Stream filtering means a stream which does no syscall but filters data which
|
||||
are passed to it and then pass them to another stream. For example,
|
||||
wxZLibInputStream is an inline stream decompressor.
|
||||
|
||||
The "IO" classes implements the specific parts of the stream. This could be
|
||||
nothing in the case of wxMemoryIn/OutputStream which bases itself on
|
||||
wxStreamBuffer. This could also be a simple link to the a true syscall (for
|
||||
example read(...), write(...)).
|
||||
|
||||
@section overview_stream_example Example
|
||||
|
||||
Usage is simple. We can take the example of wxFileInputStream and here is some
|
||||
sample code:
|
||||
|
||||
@code
|
||||
...
|
||||
// The constructor initializes the stream buffer and open the file descriptor
|
||||
// associated to the name of the file.
|
||||
wxFileInputStream in_stream("the_file_to_be_read");
|
||||
|
||||
// Ok, read some bytes ... nb_datas is expressed in bytes.
|
||||
in_stream.Read(data, nb_datas);
|
||||
if (in_stream.LastError() != wxSTREAM_NOERROR) {
|
||||
// Oh oh, something bad happens.
|
||||
// For a complete list, look into the documentation at wxStreamBase.
|
||||
}
|
||||
}
|
||||
|
||||
// You can also inline all like this.
|
||||
if (in_stream.Read(data, nb_datas).LastError() != wxSTREAM_NOERROR) {
|
||||
// You can also inline all like this.
|
||||
if (in_stream.Read(data, nb_datas).LastError() != wxSTREAM_NOERROR) {
|
||||
// Do something.
|
||||
}
|
||||
}
|
||||
|
||||
// You can also get the last number of bytes REALLY put into the buffer.
|
||||
size_t really_read = in_stream.LastRead();
|
||||
// You can also get the last number of bytes REALLY put into the buffer.
|
||||
size_t really_read = in_stream.LastRead();
|
||||
|
||||
// Ok, moves to the beginning of the stream. SeekI returns the last position
|
||||
// in the stream counted from the beginning.
|
||||
off_t old_position = in_stream.SeekI(0, wxFromBeginning);
|
||||
// Ok, moves to the beginning of the stream. SeekI returns the last position
|
||||
// in the stream counted from the beginning.
|
||||
off_t old_position = in_stream.SeekI(0, wxFromBeginning);
|
||||
|
||||
// What is my current position ?
|
||||
off_t position = in_stream.TellI();
|
||||
// What is my current position ?
|
||||
off_t position = in_stream.TellI();
|
||||
|
||||
// wxFileInputStream will close the file descriptor on destruction.
|
||||
@endcode
|
||||
|
||||
*/
|
||||
// wxFileInputStream will close the file descriptor on destruction.
|
||||
@endcode
|
||||
|
||||
*/
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user