docs/latex/wx/filetype.tex

   1 \section{\class{wxFileType}}\label{wxfiletype}
   2
   3 This class holds information about a given {\it file type}. File type is the same as
   4 MIME type under Unix, but under Windows it corresponds more to an extension than
   5 to MIME type (in fact, several extensions may correspond to a file type). This
   6 object may be created in several different ways: the program might know the file
   7 extension and wish to find out the corresponding MIME type or, conversely, it
   8 might want to find the right extension for the file to which it writes the
   9 contents of given MIME type. Depending on how it was created some fields may be
  10 unknown so the return value of all the accessors {\bf must} be checked: {\tt false}
  11 will be returned if the corresponding information couldn't be found.
  12
  13 The objects of this class are never created by the application code but are
  14 returned by \helpref{wxMimeTypesManager::GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype} and
  15 \helpref{wxMimeTypesManager::GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension} methods.
  16 But it is your responsibility to delete the returned pointer when you're done
  17 with it!
  18
  19 % TODO describe MIME types better than this...
  20 A brief reminder about what the MIME types are (see the RFC 1341 for more
  21 information): basically, it is just a pair category/type (for example,
  22 "text/plain") where the category is a basic indication of what a file is.
  23 Examples of categories are "application", "image", "text", "binary", and
  24 type is a precise definition of the document format: "plain" in the example
  25 above means just ASCII text without any formatting, while "text/html" is the
  26 HTML document source.
  27
  28 A MIME type may have one or more associated extensions: "text/plain" will
  29 typically correspond to the extension ".txt", but may as well be associated with
  30 ".ini" or ".conf".
  31
  32 \wxheading{Derived from}
  33
  34 None
  35
  36 \wxheading{Include files}
  37
  38 <wx/mimetype.h>
  39
  40 \wxheading{See also}
  41
  42 \helpref{wxMimeTypesManager}{wxmimetypesmanager}
  43
  44 \latexignore{\rtfignore{\wxheading{Members}}}
  45
  46 \membersection{MessageParameters class}\label{wxfiletypemessageparameters}
  47
  48 One of the most common usages of MIME is to encode an e-mail message. The MIME
  49 type of the encoded message is an example of a {\it message parameter}. These
  50 parameters are found in the message headers ("Content-XXX"). At the very least,
  51 they must specify the MIME type and the version of MIME used, but almost always
  52 they provide additional information about the message such as the original file
  53 name or the charset (for the text documents).
  54
  55 These parameters may be useful to the program used to open, edit, view or print
  56 the message, so, for example, an e-mail client program will have to pass them to
  57 this program. Because wxFileType itself can not know about these parameters,
  58 it uses MessageParameters class to query them. The default implementation only
  59 requires the caller to provide the file name (always used by the program to be
  60 called - it must know which file to open) and the MIME type and supposes that
  61 there are no other parameters. If you wish to supply additional parameters, you
  62 must derive your own class from MessageParameters and override GetParamValue()
  63 function, for example:
  64
  65 \begin{verbatim}
  66 // provide the message parameters for the MIME type manager
  67 class MailMessageParameters : public wxFileType::MessageParameters
  68 {
  69 public:
  70    MailMessageParameters(const wxString& filename,
  71                          const wxString& mimetype)
  72       : wxFileType::MessageParameters(filename, mimetype)
  73    {
  74    }
  75
  76    virtual wxString GetParamValue(const wxString& name) const
  77    {
  78        // parameter names are not case-sensitive
  79        if ( name.CmpNoCase("charset") == 0 )
  80            return "US-ASCII";
  81        else
  82            return wxFileType::MessageParameters::GetParamValue(name);
  83    }
  84 };
  85 \end{verbatim}
  86
  87 Now you only need to create an object of this class and pass it to, for example,
  88 \rtfsp\helpref{GetOpenCommand}{wxfiletypegetopencommand} like this:
  89
  90 \begin{verbatim}
  91 wxString command;
  92 if ( filetype->GetOpenCommand(&command,
  93                               MailMessageParamaters("foo.txt", "text/plain")) )
  94 {
  95     // the full command for opening the text documents is in 'command'
  96     // (it might be "notepad foo.txt" under Windows or "cat foo.txt" under Unix)
  97 }
  98 else
  99 {
 100     // we don't know how to handle such files...
 101 }
 102 \end{verbatim}
 103
 104 {\bf Windows:} As only the file name is used by the program associated with the
 105 given extension anyhow (but no other message parameters), there is no need to
 106 ever derive from MessageParameters class for a Windows-only program.
 107
 108 \membersection{wxFileType::wxFileType}\label{wxfiletypewxfiletype}
 109
 110 \func{}{wxFileType}{\void}
 111
 112 The default constructor is private because you should never create objects of
 113 this type: they are only returned by \helpref{wxMimeTypesManager}{wxmimetypesmanager} methods.
 114
 115 \membersection{wxFileType::\destruct{wxFileType}}\label{wxfiletypedtor}
 116
 117 \func{}{\destruct{wxFileType}}{\void}
 118
 119 The destructor of this class is not virtual, so it should not be derived from.
 120
 121 \membersection{wxFileType::GetMimeType}\label{wxfiletypegetmimetype}
 122
 123 \func{bool}{GetMimeType}{\param{wxString*}{ mimeType}}
 124
 125 If the function returns {\tt true}, the string pointed to by {\it mimeType} is filled
 126 with full MIME type specification for this file type: for example, "text/plain".
 127
 128 \membersection{wxFileType::GetMimeTypes}\label{wxfiletypegetmimetypes}
 129
 130 \func{bool}{GetMimeType}{\param{wxArrayString\&}{ mimeTypes}}
 131
 132 Same as \helpref{GetMimeType}{wxfiletypegetmimetype} but returns array of MIME
 133 types. This array will contain only one item in most cases but sometimes,
 134 notably under Unix with KDE, may contain more MIME types. This happens when
 135 one file extension is mapped to different MIME types by KDE, mailcap and
 136 mime.types.
 137
 138 \membersection{wxFileType::GetExtensions}\label{wxfiletypegetextensions}
 139
 140 \func{bool}{GetExtensions}{\param{wxArrayString\&}{ extensions}}
 141
 142 If the function returns {\tt true}, the array {\it extensions} is filled
 143 with all extensions associated with this file type: for example, it may
 144 contain the following two elements for the MIME type "text/html" (notice the
 145 absence of the leading dot): "html" and "htm".
 146
 147 {\bf Windows:} This function is currently not implemented: there is no
 148 (efficient) way to retrieve associated extensions from the given MIME type on
 149 this platform, so it will only return {\tt true} if the wxFileType object was created
 150 by \helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension}
 151 function in the first place.
 152
 153 \membersection{wxFileType::GetIcon}\label{wxfiletypegeticon}
 154
 155 \func{bool}{GetIcon}{\param{wxIcon*}{ icon}, \param{wxString*}{ iconFile = NULL}, \param{int*}{ iconIndex = NULL}, \param{int}{ iconSize = wxICON\_LARGE}}
 156
 157 If the function returns {\tt TRUE}, the icon associated with this file type will be
 158 created and assigned to the {\it icon} parameter. {\it iconFile} is assigned the file name
 159 that contains the icon and {\it iconIndex} is assigned the index of the icon
 160 (windows and unix only). A 32x32 icon is assigned if {\it iconSize} is wxICON\_LARGE
 161 and a 16x16 icon is assigned if {\it iconSize} is wxICON\_SMALL (windows only).
 162
 163 {\bf Unix:} MIME manager gathers information about icons from GNOME
 164 and KDE settings and thus GetIcon's success depends on availability
 165 of these desktop environments.
 166
 167 \membersection{wxFileType::GetDescription}\label{wxfiletypegetdescription}
 168
 169 \func{bool}{GetDescription}{\param{wxString*}{ desc}}
 170
 171 If the function returns {\tt true}, the string pointed to by {\it desc} is filled
 172 with a brief description for this file type: for example, "text document" for
 173 the "text/plain" MIME type.
 174
 175 \membersection{wxFileType::GetOpenCommand}\label{wxfiletypegetopencommand}
 176
 177 \func{bool}{GetOpenCommand}{\param{wxString*}{ command}, \param{MessageParameters\&}{ params}}
 178
 179 \func{wxString}{GetOpenCommand}{\param{const wxString\&}{ filename}}
 180
 181 With the first version of this method, if the {\tt true} is returned, the
 182 string pointed to by {\it command} is filled with the command which must be
 183 executed (see \helpref{wxExecute}{wxexecute}) in order to open the file of the
 184 given type. In this case, the name of the file as well as any other parameters
 185 is retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters}
 186 class.
 187
 188 In the second case, only the filename is specified and the command to be used
 189 to open this kind of file is returned directly. An empty string is returned to
 190 indicate that an error occured (typically meaning that there is no standard way
 191 to open this kind of files).
 192
 193 \membersection{wxFileType::GetPrintCommand}\label{wxfiletypegetprintcommand}
 194
 195 \func{bool}{GetPrintCommand}{\param{wxString*}{ command},\param{MessageParameters\&}{ params}}
 196
 197 If the function returns {\tt true}, the string pointed to by {\it command} is filled
 198 with the command which must be executed (see \helpref{wxExecute}{wxexecute}) in
 199 order to print the file of the given type. The name of the file is
 200 retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class.
 201
 202 \membersection{wxFileType::ExpandCommand}\label{wxfiletypeexpandcommand}
 203
 204 \func{static wxString}{ExpandCommand}{\param{const wxString\&}{ command}, \param{MessageParameters\&}{ params}}
 205
 206 This function is primarily intended for GetOpenCommand and GetPrintCommand
 207 usage but may be also used by the application directly if, for example, you want
 208 to use some non default command to open the file.
 209
 210 The function replaces all occurrences of
 211
 212 \twocolwidtha{7cm}
 213 \begin{twocollist}\itemsep=0pt
 214 \twocolitem{format specification}{with}
 215 \twocolitem{\%s}{the full file name}
 216 \twocolitem{\%t}{the MIME type}
 217 \twocolitem{\%\{param\}}{the value of the parameter {\it param}}
 218 \end{twocollist}
 219
 220 using the MessageParameters object you pass to it.
 221
 222 If there is no '\%s' in the command string (and the string is not empty), it is
 223 assumed that the command reads the data on stdin and so the effect is the same
 224 as "< \%s" were appended to the string.
 225
 226 Unlike all other functions of this class, there is no error return for this
 227 function.
 228