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

Removed wxImageList overview, and other @ref fixes.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52273 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-03-03 03:05:58 +00:00
parent 95d3881fed
commit 032e27aad0
6 changed files with 479 additions and 498 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/doxygen/mainpages/topics.h
View File

@@ -97,7 +97,6 @@ The following is a basic categorization of them:
@li @subpage overview_treectrl @li @subpage overview_treectrl
@li @subpage overview_listctrl @li @subpage overview_listctrl
@li @subpage overview_splitterwindow @li @subpage overview_splitterwindow
@li @subpage overview_imagelist
@li @subpage overview_bookctrl @li @subpage overview_bookctrl
@li @subpage overview_tips @li @subpage overview_tips
@li @subpage overview_docview @li @subpage overview_docview

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

@@ -8,7 +8,7 @@
/*! /*!
@page overview_app wxApp overview @page overview_app wxApp Overview
Classes: wxApp Classes: wxApp
@@ -21,27 +21,27 @@
@section overview_app_intro Introduction @section overview_app_intro Introduction
A wxWidgets application does not have a @e main procedure; the equivalent is the A wxWidgets application does not have a @e main procedure; the equivalent is
wxApp::OnInit member defined for a class derived from wxApp. the wxApp::OnInit member defined for a class derived from wxApp.
@e OnInit will usually create a top window as a bare minimum. @e OnInit will usually create a top window as a bare minimum. Unlike in earlier
Unlike in earlier versions of wxWidgets, OnInit does not return a frame. Instead it versions of wxWidgets, OnInit does not return a frame. Instead it returns a
returns a boolean value which indicates whether processing should continue (@true) boolean value which indicates whether processing should continue (@true) or not
or not (@false). You call wxApp::SetTopWindow to let wxWidgets know about the top window. (@false). You call wxApp::SetTopWindow to let wxWidgets know about the top
window.
Note that the program's command line arguments, represented by @e argc Note that the program's command line arguments, represented by @e argc and
and @e argv, are available from within wxApp member functions. @e argv, are available from within wxApp member functions.
An application closes by destroying all windows. Because all frames must An application closes by destroying all windows. Because all frames must be
be destroyed for the application to exit, it is advisable to use parent destroyed for the application to exit, it is advisable to use parent frames
frames wherever possible when creating new frames, so that deleting the wherever possible when creating new frames, so that deleting the top level
top level frame will automatically delete child frames. The alternative frame will automatically delete child frames. The alternative is to explicitly
is to explicitly delete child frames in the top-level frame's wxCloseEvent delete child frames in the top-level frame's wxCloseEvent handler.
handler.
In emergencies the wxExit function can be called to kill the In emergencies the wxExit function can be called to kill the application
application however normally the application shuts down automatically, however normally the application shuts down automatically, see
see @ref overview_app_shutdown. @ref overview_app_shutdown.
An example of defining an application follows: An example of defining an application follows:
@@ -65,38 +65,38 @@
} }
@endcode @endcode
Note the use of IMPLEMENT_APP(appClass), which allows wxWidgets to dynamically create Note the use of IMPLEMENT_APP(appClass), which allows wxWidgets to dynamically
an instance of the application object at the appropriate point in wxWidgets initialization. create an instance of the application object at the appropriate point in
Previous versions of wxWidgets used to rely on the creation of a global application object, wxWidgets initialization. Previous versions of wxWidgets used to rely on the
but this is no longer recommended, because required global initialization may not have creation of a global application object, but this is no longer recommended,
been performed at application object construction time. because required global initialization may not have been performed at
application object construction time.
You can also use DECLARE_APP(appClass) in a header file to declare the wxGetApp function You can also use DECLARE_APP(appClass) in a header file to declare the wxGetApp
which returns a reference to the application object. Otherwise you can only use the global function which returns a reference to the application object. Otherwise you can
@c wxTheApp pointer which is of type @c wxApp *. only use the global @c wxTheApp pointer which is of type @c wxApp*.
@section overview_app_shutdown Application Shutdown
@section overview_app_shutdown Application shutdown
The application normally shuts down when the last of its top level windows is The application normally shuts down when the last of its top level windows is
closed. This is normally the expected behaviour and means that it is enough to closed. This is normally the expected behaviour and means that it is enough to
call wxWindow::Close() in response to the @c "Exit" menu command if your program has a call wxWindow::Close() in response to the "Exit" menu command if your program
single top level window. If this behaviour is not desirable wxApp::SetExitOnFrameDelete has a single top level window. If this behaviour is not desirable
can be called to change it. wxApp::SetExitOnFrameDelete can be called to change it.
Note that such logic doesn't apply for the windows shown before the program enters the Note that such logic doesn't apply for the windows shown before the program
main loop: in other words, you can safely show a dialog from wxApp::OnInit and not be enters the main loop: in other words, you can safely show a dialog from
afraid that your application terminates when this dialog -- which is the last top level wxApp::OnInit and not be afraid that your application terminates when this
window for the moment -- is closed. dialog -- which is the last top level window for the moment -- is closed.
Another aspect of the application shutdown is wxApp::OnExit Another aspect of the application shutdown is wxApp::OnExit which is called
which is called when the application exits but @e before wxWidgets cleans up when the application exits but @e before wxWidgets cleans up its internal
its internal structures. You should delete all wxWidgets object that you structures. You should delete all wxWidgets object that you created by the time
created by the time OnExit finishes. OnExit finishes.
In particular, do @b not destroy them from application class' destructor! In particular, do @b not destroy them from application class' destructor! For
For example, this code may crash: example, this code may crash:
@code @code
class MyApp : public wxApp class MyApp : public wxApp
@@ -107,10 +107,10 @@
}; };
@endcode @endcode
The reason for that is that @c m_helpCtrl is a member object and is The reason for that is that @c m_helpCtrl is a member object and is thus
thus destroyed from MyApp destructor. But MyApp object is deleted after destroyed from MyApp destructor. But MyApp object is deleted after wxWidgets
wxWidgets structures that wxCHMHelpController depends on were structures that wxCHMHelpController depends on were uninitialized! The solution
uninitialized! The solution is to destroy HelpCtrl in @e OnExit: is to destroy HelpCtrl in @e OnExit:
@code @code
class MyApp : public wxApp class MyApp : public wxApp

266
docs/doxygen/overviews/archive.h
View File

@@ -8,27 +8,27 @@
/*! /*!
@page overview_arc Archive formats such as zip @page overview_arc Archive Formats
The archive classes handle archive formats such as zip, tar, rar and cab. The archive classes handle archive formats such as zip, tar, rar and cab.
Currently wxZip and wxTar classes are included. Currently wxZip and wxTar classes are included.
For each archive type, there are the following classes (using zip here For each archive type, there are the following classes (using zip here as an
as an example): example):
@li wxZipInputStream: input stream @li wxZipInputStream: Input stream
@li wxZipOutputStream: output stream @li wxZipOutputStream: Output stream
@li wxZipEntry: holds the meta-data for an entry (e.g. filename, timestamp, etc.) @li wxZipEntry: Holds meta-data for an entry (e.g. filename, timestamp, etc.)
There are also abstract wxArchive classes that can be used to write code There are also abstract wxArchive classes that can be used to write code that
that can handle any of the archive types, see @ref overview_arc_generic. can handle any of the archive types, see @ref overview_arc_generic.
Also see wxFileSystem for a higher level interface that Also see wxFileSystem for a higher level interface that can handle archive
can handle archive files in a generic way. files in a generic way.
The classes are designed to handle archives on both seekable streams such The classes are designed to handle archives on both seekable streams such as
as disk files, or non-seekable streams such as pipes and sockets disk files, or non-seekable streams such as pipes and sockets (see
(see @ref overview_arc_noseek). @ref overview_arc_noseek).
See also wxFileSystem. See also wxFileSystem.
@@ -43,12 +43,11 @@
<hr> <hr>
@section overview_arc_create Creating an archive @section overview_arc_create Creating an Archive
Call wxArchiveOutputStream::PutNextEntry() to create each new entry in the archive, Call wxArchiveOutputStream::PutNextEntry() to create each new entry in the
then write the entry's data. archive, then write the entry's data. Another call to PutNextEntry() closes the
Another call to PutNextEntry() closes the current entry and begins the next. current entry and begins the next. For example:
For example:
@code @code
wxFFileOutputStream out(_T("test.zip")); wxFFileOutputStream out(_T("test.zip"));
@@ -63,17 +62,18 @@
txt << _T("Some text for subdir/entry2.txt\n"); txt << _T("Some text for subdir/entry2.txt\n");
@endcode @endcode
The name of each entry can be a full path, which makes it possible to The name of each entry can be a full path, which makes it possible to store
store entries in subdirectories. entries in subdirectories.
@section overview_arc_extract Extracting an archive @section overview_arc_extract Extracting an Archive
wxArchiveInputStream::GetNextEntry() returns a pointer to entry object containing the wxArchiveInputStream::GetNextEntry() returns a pointer to entry object
meta-data for the next entry in the archive (and gives away ownership). containing the meta-data for the next entry in the archive (and gives away
ownership).
Reading from the input stream then returns the entry's data. Reading from the input stream then returns the entry's data. Eof() becomes
Eof() becomes @true after an attempt has been made to read past the end of the entry's data. @true after an attempt has been made to read past the end of the entry's data.
When there are no more entries, GetNextEntry() returns @NULL and sets Eof(). When there are no more entries, GetNextEntry() returns @NULL and sets Eof().
@@ -93,20 +93,20 @@
@section overview_arc_modify Modifying an archive @section overview_arc_modify Modifying an Archive
To modify an existing archive, write a new copy of the archive to a new file, To modify an existing archive, write a new copy of the archive to a new file,
making any necessary changes along the way and transferring any unchanged making any necessary changes along the way and transferring any unchanged
entries using wxArchiveOutputStream::CopyEntry(). entries using wxArchiveOutputStream::CopyEntry().
For archive types which compress entry data, CopyEntry() is likely to be For archive types which compress entry data, CopyEntry() is likely to be much
much more efficient than transferring the data using Read() and Write() more efficient than transferring the data using Read() and Write() since it
since it will copy them without decompressing and recompressing them. will copy them without decompressing and recompressing them.
In general modifications are not possible without rewriting the archive, In general modifications are not possible without rewriting the archive, though
though it may be possible in some limited cases. Even then, rewriting the it may be possible in some limited cases. Even then, rewriting the archive is
archive is usually a better choice since a failure can be handled without usually a better choice since a failure can be handled without losing the whole
losing the whole archive. wxTempFileOutputStream can be helpful to do this. archive. wxTempFileOutputStream can be helpful to do this.
For example to delete all entries matching the pattern "*.txt": For example to delete all entries matching the pattern "*.txt":
@@ -139,27 +139,26 @@
@section overview_arc_byname Looking up an archive entry by name @section overview_arc_byname Looking Up an Archive Entry by Name
Also see wxFileSystem for a higher level interface that is Also see wxFileSystem for a higher level interface that is more convenient for
more convenient for accessing archive entries by name. accessing archive entries by name.
To open just one entry in an archive, the most efficient way is To open just one entry in an archive, the most efficient way is to simply
to simply search for it linearly by calling wxArchiveInputStream::GetNextEntry() search for it linearly by calling wxArchiveInputStream::GetNextEntry() until
until the required entry is found. This works both for archives on seekable and the required entry is found. This works both for archives on seekable and
non-seekable streams. non-seekable streams.
The format of filenames in the archive is likely to be different The format of filenames in the archive is likely to be different from the local
from the local filename format. For example zips and tars use filename format. For example zips and tars use unix style names, with forward
unix style names, with forward slashes as the path separator, slashes as the path separator, and absolute paths are not allowed. So if on
and absolute paths are not allowed. So if on Windows the file Windows the file "C:\MYDIR\MYFILE.TXT" is stored, then when reading the entry
"C:\MYDIR\MYFILE.TXT" is stored, then when reading the entry back back wxArchiveEntry::GetName() will return "MYDIR\MYFILE.TXT". The conversion
wxArchiveEntry::GetName() will return "MYDIR\MYFILE.TXT". into the internal format and back has lost some information.
The conversion into the internal format and back has lost some information.
So to avoid ambiguity when searching for an entry matching a local name, So to avoid ambiguity when searching for an entry matching a local name, it is
it is better to convert the local name to the archive's internal format better to convert the local name to the archive's internal format and search
and search for that: for that:
@code @code
auto_ptr<wxZipEntry> entry; auto_ptr<wxZipEntry> entry;
@@ -172,19 +171,21 @@
wxZipInputStream zip(in); wxZipInputStream zip(in);
// call GetNextEntry() until the required internal name is found // call GetNextEntry() until the required internal name is found
do { do
{
entry.reset(zip.GetNextEntry()); entry.reset(zip.GetNextEntry());
} }
while (entry.get() != NULL && entry->GetInternalName() != name); while (entry.get() != NULL && entry->GetInternalName() != name);
if (entry.get() != NULL) { if (entry.get() != NULL)
{
// read the entry's data... // read the entry's data...
} }
@endcode @endcode
To access several entries randomly, it is most efficient to transfer the To access several entries randomly, it is most efficient to transfer the entire
entire catalogue of entries to a container such as a std::map or a catalogue of entries to a container such as a std::map or a wxHashMap then
wxHashMap then entries looked up by name can be opened using the entries looked up by name can be opened using the
wxArchiveInputStream::OpenEntry() method. wxArchiveInputStream::OpenEntry() method.
@code @code
@@ -198,7 +199,8 @@
wxZipInputStream zip(in); wxZipInputStream zip(in);
// load the zip catalog // load the zip catalog
while ((entry = zip.GetNextEntry()) != NULL) { while ((entry = zip.GetNextEntry()) != NULL)
{
wxZipEntry*& current = cat[entry->GetInternalName()]; wxZipEntry*& current = cat[entry->GetInternalName()];
// some archive formats can have multiple entries with the same name // some archive formats can have multiple entries with the same name
// (e.g. tar) though it is an error in the case of zip // (e.g. tar) though it is an error in the case of zip
@@ -207,14 +209,15 @@
} }
// open an entry by name // open an entry by name
if ((it = cat.find(wxZipEntry::GetInternalName(localname))) != cat.end()) { if ((it = cat.find(wxZipEntry::GetInternalName(localname))) != cat.end())
{
zip.OpenEntry(*it->second); zip.OpenEntry(*it->second);
// ... now read entry's data // ... now read entry's data
} }
@endcode @endcode
To open more than one entry simultaneously you need more than one To open more than one entry simultaneously you need more than one underlying
underlying stream on the same archive: stream on the same archive:
@code @code
// opening another entry without closing the first requires another // opening another entry without closing the first requires another
@@ -227,18 +230,18 @@
@section overview_arc_generic Generic archive programming @section overview_arc_generic Generic Archive Programming
Also see wxFileSystem for a higher level interface that Also see wxFileSystem for a higher level interface that can handle archive
can handle archive files in a generic way. files in a generic way.
The specific archive classes, such as the wxZip classes, inherit from The specific archive classes, such as the wxZip classes, inherit from the
the following abstract classes which can be used to write code that can following abstract classes which can be used to write code that can handle any
handle any of the archive types: of the archive types:
@li wxArchiveInputStream: input stream @li wxArchiveInputStream: Input stream
@li wxArchiveOutputStream: output stream @li wxArchiveOutputStream: Output stream
@li wxArchiveEntry: holds the meta-data for an entry (e.g. filename) @li wxArchiveEntry: Holds the meta-data for an entry (e.g. filename)
In order to able to write generic code it's necessary to be able to create In order to able to write generic code it's necessary to be able to create
instances of the classes without knowing which archive type is being used. instances of the classes without knowing which archive type is being used.
@@ -246,8 +249,8 @@
To allow this there is a class factory for each archive type, derived from To allow this there is a class factory for each archive type, derived from
wxArchiveClassFactory, that can create the other classes. wxArchiveClassFactory, that can create the other classes.
For example, given @e wxArchiveClassFactory* factory, streams and For example, given wxArchiveClassFactory* factory, streams and entries can be
entries can be created like this: created like this:
@code @code
// create streams without knowing their type // create streams without knowing their type
@@ -258,9 +261,9 @@
auto_ptr<wxArchiveEntry> entry(factory->NewEntry()); auto_ptr<wxArchiveEntry> entry(factory->NewEntry());
@endcode @endcode
For the factory itself, the static member wxArchiveClassFactory::Find(). For the factory itself, the static member wxArchiveClassFactory::Find() can be
can be used to find a class factory that can handle a given file used to find a class factory that can handle a given file extension or mime
extension or mime type. For example, given @e filename: type. For example, given @e filename:
@code @code
const wxArchiveClassFactory *factory; const wxArchiveClassFactory *factory;
@@ -270,8 +273,8 @@
stream = factory->NewStream(new wxFFileInputStream(filename)); stream = factory->NewStream(new wxFFileInputStream(filename));
@endcode @endcode
@e Find does not give away ownership of the returned pointer, so it @e Find() does not give away ownership of the returned pointer, so it does not
does not need to be deleted. need to be deleted.
There are similar class factories for the filter streams that handle the There are similar class factories for the filter streams that handle the
compression and decompression of a single stream, such as wxGzipInputStream. compression and decompression of a single stream, such as wxGzipInputStream.
@@ -287,7 +290,8 @@
// look for a filter handler, e.g. for '.gz' // look for a filter handler, e.g. for '.gz'
const wxFilterClassFactory *fcf; const wxFilterClassFactory *fcf;
fcf = wxFilterClassFactory::Find(filename, wxSTREAM_FILEEXT); fcf = wxFilterClassFactory::Find(filename, wxSTREAM_FILEEXT);
if (fcf) { if (fcf)
{
in.reset(fcf->NewStream(in.release())); in.reset(fcf->NewStream(in.release()));
// pop the extension, so if it was '.tar.gz' it is now just '.tar' // pop the extension, so if it was '.tar.gz' it is now just '.tar'
filename = fcf->PopExtension(filename); filename = fcf->PopExtension(filename);
@@ -296,7 +300,8 @@
// look for a archive handler, e.g. for '.zip' or '.tar' // look for a archive handler, e.g. for '.zip' or '.tar'
const wxArchiveClassFactory *acf; const wxArchiveClassFactory *acf;
acf = wxArchiveClassFactory::Find(filename, wxSTREAM_FILEEXT); acf = wxArchiveClassFactory::Find(filename, wxSTREAM_FILEEXT);
if (acf) { if (acf)
{
auto_ptr<wxArchiveInputStream> arc(acf->NewStream(in.release())); auto_ptr<wxArchiveInputStream> arc(acf->NewStream(in.release()));
auto_ptr<wxArchiveEntry> entry; auto_ptr<wxArchiveEntry> entry;
@@ -304,7 +309,8 @@
while ((entry.reset(arc->GetNextEntry())), entry.get() != NULL) while ((entry.reset(arc->GetNextEntry())), entry.get() != NULL)
std::wcout << entry->GetName().c_str() << "\n"; std::wcout << entry->GetName().c_str() << "\n";
} }
else { else
{
wxLogError(_T("can't handle '%s'"), filename.c_str()); wxLogError(_T("can't handle '%s'"), filename.c_str());
} }
} }
@@ -312,59 +318,57 @@
@section overview_arc_noseek Archives on non-seekable streams @section overview_arc_noseek Archives on Non-Seekable Streams
In general, handling archives on non-seekable streams is done in the same In general, handling archives on non-seekable streams is done in the same way
way as for seekable streams, with a few caveats. as for seekable streams, with a few caveats.
The main limitation is that accessing entries randomly using The main limitation is that accessing entries randomly using
wxArchiveInputStream::OpenEntry() is not possible, the entries can only be wxArchiveInputStream::OpenEntry() is not possible, the entries can only be
accessed sequentially in the order they are stored within the archive. accessed sequentially in the order they are stored within the archive.
For each archive type, there will also be other limitations which will For each archive type, there will also be other limitations which will depend
depend on the order the entries' meta-data is stored within the archive. on the order the entries' meta-data is stored within the archive. These are not
These are not too difficult to deal with, and are outlined below. too difficult to deal with, and are outlined below.
@subsection overview_arc_noseek_entrysize PutNextEntry and the entry size @subsection overview_arc_noseek_entrysize PutNextEntry and the Entry Size
When writing archives, some archive formats store the entry size before When writing archives, some archive formats store the entry size before the
the entry's data (tar has this limitation, zip doesn't). In this case entry's data (tar has this limitation, zip doesn't). In this case the entry's
the entry's size must be passed to wxArchiveOutputStream::PutNextEntry() size must be passed to wxArchiveOutputStream::PutNextEntry() or an error
or an error occurs. occurs.
This is only an issue on non-seekable streams, since otherwise the archive This is only an issue on non-seekable streams, since otherwise the archive
output stream can seek back and fix up the header once the size of the output stream can seek back and fix up the header once the size of the entry is
entry is known. known.
For generic programming, one way to handle this is to supply the size For generic programming, one way to handle this is to supply the size whenever
whenever it is known, and rely on the error message from the output it is known, and rely on the error message from the output stream when the
stream when the operation is not supported. operation is not supported.
@subsection overview_arc_noseek_weak GetNextEntry and the weak reference mechanism @subsection overview_arc_noseek_weak GetNextEntry and the Weak Reference Mechanism
Some archive formats do not store all an entry's meta-data before the Some archive formats do not store all an entry's meta-data before the entry's
entry's data (zip is an example). In this case, when reading from a data (zip is an example). In this case, when reading from a non-seekable
non-seekable stream, wxArchiveInputStream::GetNextEntry() can only return stream, wxArchiveInputStream::GetNextEntry() can only return a partially
a partially populated wxArchiveEntry object - not all the fields are set. populated wxArchiveEntry object - not all the fields are set.
The input stream then keeps a weak reference to the entry object and The input stream then keeps a weak reference to the entry object and updates it
updates it when more meta-data becomes available. A weak reference being when more meta-data becomes available. A weak reference being one that does not
one that does not prevent you from deleting the wxArchiveEntry object - the prevent you from deleting the wxArchiveEntry object - the input stream only
input stream only attempts to update it if it is still around. attempts to update it if it is still around.
The documentation for each archive entry type gives the details The documentation for each archive entry type gives the details of what
of what meta-data becomes available and when. For generic programming, meta-data becomes available and when. For generic programming, when the worst
when the worst case must be assumed, you can rely on all the fields case must be assumed, you can rely on all the fields of wxArchiveEntry being
of wxArchiveEntry being fully populated when GetNextEntry() returns, fully populated when GetNextEntry() returns, with the the following exceptions:
with the the following exceptions:
@li wxArchiveEntry::GetSize(): guaranteed to be available after the @li wxArchiveEntry::GetSize(): Guaranteed to be available after the entry has
entry has been read to wxInputStream::Eof(), or wxArchiveInputStream::CloseEntry() been read to wxInputStream::Eof(), or wxArchiveInputStream::CloseEntry()
has been called has been called.
@li wxArchiveEntry::IsReadOnly(): Guaranteed to be available after the end of
@li wxArchiveEntry::IsReadOnly(): guaranteed to be available after the end of
the archive has been reached, i.e. after GetNextEntry() returns @NULL and the archive has been reached, i.e. after GetNextEntry() returns @NULL and
Eof() is @true Eof() is @true.
This mechanism allows wxArchiveOutputStream::CopyEntry() to always fully This mechanism allows wxArchiveOutputStream::CopyEntry() to always fully
preserve entries' meta-data. No matter what order order the meta-data occurs preserve entries' meta-data. No matter what order order the meta-data occurs
@@ -373,12 +377,12 @@
@subsection overview_arc_noseek_notifier wxArchiveNotifier @subsection overview_arc_noseek_notifier wxArchiveNotifier
Notifier objects can be used to get a notification whenever an input Notifier objects can be used to get a notification whenever an input stream
stream updates a wxArchiveEntry object's data via the weak reference mechanism. updates a wxArchiveEntry object's data via the weak reference mechanism.
Consider the following code which renames an entry in an archive. Consider the following code which renames an entry in an archive. This is the
This is the usual way to modify an entry's meta-data, simply set the usual way to modify an entry's meta-data, simply set the required field before
required field before writing it with wxArchiveOutputStream::CopyEntry(): writing it with wxArchiveOutputStream::CopyEntry():
@code @code
auto_ptr<wxArchiveInputStream> arc(factory->NewStream(in)); auto_ptr<wxArchiveInputStream> arc(factory->NewStream(in));
@@ -387,7 +391,8 @@
outarc->CopyArchiveMetaData(*arc); outarc->CopyArchiveMetaData(*arc);
while (entry.reset(arc->GetNextEntry()), entry.get() != NULL) { while (entry.reset(arc->GetNextEntry()), entry.get() != NULL)
{
if (entry->GetName() == from) if (entry->GetName() == from)
entry->SetName(to); entry->SetName(to);
if (!outarc->CopyEntry(entry.release(), *arc)) if (!outarc->CopyEntry(entry.release(), *arc))
@@ -397,8 +402,8 @@
bool success = arc->Eof() && outarc->Close(); bool success = arc->Eof() && outarc->Close();
@endcode @endcode
However, for non-seekable streams, this technique cannot be used for However, for non-seekable streams, this technique cannot be used for fields
fields such as wxArchiveEntry::IsReadOnly(), which are not necessarily set when such as wxArchiveEntry::IsReadOnly(), which are not necessarily set when
wxArchiveInputStream::GetNextEntry() returns. wxArchiveInputStream::GetNextEntry() returns.
In this case a wxArchiveNotifier can be used: In this case a wxArchiveNotifier can be used:
@@ -411,8 +416,9 @@
}; };
@endcode @endcode
The meta-data changes are done in your notifier's wxArchiveNotifier::OnEntryUpdated() The meta-data changes are done in your notifier's
method, then wxArchiveEntry::SetNotifier() is called before CopyEntry(): wxArchiveNotifier::OnEntryUpdated() method, then wxArchiveEntry::SetNotifier()
is called before CopyEntry():
@code @code
auto_ptr<wxArchiveInputStream> arc(factory->NewStream(in)); auto_ptr<wxArchiveInputStream> arc(factory->NewStream(in));
@@ -422,7 +428,8 @@
outarc->CopyArchiveMetaData(*arc); outarc->CopyArchiveMetaData(*arc);
while (entry.reset(arc->GetNextEntry()), entry.get() != NULL) { while (entry.reset(arc->GetNextEntry()), entry.get() != NULL)
{
entry->SetNotifier(notifier); entry->SetNotifier(notifier);
if (!outarc->CopyEntry(entry.release(), *arc)) if (!outarc->CopyEntry(entry.release(), *arc))
break; break;
@@ -431,12 +438,11 @@
bool success = arc->Eof() && outarc->Close(); bool success = arc->Eof() && outarc->Close();
@endcode @endcode
SetNotifier() calls OnEntryUpdated() immediately, then the input SetNotifier() calls OnEntryUpdated() immediately, then the input stream calls
stream calls it again whenever it sets more fields in the entry. Since it again whenever it sets more fields in the entry. Since OnEntryUpdated() will
OnEntryUpdated() will be called at least once, this technique always be called at least once, this technique always works even when it is not
works even when it is not strictly necessary to use it. For example, strictly necessary to use it. For example, changing the entry name can be done
changing the entry name can be done this way too and it works on seekable this way too and it works on seekable streams as well as non-seekable.
streams as well as non-seekable.
*/ */

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

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

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

@@ -50,13 +50,13 @@ you need wxHelp and the wxHelpController class to control wxHelp.
GUI applications aren't all graphical wizardry. List and hash table needs are GUI applications aren't all graphical wizardry. List and hash table needs are
catered for by wxList and wxHashMap. You will undoubtedly need some catered for by wxList and wxHashMap. You will undoubtedly need some
platform-independent @ref functions_file, and you may find it handy to platform-independent @ref page_func_cat_file, and you may find it handy to
maintain and search a list of paths using wxPathList. There's many maintain and search a list of paths using wxPathList. There's many
@ref functions_miscellany of operating system methods and other functions. @ref page_func_cat_misc of operating system methods and other functions.
@seealso @seealso
@li @ref page_categories @li @ref page_class_cat
*/ */

2
docs/doxygen/overviews/xrc.h
View File

@@ -8,7 +8,7 @@
/*! /*!
@page overview_xrc XML Based Resource System @page overview_xrc XML Based Resource System (XRC)
Classes: wxXmlResource, wxXmlResourceHandler Classes: wxXmlResource, wxXmlResourceHandler