git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55913
c3d73ce0-8a6f-49c7-b76d-
6d57e0e08775
Returns ending position of the text @e between this tag and paired
ending tag.
See explanation (returned position is marked with '|'):
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;
*/
int GetEndPos1() const;
Returns ending position 2 of the text @e between this tag and paired
ending tag.
See explanation (returned position is marked with '|'):
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;
*/
int GetEndPos2() const;
/**
Returns the value of the parameter. You should check whether the
parameter exists or not (use wxHtmlTag::HasParam) first.
/**
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
@param par
The parameter's name.
@param with_quotes
/**
Returns @true if this tag is paired with ending tag, @false otherwise.
See the example of HTML document:
/**
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.
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.
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".
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.
*/
@param par
the parameter you're looking for.
*/
argument
and you can only retrieve one value (i.e. you can use only one "%" element
in @e format).
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
@param par
The name of the tag you want to query
@param format
/**
Set the size of the spacer tracked by this item.
/**
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.
*/
void SetSpacer(const wxSize& size);
/**
Set the window to be tracked by this item.
+ @deprecated @todo provide deprecation description
*/
void SetWindow(wxWindow* window);
*/
void SetWindow(wxWindow* window);
/**
Returns the static box associated with the sizer.
*/
/**
Returns the static box associated with the sizer.
*/
- wxStaticBox* GetStaticBox();
+ wxStaticBox* GetStaticBox() const;
/**
Returns the current position (counted in bytes) in the stream buffer.
*/
/**
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.
/**
Returns the amount of bytes read during the last IO call to the parent stream.
measured in bytes from the beginning of the stream.
Otherwise, it returns wxInvalidOffset.
*/
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.
/**
Specifies which pointers to use for stream buffering.
@return Returns the current position in the stream if possible,
wxInvalidOffset in the other case.
*/
@return Returns the current position in the stream if possible,
wxInvalidOffset in the other case.
*/
+ virtual wxFileOffset Tell() const;
/**
Truncates the buffer to the current position.
/**
Truncates the buffer to the current position.
@return The new stream position or wxInvalidOffset on error.
*/
@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.
*/
/**
Returns the current stream position.
*/
+ virtual wxFileOffset TellO() const;
/**
Writes up to the specified amount of bytes using the data of buffer.
/**
Writes up to the specified amount of bytes using the data of buffer.
@return The new stream position or wxInvalidOffset on error.
*/
@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.
*/
/**
Returns the current stream position.
*/
+ virtual wxFileOffset TellI() const;
/**
This function is only useful in read mode.
/**
This function is only useful in read mode.
Internal function.
It is called when the stream needs to change the current position.
*/
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.
*/
/**
Internal function.
It is called when the stream needs to know the real position.
*/
- off_t OnSysTell() const;
+ wxFileOffset OnSysTell() const;
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
// 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
+};
+
+
+ @param filemask
+ The XRC file, archive file, or wildcard specification that will be
+ used to load all resource files inside a zip archive.
- 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.
- 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,
*/
wxXmlResource(const wxString& filemask,
int flags = wxXRC_USE_LOCALE,
virtual ~wxXmlResource();
/**
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.
*/
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 \<object class="unknown"\>.
*/
bool AttachUnknownControl(const wxString& name,
wxWindow* control,
wxWindow* parent = NULL);
/**
*/
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();
/**
*/
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.
/**
Gets the global resources object or creates one if none exists.
- 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;
/**
*/
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;
/**
*/
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.
*/
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();
most of the wxWidgets library.
*/
void InitAllHandlers();
*/
wxBitmap LoadBitmap(const wxString& name);
*/
wxBitmap LoadBitmap(const wxString& name);
- Loads a dialog. @a dlg points to parent window (if any).
+ Loads a dialog. @a parent points to parent window (if any).
+ */
+ wxDialog* LoadDialog(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
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).
+ reason for this is that you may want to use derived class with a new event table).
+
+ @code
+ MyDialog dlg;
+ wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
+ dlg.ShowModal();
+ @endcode
- wxDialog* LoadDialog(wxWindow* parent, const wxString& name);
- bool LoadDialog(wxDialog* dlg, wxWindow* parent,
- const wxString& name);
- //@}
+ bool LoadDialog(wxDialog* dlg, wxWindow* parent, const wxString& name);
/**
Load an object from the resource specifying both the resource name and the
class name.
/**
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,
instance and returns @false on failure.
*/
wxObject* LoadObject(wxWindow* parent, const wxString& name,
const wxString& classname);
//@}
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);
*/
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);
wxToolBar* LoadToolBar(wxWindow* parent, const wxString& name);
/**
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);
*/
static wxXmlResource* Set(wxXmlResource* res);
wxChar* SetDomain(const wxChar* domain);
/**
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);
/**
*/
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
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);
};
*/
bool Unload(const wxString& filename);
};
virtual ~wxXmlResourceHandler();
/**
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);
understood by this handler.
*/
void AddStyle(const wxString& name, int value);
/**
Returns @true if it understands this node and can create
a resource from it, @false otherwise.
/**
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);
*/
bool CanHandle(wxXmlNode* node);
/**
Creates an object (menu, dialog, control, ...) from an XML node.
Should check for validity. @a parent is a higher-level object
/**
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);
/**
*/
wxObject* CreateResource(wxXmlNode* node, wxObject* parent,
wxObject* instance);
/**
- Called from CreateResource after variables
- were filled.
+ Called from CreateResource after variables were filled.
*/
wxObject* DoCreateResource();
/**
*/
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)
+ 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).
/**
Gets a bool flag (1, t, yes, on, true are @true, everything else is @false).
Gets colour in HTML syntax (\#RRGGBB).
*/
wxColour GetColour(const wxString& param,
Gets colour in HTML syntax (\#RRGGBB).
*/
wxColour GetColour(const wxString& param,
- const wxColour& default = wxNullColour);
+ const wxColour& defaultColour = wxNullColour);
/**
Returns the current file system.
/**
Returns the current file system.
wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0);
/**
wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0);
/**
Gets a font.
*/
wxFont GetFont();
Gets a font.
*/
wxFont GetFont();
- , @b wxSize@e size = wxDefaultSize)
+ wxIcon GetIcon(const wxString& param = wxT("icon"), wxSize size = wxDefaultSize);
/**
Gets the integer value from the parameter.
/**
Gets the integer value from the parameter.
wxString GetParamValue(const wxString& param);
/**
wxString GetParamValue(const wxString& param);
/**
Gets the position (may be in dialog units).
*/
Gets the position (may be in dialog units).
*/
+ wxPoint GetPosition(const wxString& param = wxT("pos"));
Gets the size (may be in dialog units).
*/
Gets the size (may be in dialog units).
*/
+ wxSize GetSize(const wxString& param = wxT("size"));
- , @b int@e defaults = 0)
Gets style flags from text in form "flag | flag2| flag3 |..."
Gets style flags from text in form "flag | flag2| flag3 |..."
- Only understands flags added with AddStyle.
+ Only understands flags added with AddStyle().
+ int GetStyle(const wxString& param = wxT("style"), int defaults = 0);
/**
Gets text from param and does some conversions:
/**
Gets text from param and does some conversions:
bool HasParam(const wxString& param);
/**
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);
e.g. object class="wxDialog".
*/
bool IsOfClass(wxXmlNode* node, const wxString& classname);
/**
Override this to receive notifications when an wxZipEntry object changes.
*/
/**
Override this to receive notifications when an wxZipEntry object changes.
*/
- void OnEntryUpdated(wxZipEntry& entry);
+ virtual void OnEntryUpdated(wxZipEntry& entry) = 0;
class wxZipEntry : public wxArchiveEntry
{
public:
class wxZipEntry : public wxArchiveEntry
{
public:
- wxZipEntry(const wxString& name = wxEmptyString);
+ wxZipEntry(const wxString& name = wxEmptyString,
+ const wxDateTime& dt = Now(),
+ wxFileOffset size = wxInvalidOffset);
/**
The compressed size of this entry in bytes.
*/
/**
The compressed size of this entry in bytes.
*/
- off_t GetCompressedSize() const;
+ wxFileOffset GetCompressedSize() const;
/**
CRC32 for this entry's data.
/**
CRC32 for this entry's data.
*/
bool PutNextEntry(const wxString& name,
const wxDateTime& dt = wxDateTime::Now(),
*/
bool PutNextEntry(const wxString& name,
const wxDateTime& dt = wxDateTime::Now(),
- off_t size = wxInvalidOffset);
+ wxFileOffset size = wxInvalidOffset);
projects / wxWidgets.git / commitdiff
