X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..ec64d5ca7bbafd4f803b7a1cfbddb85a16c45d6e:/interface/mimetype.h diff --git a/interface/mimetype.h b/interface/mimetype.h index 70d72c0fcc..8e64ad2719 100644 --- a/interface/mimetype.h +++ b/interface/mimetype.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: mimetype.h -// Purpose: documentation for wxMimeTypesManager class +// Purpose: interface of wxMimeTypesManager // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -38,8 +38,7 @@ @library{wxbase} @category{misc} - @seealso - wxFileType + @see wxFileType */ class wxMimeTypesManager { @@ -67,7 +66,7 @@ public: NB: You won't normally need to use more than one wxMimeTypesManager object in a program. @ref ctor() wxMimeTypesManager - + @ref dtor() ~wxMimeTypesManager */ @@ -102,9 +101,9 @@ public: default ones which are loaded automatically) containing MIME information in either mailcap(5) or mime.types(5) format. ReadMailcap() - + ReadMimeTypes() - + AddFallbacks() */ @@ -126,7 +125,7 @@ public: If the function is successful, it returns a pointer to the wxFileType object which @b must be deleted by the caller, otherwise @NULL will be returned. GetFileTypeFromMimeType() - + GetFileTypeFromExtension() */ @@ -156,6 +155,7 @@ public: }; + /** @class wxFileType @wxheader{mimetype.h} @@ -192,8 +192,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxMimeTypesManager + @see wxMimeTypesManager */ class wxFileType { @@ -214,23 +213,23 @@ public: usage but may be also used by the application directly if, for example, you want to use some non-default command to open the file. The function replaces all occurrences of - + format specification - + with - + %s - + the full file name - + %t - + the MIME type - + %{param} - + the value of the parameter @e param - + using the MessageParameters object you pass to it. If there is no '%s' in the command string (and the string is not empty), it is assumed that the command reads the data on stdin and so the effect is the same @@ -294,7 +293,7 @@ public: /** With the first version of this method, if the @true is returned, the string pointed to by @a command is filled with the command which must be - executed (see wxExecute) in order to open the file of the + executed (see wxExecute()) in order to open the file of the given type. In this case, the name of the file as well as any other parameters is retrieved from MessageParameters() class. @@ -310,7 +309,7 @@ public: /** If the function returns @true, the string pointed to by @a command is filled - with the command which must be executed (see wxExecute) in + with the command which must be executed (see wxExecute()) in order to print the file of the given type. The name of the file is retrieved from MessageParameters() class. */ @@ -333,12 +332,13 @@ public: there are no other parameters. If you wish to supply additional parameters, you must derive your own class from MessageParameters and override GetParamValue() function, for example: - + Now you only need to create an object of this class and pass it to, for example, GetOpenCommand() like this: - + @b Windows: As only the file name is used by the program associated with the given extension anyhow (but no other message parameters), there is no need to ever derive from MessageParameters class for a Windows-only program. */ }; +