Document wxFileType::MessageParameters class.

Documentation is not really very helpful but better than nothing.

Closes #13972.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70586 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-02-15 00:35:32 +00:00
parent b3a3a879c3
commit 0b64c2ad63

View File

@@ -221,6 +221,35 @@ private:
wxFileType();
public:
/**
Class representing message parameters.
An object of this class may be passed to wxFileType::GetOpenCommand()
and GetPrintCommand() if more than the file name needs to be specified.
*/
class MessageParameters
{
public:
/// Constructor
MessageParameters() { }
/// Constructor taking a filename and a mime type.
MessageParameters(const wxString& filename,
const wxString& mimetype = wxEmptyString);
/// Return the filename.
const wxString& GetFileName() const;
/// Return the MIME type.
const wxString& GetMimeType() const;
/// Overridable method for derived classes. Returns empty string by default.
virtual wxString GetParamValue(const wxString& name) const;
/// Trivial but virtual dtor as this class can be inherited from.
virtual ~MessageParameters() { }
};
/**
Copy ctor.
*/