further prototype fixes (thanks to ifacecheck)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52645 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-21 14:22:27 +00:00
parent 1f5c66294a
commit cc6e1a74b9
3 changed files with 34 additions and 30 deletions

View File

@@ -79,7 +79,7 @@ public:
It's normally the same for wxBase and wxGUI except in the case of wxMac It's normally the same for wxBase and wxGUI except in the case of wxMac
and wxCocoa. and wxCocoa.
*/ */
virtual wxStandardPaths GetStandardPaths(); virtual wxStandardPaths& GetStandardPaths();
/** /**
Returns the wxWidgets port ID used by the running program and eventually Returns the wxWidgets port ID used by the running program and eventually

View File

@@ -82,15 +82,17 @@ public:
/** /**
Closes the archive, returning @true if it was successfully written. Closes the archive, returning @true if it was successfully written.
Called by the destructor if not called explicitly. Called by the destructor if not called explicitly.
@see wxOutputStream::Close()
*/ */
bool Close(); virtual bool Close();
/** /**
Close the current entry. Close the current entry.
It is called implicitly whenever another new entry is created with CopyEntry() It is called implicitly whenever another new entry is created with CopyEntry()
or PutNextEntry(), or when the archive is closed. or PutNextEntry(), or when the archive is closed.
*/ */
bool CloseEntry(); virtual bool CloseEntry();
/** /**
Some archive formats have additional meta-data that applies to the archive Some archive formats have additional meta-data that applies to the archive
@@ -109,7 +111,7 @@ public:
in which case the two streams set up a link and transfer the data in which case the two streams set up a link and transfer the data
when it becomes available. when it becomes available.
*/ */
bool CopyArchiveMetaData(wxArchiveInputStream& stream); virtual bool CopyArchiveMetaData(wxArchiveInputStream& stream);
/** /**
Takes ownership of @a entry and uses it to create a new entry in the Takes ownership of @a entry and uses it to create a new entry in the
@@ -124,8 +126,8 @@ public:
accessing. For non-seekable streams, @a entry must also be the last accessing. For non-seekable streams, @a entry must also be the last
thing read from @e stream. thing read from @e stream.
*/ */
bool CopyEntry(wxArchiveEntry* entry, virtual bool CopyEntry(wxArchiveEntry* entry,
wxArchiveInputStream& stream); wxArchiveInputStream& stream);
/** /**
Create a new directory entry (see wxArchiveEntry::IsDir) with the given Create a new directory entry (see wxArchiveEntry::IsDir) with the given
@@ -134,20 +136,22 @@ public:
PutNextEntry() can also be used to create directory entries, by supplying PutNextEntry() can also be used to create directory entries, by supplying
a name with a trailing path separator. a name with a trailing path separator.
*/ */
bool PutNextDirEntry(const wxString& name); virtual bool PutNextDirEntry(const wxString& name,
const wxDateTime& dt = wxDateTime::Now());
/** /**
Takes ownership of entry and uses it to create a new entry in the archive. Takes ownership of entry and uses it to create a new entry in the archive.
The entry's data can then be written by writing to this wxArchiveOutputStream. The entry's data can then be written by writing to this wxArchiveOutputStream.
*/ */
bool PutNextEntry(wxArchiveEntry* entry); virtual bool PutNextEntry(wxArchiveEntry* entry);
/** /**
Create a new entry with the given name, timestamp and size. The entry's Create a new entry with the given name, timestamp and size. The entry's
data can then be written by writing to this wxArchiveOutputStream. data can then be written by writing to this wxArchiveOutputStream.
*/ */
bool PutNextEntry(const wxString& name, const wxDateTime& dt = wxDateTime::Now(), virtual bool PutNextEntry(const wxString& name,
off_t size = wxInvalidOffset); const wxDateTime& dt = wxDateTime::Now(),
wxFileOffset size = wxInvalidOffset);
}; };
@@ -192,12 +196,12 @@ public:
/** /**
Gets the entry's timestamp. Gets the entry's timestamp.
*/ */
wxDateTime GetDateTime(); virtual wxDateTime GetDateTime() const;
/** /**
Sets the entry's timestamp. Sets the entry's timestamp.
*/ */
const void SetDateTime(const wxDateTime& dt); virtual void SetDateTime(const wxDateTime& dt);
/** /**
Returns the entry's name, by default in the native format. Returns the entry's name, by default in the native format.
@@ -206,7 +210,7 @@ public:
If this is a directory entry, (i.e. if IsDir() is @true) then the If this is a directory entry, (i.e. if IsDir() is @true) then the
returned string is the name with a trailing path separator. returned string is the name with a trailing path separator.
*/ */
wxString GetName(wxPathFormat format = wxPATH_NATIVE); virtual wxString GetName(wxPathFormat format = wxPATH_NATIVE) const;
/** /**
Sets the entry's name. Sets the entry's name.
@@ -214,24 +218,24 @@ public:
@see GetName() @see GetName()
*/ */
const void SetName(const wxString& name, virtual void SetName(const wxString& name,
wxPathFormat format = wxPATH_NATIVE); wxPathFormat format = wxPATH_NATIVE);
/** /**
Returns the size of the entry's data in bytes. Returns the size of the entry's data in bytes.
*/ */
off_t GetSize(); virtual wxFileOffset GetSize() const;
/** /**
Sets the size of the entry's data in bytes. Sets the size of the entry's data in bytes.
*/ */
const void SetSize(off_t size); virtual void SetSize(wxFileOffset size);
/** /**
Returns the path format used internally within the archive to store Returns the path format used internally within the archive to store
filenames. filenames.
*/ */
wxPathFormat GetInternalFormat() const; virtual wxPathFormat GetInternalFormat() const;
/** /**
Returns the entry's filename in the internal format used within the Returns the entry's filename in the internal format used within the
@@ -243,12 +247,12 @@ public:
@see @ref overview_archive_byname @see @ref overview_archive_byname
*/ */
wxString GetInternalName() const; virtual wxString GetInternalName() const;
/** /**
Returns a numeric value unique to the entry within the archive. Returns a numeric value unique to the entry within the archive.
*/ */
off_t GetOffset() const; virtual wxFileOffset GetOffset() const;
/** /**
Returns @true if this is a directory entry. Returns @true if this is a directory entry.
@@ -262,22 +266,22 @@ public:
unarchivers typically create whatever directories are necessary as they unarchivers typically create whatever directories are necessary as they
restore files, even if the archive contains no explicit directory entries. restore files, even if the archive contains no explicit directory entries.
*/ */
bool IsDir(); virtual bool IsDir() const;
/** /**
Marks this entry as a directory if @a isDir is @true. See IsDir() for more info. Marks this entry as a directory if @a isDir is @true. See IsDir() for more info.
*/ */
const void SetIsDir(bool isDir = true); virtual void SetIsDir(bool isDir = true);
/** /**
Returns @true if the entry is a read-only file. Returns @true if the entry is a read-only file.
*/ */
bool IsReadOnly(); virtual bool IsReadOnly() const;
/** /**
Sets this entry as a read-only file. Sets this entry as a read-only file.
*/ */
const void SetIsReadOnly(bool isReadOnly = true); virtual void SetIsReadOnly(bool isReadOnly = true);
/** /**
Sets the notifier (see wxArchiveNotifier) for this entry. Sets the notifier (see wxArchiveNotifier) for this entry.
@@ -294,7 +298,7 @@ public:
/** /**
Unsets the notifier eventually attached to this entry. Unsets the notifier eventually attached to this entry.
*/ */
void UnsetNotifier(); virtual void UnsetNotifier();
}; };

View File

@@ -18,8 +18,8 @@
replace standard art with their own version. replace standard art with their own version.
All that is needed is to derive a class from wxArtProvider, override either its All that is needed is to derive a class from wxArtProvider, override either its
wxArtProvider::CreateBitmap and/or its wxArtProvider::CreateIconBundle methods wxArtProvider::CreateBitmap() and/or its wxArtProvider::CreateIconBundle() methods
and register the provider with wxArtProvider::Push: and register the provider with wxArtProvider::Push():
@code @code
class MyProvider : public wxArtProvider class MyProvider : public wxArtProvider
@@ -185,9 +185,9 @@ public:
@see CreateIconBundle() @see CreateIconBundle()
*/ */
wxBitmap CreateBitmap(const wxArtID& id, virtual wxBitmap CreateBitmap(const wxArtID& id,
const wxArtClient& client, const wxArtClient& client,
const wxSize& size); const wxSize& size);
/** /**
This method is similar to CreateBitmap() but can be used when a bitmap This method is similar to CreateBitmap() but can be used when a bitmap