X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..c229e50dc773306e1c2b47056ae625ca495c35ee:/docs/latex/wx/filetype.tex diff --git a/docs/latex/wx/filetype.tex b/docs/latex/wx/filetype.tex index be2b621f19..2327029e2d 100644 --- a/docs/latex/wx/filetype.tex +++ b/docs/latex/wx/filetype.tex @@ -1,6 +1,6 @@ \section{\class{wxFileType}}\label{wxfiletype} -This class holds information about a given "file type". File type is the same as +This class holds information about a given {\it file type}. File type is the same as MIME type under Unix, but under Windows it corresponds more to an extension than to MIME type (in fact, several extensions may correspond to a file type). This object may be created in several different ways: the program might know the file @@ -13,14 +13,14 @@ will be returned if the corresponding information couldn't be found. The objects of this class are never created by the application code but are returned by \helpref{wxMimeTypesManager::GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype} and \helpref{wxMimeTypesManager::GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension} methods. -But it's your responsability to delete the returned pointer when you're done +But it is your responsibility to delete the returned pointer when you're done with it! % TODO describe MIME types better than this... -A brief remainder about what the MIME types are (see the RFC 1341 for more -information): basicly, it is just a pair category/type (for example, -"text/plain") where the category is a basic indication of what a file is -(examples of categories are "application", "image", "text", "binary"...) and +A brief reminder about what the MIME types are (see the RFC 1341 for more +information): basically, it is just a pair category/type (for example, +"text/plain") where the category is a basic indication of what a file is. +Examples of categories are "application", "image", "text", "binary", and type is a precise definition of the document format: "plain" in the example above means just ASCII text without any formatting, while "text/html" is the HTML document source. @@ -31,7 +31,7 @@ typically correspond to the extension ".txt", but may as well be associated with \wxheading{Derived from} -No base class. +None \wxheading{Include files} @@ -125,6 +125,16 @@ The destructor of this class is not virtual, so it should not be derived from. If the function returns TRUE, the string pointed to by {\it mimeType} is filled with full MIME type specification for this file type: for example, "text/plain". +\membersection{wxFileType::GetMimeTypes}\label{wxfiletypegetmimetypes} + +\func{bool}{GetMimeType}{\param{wxArrayString\&}{ mimeTypes}} + +Same as \helpref{GetMimeType}{wxfiletypegetmimetype} but returns array of MIME +types. This array will contain only one item in most cases but sometimes, +notably under Unix with KDE, may contain more MIME types. This happens when +one file extension is mapped to different MIME types by KDE, mailcap and +mime.types. + \membersection{wxFileType::GetExtensions}\label{wxfiletypegetextensions} \func{bool}{GetExtensions}{\param{wxArrayString\&}{ extensions}} @@ -147,7 +157,9 @@ function in the first place. If the function returns TRUE, the icon associated with this file type will be created and assigned to the {\it icon} parameter. -{\bf Unix:} This function always returns FALSE under Unix. +{\bf Unix:} MIME manager gathers information about icons from GNOME +and KDE settings and thus GetIcon's success depends on availability +of these desktop environments. \membersection{wxFileType::GetDescription}\label{wxfiletypegetdescription} @@ -183,7 +195,7 @@ This function is primarly intended for GetOpenCommand and GetPrintCommand 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 occurences of +The function replaces all occurrences of \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt