avoid infinite recursion for richtooltops, (hopefully) fixes #15070

[wxWidgets.git] / interface / wx / mimetype.h

diff --git a/interface/wx/mimetype.h b/interface/wx/mimetype.h
index ad6b738b24230354ee1c05cdcb3bfd315d1e19c7..3f41d444a388abccbb6fd5da14756b18c08f97a9 100644 (file)
--- a/interface/wx/mimetype.h
+++ b/interface/wx/mimetype.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxMimeTypesManager
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxMimeTypesManager
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -97,6 +97,24 @@ public:
         necessary to convert the strings to the same case before calling it.
     */
     static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
         necessary to convert the strings to the same case before calling it.
     */
     static bool IsOfType(const wxString& mimeType, const wxString& wildcard);

+
+
+    /**
+       Create a new association using the fields of wxFileTypeInfo (at least
+       the MIME type and the extension should be set).
+    */
+    wxFileType *Associate(const wxFileTypeInfo& ftInfo);
+
+    /**
+       Undo Associate().
+    */
+    bool Unassociate(wxFileType *ft) ;
+
+    /**
+       Enumerate all known file types.  Returns the number of retrieved items.
+     */
+    size_t EnumAllFileTypes(wxArrayString& mimetypes);
+

 };
 
 
 };
 
 


@@ -106,6 +124,7 @@ public:
 wxMimeTypesManager* wxTheMimeTypesManager;
 
 
 wxMimeTypesManager* wxTheMimeTypesManager;
 
 

+

 /**
     @class wxFileType
 
 /**
     @class wxFileType
 


@@ -152,7 +171,7 @@ wxMimeTypesManager* wxTheMimeTypesManager;
     such as the original file name or the charset (for the text documents).
     These parameters may be useful to the program used to open, edit, view or
     print the message, so, for example, an e-mail client program will have to
     such as the original file name or the charset (for the text documents).
     These parameters may be useful to the program used to open, edit, view or
     print the message, so, for example, an e-mail client program will have to

-    pass them to this program. Because wxFileType itself can not know about
+    pass them to this program. Because wxFileType itself cannot know about

     these parameters, it uses MessageParameters class to query them.
 
     The default implementation only requires the caller to provide the file name
     these parameters, it uses MessageParameters class to query them.
 
     The default implementation only requires the caller to provide the file name


@@ -221,6 +240,35 @@ private:
     wxFileType();
 
 public:
     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:
+        /// Trivial default 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.
     */
     /**
         Copy ctor.
     */


@@ -332,5 +380,151 @@ public:
     */
     bool GetPrintCommand(wxString* command,
                          const MessageParameters& params) const;
     */
     bool GetPrintCommand(wxString* command,
                          const MessageParameters& params) const;

+
+    /**
+       Returns the number of commands for this mime type, and fills the verbs
+       and commands arrays with the command information.
+     */
+    size_t GetAllCommands(wxArrayString *verbs, wxArrayString *commands,
+                          const wxFileType::MessageParameters& params) const;

 };
 
 };
 

+
+
+/**
+    Container of information about wxFileType.
+
+    This class simply stores information associated with the file type. It
+    doesn't do anything on its own and is used only to allow constructing
+    wxFileType from it (instead of specifying all the constituent pieces
+    separately) and also with wxMimeTypesManager::AddFallbacks().
+ */
+class wxFileTypeInfo
+{
+public:
+    /**
+        Default constructor creates an invalid file type info object.
+
+        Such invalid/empty object should be used to terminate the list of file
+        types passed to wxMimeTypesManager::AddFallbacks().
+     */
+    wxFileTypeInfo();
+
+    /**
+        Constructor specifying just the MIME type name.
+
+        Use the various setter methods below to fully initialize the object.
+
+        @since 2.9.2
+     */
+    wxFileTypeInfo(const wxString& mimeType);
+
+    /**
+        Constructor allowing to specify all the fields at once.
+
+        This is a vararg constructor taking an arbitrary number of extensions
+        after the first four required parameters. The list must be terminated
+        by @c wxNullPtr, notice that @c NULL can't be used here in portable
+        code (C++0x @c nullptr can be used as well if your compiler supports
+        it).
+     */
+    wxFileTypeInfo(const wxString& mimeType,
+                   const wxString& openCmd,
+                   const wxString& printCmd,
+                   const wxString& description,
+                   const wxString& extension,
+                   ...);
+    
+    /**
+       Constuctor using an array of string elements corresponding to the
+       parameters of the ctor above in the same order.
+    */
+    wxFileTypeInfo(const wxArrayString& sArray);
+
+    /**
+        Add another extension associated with this file type.
+
+        @since 2.9.2
+     */
+    void AddExtension(const wxString& ext);
+
+    /**
+        Set the file type description.
+
+        @since 2.9.2
+     */
+    void SetDescription(const wxString& description);
+
+    /**
+        Set the command to be used for opening files of this type.
+
+        @since 2.9.2
+     */
+    void SetOpenCommand(const wxString& command);
+
+    /**
+        Set the command to be used for printing files of this type.
+
+        @since 2.9.2
+     */
+    void SetPrintCommand(const wxString& command);
+
+    /**
+        Set the short description for the files of this type.
+
+        This is only used under MSW for some of the registry keys used for the
+        file type registration.
+     */
+    void SetShortDesc(const wxString& shortDesc);
+
+    /**
+       Set the icon information.
+    */
+    void SetIcon(const wxString& iconFile, int iconIndex = 0);
+
+    /**
+       Get the MIME type
+    */
+    const wxString& GetMimeType() const;
+    
+    /**
+       Get the open command
+    */
+    const wxString& GetOpenCommand() const;
+
+    /**
+       Get the print command
+    */
+    const wxString& GetPrintCommand() const;
+    
+    /**
+       Get the short description (only used under Win32 so far)
+    */
+    const wxString& GetShortDesc() const;
+    
+    /**
+       Get the long, user visible description
+    */
+    const wxString& GetDescription() const;
+    
+    /**
+       Get the array of all extensions
+    */
+    const wxArrayString& GetExtensions() const;
+
+    /**
+       Get the number of extensions.
+    */
+    size_t GetExtensionsCount() const;
+    
+    /**
+       Get the icon filename
+    */
+    const wxString& GetIconFile() const;
+
+    /**
+       Get the index of the icon within the icon file.
+    */
+    int GetIconIndex() const;
+
+};