diff --git a/interface/wx/html/htmltag.h b/interface/wx/html/htmltag.h index 14fb57af9d..6a951001f8 100644 --- a/interface/wx/html/htmltag.h +++ b/interface/wx/html/htmltag.h @@ -46,6 +46,7 @@ public: Returns ending position of the text @e between this tag and paired ending tag. See explanation (returned position is marked with '|'): + @deprecated @todo provide deprecation description */ int GetEndPos1() const; @@ -53,6 +54,7 @@ public: Returns ending position 2 of the text @e between this tag and paired ending tag. See explanation (returned position is marked with '|'): + @deprecated @todo provide deprecation description */ int GetEndPos2() const; @@ -66,7 +68,7 @@ public: /** Returns the value of the parameter. You should check whether the parameter exists or not (use wxHtmlTag::HasParam) first. - + @param par The parameter's name. @param with_quotes @@ -93,7 +95,7 @@ public: /** Returns @true if this tag is paired with ending tag, @false otherwise. See the example of HTML document: - + In this example tags HTML and BODY have ending tags, first P and BR doesn't have ending tag while the second P has. The third P tag (which is ending itself) of course doesn't have ending tag. @@ -104,7 +106,7 @@ public: Returns @true if the tag has a parameter of the given name. Example : @c FONT SIZE=+2 COLOR="\#FF00FF" has two parameters named "SIZE" and "COLOR". - + @param par the parameter you're looking for. */ @@ -116,7 +118,7 @@ public: argument and you can only retrieve one value (i.e. you can use only one "%" element in @e format). - + @param par The name of the tag you want to query @param format diff --git a/interface/wx/sizer.h b/interface/wx/sizer.h index d17569026a..47f4d875c2 100644 --- a/interface/wx/sizer.h +++ b/interface/wx/sizer.h @@ -299,11 +299,13 @@ public: /** Set the size of the spacer tracked by this item. + @deprecated @todo provide deprecation description */ void SetSpacer(const wxSize& size); /** Set the window to be tracked by this item. + @deprecated @todo provide deprecation description */ void SetWindow(wxWindow* window); @@ -1644,7 +1646,7 @@ public: /** Returns the static box associated with the sizer. */ - wxStaticBox* GetStaticBox(); + wxStaticBox* GetStaticBox() const; }; diff --git a/interface/wx/stream.h b/interface/wx/stream.h index e131750559..f263607e4e 100644 --- a/interface/wx/stream.h +++ b/interface/wx/stream.h @@ -209,7 +209,7 @@ public: /** Returns the current position (counted in bytes) in the stream buffer. */ - off_t GetIntPosition() const; + wxFileOffset GetIntPosition() const; /** Returns the amount of bytes read during the last IO call to the parent stream. @@ -264,7 +264,7 @@ public: measured in bytes from the beginning of the stream. Otherwise, it returns wxInvalidOffset. */ - off_t Seek(off_t pos, wxSeekMode mode); + virtual wxFileOffset Seek(wxFileOffset pos, wxSeekMode mode); /** Specifies which pointers to use for stream buffering. @@ -320,7 +320,7 @@ public: @return Returns the current position in the stream if possible, wxInvalidOffset in the other case. */ - off_t Tell() const; + virtual wxFileOffset Tell() const; /** Truncates the buffer to the current position. @@ -399,12 +399,12 @@ public: @return The new stream position or wxInvalidOffset on error. */ - off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart); + virtual wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart); /** Returns the current stream position. */ - off_t TellO() const; + virtual wxFileOffset TellO() const; /** Writes up to the specified amount of bytes using the data of buffer. @@ -768,12 +768,12 @@ public: @return The new stream position or wxInvalidOffset on error. */ - off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart); + virtual wxFileOffset SeekI(wxFileOffset pos, wxSeekMode mode = wxFromStart); /** Returns the current stream position. */ - off_t TellI() const; + virtual wxFileOffset TellI() const; /** This function is only useful in read mode. @@ -884,13 +884,13 @@ public: Internal function. It is called when the stream needs to change the current position. */ - off_t OnSysSeek(off_t pos, wxSeekMode mode); + wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode); /** Internal function. It is called when the stream needs to know the real position. */ - off_t OnSysTell() const; + wxFileOffset OnSysTell() const; /** See OnSysRead(). diff --git a/interface/wx/xrc/xmlres.h b/interface/wx/xrc/xmlres.h index 2a5f89f159..a178f1a0dc 100644 --- a/interface/wx/xrc/xmlres.h +++ b/interface/wx/xrc/xmlres.h @@ -6,6 +6,23 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// +/** + Flags which can be used with wxXmlResource::wxXmlResource. +*/ +enum wxXmlResourceFlags +{ + /** Translatable strings will be translated via _(). */ + wxXRC_USE_LOCALE = 1, + + /** Subclass property of object nodes will be ignored (useful for previews in XRC editors). */ + wxXRC_NO_SUBCLASSING = 2, + + /** Prevent the XRC files from being reloaded from disk in case they have been modified there + since being last loaded (may slightly speed up loading them). */ + wxXRC_NO_RELOADING = 4 +}; + + /** @class wxXmlResource @@ -26,18 +43,15 @@ public: /** Constructor. + @param filemask + The XRC file, archive file, or wildcard specification that will be + used to load all resource files inside a zip archive. @param flags - wxXRC_USE_LOCALE: translatable strings will be translated via _(). - wxXRC_NO_SUBCLASSING: subclass property of object nodes will be ignored - (useful for previews in XRC editors). wxXRC_NO_RELOADING will prevent the - XRC files from being reloaded from disk in case they have been modified - there - since being last loaded (may slightly speed up loading them). + One or more value of the ::wxXmlResourceFlags enumeration. @param domain - The name of the gettext catalog to search for - translatable strings. By default all loaded catalogs will be - searched. This provides a way to allow the strings to only come - from a specific catalog. + The name of the gettext catalog to search for translatable strings. + By default all loaded catalogs will be searched. + This provides a way to allow the strings to only come from a specific catalog. */ wxXmlResource(const wxString& filemask, int flags = wxXRC_USE_LOCALE, @@ -52,37 +66,38 @@ public: virtual ~wxXmlResource(); /** - Initializes only a specific handler (or custom handler). Convention says - that the handler name is equal to the control's name plus 'XmlHandler', for - example - wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler - (wxxrc) can create include file that contains initialization code for - all controls used within the resource. Note that this handler should be - allocated on the heap, since it will be delete by - ClearHandlers() later. + Initializes only a specific handler (or custom handler). + Convention says that the handler name is equal to the control's name plus + 'XmlHandler', for example wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. + + The XML resource compiler (wxxrc) can create include file that contains + initialization code for all controls used within the resource. + Note that this handler must be allocated on the heap, since it will be + deleted by ClearHandlers() later. */ void AddHandler(wxXmlResourceHandler* handler); /** Attaches an unknown control to the given panel/window/dialog. - Unknown controls are used in conjunction with object class="unknown". + Unknown controls are used in conjunction with \. */ bool AttachUnknownControl(const wxString& name, wxWindow* control, wxWindow* parent = NULL); /** - Removes all handlers and deletes them (this means that any handlers added using - AddHandler() must be allocated on the heap). + Removes all handlers and deletes them (this means that any handlers + added using AddHandler() must be allocated on the heap). */ void ClearHandlers(); /** - Compares the XRC version to the argument. Returns -1 if the XRC version - is less than the argument, +1 if greater, and 0 if they are equal. + Compares the XRC version to the argument. + + Returns -1 if the XRC version is less than the argument, + +1 if greater, and 0 if they are equal. */ - int CompareVersion(int major, int minor, int release, - int revision) const; + int CompareVersion(int major, int minor, int release, int revision) const; /** Gets the global resources object or creates one if none exists. @@ -96,29 +111,32 @@ public: wxChar* GetDomain(); /** - Returns flags, which may be a bitlist of wxXRC_USE_LOCALE and - wxXRC_NO_SUBCLASSING. + Returns flags, which may be a bitlist of ::wxXmlResourceFlags + enumeration values. */ int GetFlags() const; /** - Returns version information (a.b.c.d = d+ 256*c + 256@c 2*b + 256@c 3*a). + Returns version information (a.b.c.d = d + 256*c + 2562*b + 2563*a). */ long GetVersion() const; /** - Returns a numeric ID that is equivalent to the string ID used in an XML - resource. If an unknown @a str_id is requested (i.e. other than wxID_XXX - or integer), a new record is created which associates the given string with - a number. If @a value_if_not_found is @c wxID_NONE, the number is obtained via + Returns a numeric ID that is equivalent to the string ID used in an XML resource. + + If an unknown @a str_id is requested (i.e. other than wxID_XXX or integer), + a new record is created which associates the given string with a number. + + If @a value_if_not_found is @c wxID_NONE, the number is obtained via wxNewId(). Otherwise @a value_if_not_found is used. Macro @c XRCID(name) is provided for convenient use in event tables. */ -#define int GetXRCID(const wxString& str_id, int value_if_not_found = -2) /* implementation is private */ + static int GetXRCID(const wxString& str_id, int value_if_not_found = wxID_NONE); /** - Initializes handlers for all supported controls/windows. This will - make the executable quite big because it forces linking against + Initializes handlers for all supported controls/windows. + + This will make the executable quite big because it forces linking against most of the wxWidgets library. */ void InitAllHandlers(); @@ -134,18 +152,25 @@ public: */ wxBitmap LoadBitmap(const wxString& name); - //@{ /** - Loads a dialog. @a dlg points to parent window (if any). - This form is used to finish creation of an already existing instance (the main - reason - for this is that you may want to use derived class with a new event table). - Example: + Loads a dialog. @a parent points to parent window (if any). */ wxDialog* LoadDialog(wxWindow* parent, const wxString& name); - bool LoadDialog(wxDialog* dlg, wxWindow* parent, - const wxString& name); - //@} + + /** + Loads a dialog. @a parent points to parent window (if any). + + This form is used to finish creation of an already existing instance (the main + reason for this is that you may want to use derived class with a new event table). + Example: + + @code + MyDialog dlg; + wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog"); + dlg.ShowModal(); + @endcode + */ + bool LoadDialog(wxDialog* dlg, wxWindow* parent, const wxString& name); /** Loads a frame. @@ -175,9 +200,9 @@ public: /** Load an object from the resource specifying both the resource name and the class name. - The first overload lets you load nonstandard container windows and returns @c - @NULL - on failure. The second one lets you finish the creation of an existing + + The first overload lets you load nonstandard container windows and returns + @NULL on failure. The second one lets you finish the creation of an existing instance and returns @false on failure. */ wxObject* LoadObject(wxWindow* parent, const wxString& name, @@ -187,15 +212,16 @@ public: const wxString& classname); //@} - //@{ /** - Loads a panel. @a panel points to parent window (if any). This form - is used to finish creation of an already existing instance. + Loads a panel. @a panel points to parent window (if any). */ wxPanel* LoadPanel(wxWindow* parent, const wxString& name); - bool LoadPanel(wxPanel* panel, wxWindow* parent, - const wxString& name); - //@} + + /** + Loads a panel. @a panel points to parent window (if any). + This form is used to finish creation of an already existing instance. + */ + bool LoadPanel(wxPanel* panel, wxWindow* parent, const wxString& name); /** Loads a toolbar. @@ -203,8 +229,8 @@ public: wxToolBar* LoadToolBar(wxWindow* parent, const wxString& name); /** - Sets the global resources object and returns a pointer to the previous one (may - be @NULL). + Sets the global resources object and returns a pointer to the previous one + (may be @NULL). */ static wxXmlResource* Set(wxXmlResource* res); @@ -215,16 +241,15 @@ public: wxChar* SetDomain(const wxChar* domain); /** - Sets flags (bitlist of wxXRC_USE_LOCALE and wxXRC_NO_SUBCLASSING). + Sets flags (bitlist of ::wxXmlResourceFlags enumeration values). */ void SetFlags(int flags); /** - This function unloads a resource previously loaded by - Load(). + This function unloads a resource previously loaded by Load(). + Returns @true if the resource was successfully unloaded and @false if it - hasn't - been found in the list of loaded resources. + hasn't been found in the list of loaded resources. */ bool Unload(const wxString& filename); }; @@ -256,7 +281,7 @@ public: virtual ~wxXmlResourceHandler(); /** - Add a style flag (e.g. wxMB_DOCKABLE) to the list of flags + Add a style flag (e.g. @c wxMB_DOCKABLE) to the list of flags understood by this handler. */ void AddStyle(const wxString& name, int value); @@ -269,6 +294,12 @@ public: /** Returns @true if it understands this node and can create a resource from it, @false otherwise. + + @note + You must not call any wxXmlResourceHandler methods except IsOfClass() + from this method! The instance is not yet initialized with node data + at the time CanHandle() is called and it is only safe to operate on + node directly or to call IsOfClass(). */ bool CanHandle(wxXmlNode* node); @@ -292,31 +323,29 @@ public: /** Creates an object (menu, dialog, control, ...) from an XML node. Should check for validity. @a parent is a higher-level object - (usually window, dialog or panel) that is often necessary to create the resource. + (usually window, dialog or panel) that is often necessary to + create the resource. - If @b instance is non-@NULL it should not create a new instance via 'new' but - should rather use this one, and call its Create method. + If @b instance is non-@NULL it should not create a new instance via 'new' + but should rather use this one, and call its Create method. */ wxObject* CreateResource(wxXmlNode* node, wxObject* parent, wxObject* instance); /** - Called from CreateResource after variables - were filled. + Called from CreateResource after variables were filled. */ wxObject* DoCreateResource(); /** - ) - Creates a animation() from the filename specified in @e param. + Creates an animation (see wxAnimation) from the filename specified in @a param. */ - wxAnimation GetAnimation(); + wxAnimation GetAnimation(const wxString& param = wxT("animation")); /** - , @b wxSize@e size = wxDefaultSize) Gets a bitmap. */ - wxBitmap GetBitmap(); + wxBitmap GetBitmap(const wxString& param = wxT("bitmap"), wxSize size = wxDefaultSize); /** Gets a bool flag (1, t, yes, on, true are @true, everything else is @false). @@ -327,7 +356,7 @@ public: Gets colour in HTML syntax (\#RRGGBB). */ wxColour GetColour(const wxString& param, - const wxColour& default = wxNullColour); + const wxColour& defaultColour = wxNullColour); /** Returns the current file system. @@ -340,7 +369,6 @@ public: wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0); /** - ) Gets a font. */ wxFont GetFont(); @@ -351,10 +379,9 @@ public: int GetID(); /** - , @b wxSize@e size = wxDefaultSize) Returns an icon. */ - wxIcon GetIcon(); + wxIcon GetIcon(const wxString& param = wxT("icon"), wxSize size = wxDefaultSize); /** Gets the integer value from the parameter. @@ -382,23 +409,20 @@ public: wxString GetParamValue(const wxString& param); /** - ) Gets the position (may be in dialog units). */ - wxPoint GetPosition(); + wxPoint GetPosition(const wxString& param = wxT("pos")); /** - ) Gets the size (may be in dialog units). */ - wxSize GetSize(); + wxSize GetSize(const wxString& param = wxT("size")); /** - , @b int@e defaults = 0) Gets style flags from text in form "flag | flag2| flag3 |..." - Only understands flags added with AddStyle. + Only understands flags added with AddStyle(). */ - int GetStyle(); + int GetStyle(const wxString& param = wxT("style"), int defaults = 0); /** Gets text from param and does some conversions: @@ -415,8 +439,8 @@ public: bool HasParam(const wxString& param); /** - Convenience function. Returns @true if the node has a property class equal to - classname, + Convenience function. + Returns @true if the node has a property class equal to classname, e.g. object class="wxDialog". */ bool IsOfClass(wxXmlNode* node, const wxString& classname); diff --git a/interface/wx/zipstrm.h b/interface/wx/zipstrm.h index d888e5cbf6..705a570e45 100644 --- a/interface/wx/zipstrm.h +++ b/interface/wx/zipstrm.h @@ -108,7 +108,7 @@ public: /** Override this to receive notifications when an wxZipEntry object changes. */ - void OnEntryUpdated(wxZipEntry& entry); + virtual void OnEntryUpdated(wxZipEntry& entry) = 0; }; @@ -167,7 +167,9 @@ public: class wxZipEntry : public wxArchiveEntry { public: - wxZipEntry(const wxString& name = wxEmptyString); + wxZipEntry(const wxString& name = wxEmptyString, + const wxDateTime& dt = Now(), + wxFileOffset size = wxInvalidOffset); /** Copy constructor. @@ -275,7 +277,7 @@ public: /** The compressed size of this entry in bytes. */ - off_t GetCompressedSize() const; + wxFileOffset GetCompressedSize() const; /** CRC32 for this entry's data. @@ -568,7 +570,7 @@ public: */ bool PutNextEntry(const wxString& name, const wxDateTime& dt = wxDateTime::Now(), - off_t size = wxInvalidOffset); + wxFileOffset size = wxInvalidOffset); //@} /**