X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b813b73cd79cfb4d275e9628811f379e8c5ee39..f6840be66eb772c08f0cbb43de677509d5d132bb:/include/wx/mimetype.h diff --git a/include/wx/mimetype.h b/include/wx/mimetype.h index 0f5b78819b..b398d8c974 100644 --- a/include/wx/mimetype.h +++ b/include/wx/mimetype.h @@ -7,13 +7,13 @@ // Created: 23.09.98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license (part of wxExtra library) +// Licence: wxWindows licence (part of wxExtra library) ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_MIMETYPE_H_ #define _WX_MIMETYPE_H_ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "mimetypebase.h" #endif // __GNUG__ @@ -23,14 +23,16 @@ #include "wx/defs.h" +#if wxUSE_MIMETYPE + // the things we really need #include "wx/string.h" #include "wx/dynarray.h" // fwd decls -class WXDLLEXPORT wxIcon; -class WXDLLEXPORT wxFileTypeImpl; -class WXDLLEXPORT wxMimeTypesManagerImpl; +class WXDLLIMPEXP_BASE wxIconLocation; +class WXDLLIMPEXP_BASE wxFileTypeImpl; +class WXDLLIMPEXP_BASE wxMimeTypesManagerImpl; // these constants define the MIME informations source under UNIX and are used // by wxMimeTypesManager::Initialize() @@ -47,7 +49,7 @@ enum wxMailcapStyle /* TODO: would it be more convenient to have this class? -class WXDLLEXPORT wxMimeType : public wxString +class WXDLLIMPEXP_BASE wxMimeType : public wxString { public: // all string ctors here @@ -74,15 +76,15 @@ public: // This class is used with wxMimeTypesManager::AddFallbacks() and Associate() // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxFileTypeInfo +class WXDLLIMPEXP_BASE wxFileTypeInfo { public: // ctors // a normal item - wxFileTypeInfo(const char *mimeType, - const char *openCmd, - const char *printCmd, - const char *desc, + wxFileTypeInfo(const wxChar *mimeType, + const wxChar *openCmd, + const wxChar *printCmd, + const wxChar *desc, // the other parameters form a NULL terminated list of // extensions ...); @@ -96,7 +98,7 @@ public: wxFileTypeInfo() { } // test if this object can be used - bool IsValid() const { return !m_mimeType.IsEmpty(); } + bool IsValid() const { return !m_mimeType.empty(); } // setters // set the icon info @@ -147,7 +149,8 @@ private: #endif // 0 }; -WX_DECLARE_EXPORTED_OBJARRAY(wxFileTypeInfo, wxArrayFileTypeInfo); +WX_DECLARE_USER_EXPORTED_OBJARRAY(wxFileTypeInfo, wxArrayFileTypeInfo, + WXDLLIMPEXP_BASE); // ---------------------------------------------------------------------------- // wxFileType: gives access to all information about the files of given type. @@ -160,9 +163,9 @@ WX_DECLARE_EXPORTED_OBJARRAY(wxFileTypeInfo, wxArrayFileTypeInfo); // the accessors *must* be checked! // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxFileType +class WXDLLIMPEXP_BASE wxFileType { -friend class WXDLLEXPORT wxMimeTypesManagerImpl; // it has access to m_impl +friend class WXDLLIMPEXP_BASE wxMimeTypesManagerImpl; // it has access to m_impl public: // An object of this class must be passed to Get{Open|Print}Command. The @@ -174,7 +177,8 @@ public: public: // ctors MessageParameters() { } - MessageParameters(const wxString& filename, const wxString& mimetype) + MessageParameters(const wxString& filename, + const wxString& mimetype = wxEmptyString) : m_filename(filename), m_mimetype(mimetype) { } // accessors (called by GetOpenCommand) @@ -206,12 +210,10 @@ public: // fill passed in array with all extensions associated with this file // type bool GetExtensions(wxArrayString& extensions); - // get the icon corresponding to this file type, the name of the file - // where the icon resides is return in iconfile if !NULL and its index - // in this file (Win-only) is in iconIndex - bool GetIcon(wxIcon *icon, - wxString *iconFile = NULL, - int *iconIndex = NULL) const; + // get the icon corresponding to this file type and of the given size + bool GetIcon(wxIconLocation *iconloc) const; + bool GetIcon(wxIconLocation *iconloc, + const MessageParameters& params) const; // get a brief file type description ("*.txt" => "text document") bool GetDescription(wxString *desc) const; @@ -219,6 +221,9 @@ public: // get the command to execute the file of given type bool GetOpenCommand(wxString *openCmd, const MessageParameters& params) const; + // a simpler to use version of GetOpenCommand() -- it only takes the + // filename and returns an empty string on failure + wxString GetOpenCommand(const wxString& filename) const; // get the command to print the file of given type bool GetPrintCommand(wxString *printCmd, const MessageParameters& params) const; @@ -229,9 +234,9 @@ public: const wxFileType::MessageParameters& params) const; // set an arbitrary command, ask confirmation if it already exists and - // overwriteprompt is TRUE + // overwriteprompt is true bool SetCommand(const wxString& cmd, const wxString& verb, - bool overwriteprompt = TRUE); + bool overwriteprompt = true); bool SetDefaultIcon(const wxString& cmd = wxEmptyString, int index = 0); @@ -276,7 +281,7 @@ private: // given type) about them. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMimeTypesManager +class WXDLLIMPEXP_BASE wxMimeTypesManager { public: // static helper functions @@ -285,7 +290,7 @@ public: // check if the given MIME type is the same as the other one: the // second argument may contain wildcards ('*'), but not the first. If // the types are equal or if the mimeType matches wildcard the function - // returns TRUE, otherwise it returns FALSE + // returns true, otherwise it returns false static bool IsOfType(const wxString& mimeType, const wxString& wildcard); // ctor @@ -299,7 +304,7 @@ public: // // use the extraDir parameter if you want to look for files in another // directory - void Initialize(int mailcapStyle = wxMAILCAP_STANDARD, + void Initialize(int mailcapStyle = wxMAILCAP_ALL, const wxString& extraDir = wxEmptyString); // and this function clears all the data from the manager @@ -314,7 +319,7 @@ public: // get file type from MIME type (in format /) wxFileType *GetFileTypeFromMimeType(const wxString& mimeType); - // other operations: return TRUE if there were no errors or FALSE if there + // other operations: return true if there were no errors or false if there // were some unreckognized entries (the good entries are always read anyhow) // // FIXME: These ought to be private ?? @@ -322,12 +327,12 @@ public: // read in additional file (the standard ones are read automatically) // in mailcap format (see mimetype.cpp for description) // - // 'fallback' parameter may be set to TRUE to avoid overriding the + // 'fallback' parameter may be set to true to avoid overriding the // settings from other, previously parsed, files by this one: normally, // the files read most recently would override the older files, but with - // fallback == TRUE this won't happen + // fallback == true this won't happen - bool ReadMailcap(const wxString& filename, bool fallback = FALSE); + bool ReadMailcap(const wxString& filename, bool fallback = false); // read in additional file in mime.types format bool ReadMimeTypes(const wxString& filename); @@ -338,7 +343,7 @@ public: // these functions can be used to provide default values for some of the // MIME types inside the program itself (you may also use - // ReadMailcap(filenameWithDefaultTypes, TRUE /* use as fallback */) to + // ReadMailcap(filenameWithDefaultTypes, true /* use as fallback */) to // achieve the same goal, but this requires having this info in a file). // // The filetypes array should be terminated by either NULL entry or an @@ -382,8 +387,10 @@ private: // global variables // ---------------------------------------------------------------------------- -// the default mime manager for wxWindows programs -WXDLLEXPORT_DATA(extern wxMimeTypesManager *) wxTheMimeTypesManager; +// the default mime manager for wxWidgets programs +extern WXDLLIMPEXP_DATA_BASE(wxMimeTypesManager *) wxTheMimeTypesManager; + +#endif // wxUSE_MIMETYPE #endif //_WX_MIMETYPE_H_