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

diff --git a/interface/wx/mimetype.h b/interface/wx/mimetype.h
index 0a31361309124268af781cf8a11e281099a7cd70..3c9576e0ed819aa9dd405b9d4f2a645df94d78b7 100644 (file)
--- a/interface/wx/mimetype.h
+++ b/interface/wx/mimetype.h
@@ -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.
     */