X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5c5428f9132822d5d39b02c46dd89464adff9f1f..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/filetype.tex diff --git a/docs/latex/wx/filetype.tex b/docs/latex/wx/filetype.tex index 30d87dd941..58cc65b403 100644 --- a/docs/latex/wx/filetype.tex +++ b/docs/latex/wx/filetype.tex @@ -37,6 +37,10 @@ None +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxMimeTypesManager}{wxmimetypesmanager} @@ -90,7 +94,7 @@ Now you only need to create an object of this class and pass it to, for example, \begin{verbatim} wxString command; if ( filetype->GetOpenCommand(&command, - MailMessageParamaters("foo.txt", "text/plain")) ) + MailMessageParameters("foo.txt", "text/plain")) ) { // the full command for opening the text documents is in 'command' // (it might be "notepad foo.txt" under Windows or "cat foo.txt" under Unix) @@ -152,13 +156,16 @@ function in the first place. \membersection{wxFileType::GetIcon}\label{wxfiletypegeticon} -\func{bool}{GetIcon}{\param{wxIcon*}{ icon}, \param{wxString*}{ iconFile = NULL}, \param{int*}{ iconIndex = NULL}, \param{int}{ iconSize = wxICON\_LARGE}} +\func{bool}{GetIcon}{\param{wxIconLocation *}{ iconLoc}} + +If the function returns {\tt true}, the {\tt iconLoc} is filled with the +location of the icon for this MIME type. A \helpref{wxIcon}{wxicon} may be +created from {\it iconLoc} later. + +{\bf Windows:} The function returns the icon shown by Explorer for the files of +the specified type. -If the function returns {\tt TRUE}, the icon associated with this file type will be -created and assigned to the {\it icon} parameter. {\it iconFile} is assigned the file name -that contains the icon and {\it iconIndex} is assigned the index of the icon -(windows and unix only). A 32x32 icon is assigned if {\it iconSize} is wxICON\_LARGE -and a 16x16 icon is assigned if {\it iconSize} is wxICON\_SMALL (windows only). +{\bf Mac:} This function is not implemented and always returns {\tt false}. {\bf Unix:} MIME manager gathers information about icons from GNOME and KDE settings and thus GetIcon's success depends on availability @@ -187,7 +194,7 @@ class. In the second case, only the filename is specified and the command to be used to open this kind of file is returned directly. An empty string is returned to -indicate that an error occured (typically meaning that there is no standard way +indicate that an error occurred (typically meaning that there is no standard way to open this kind of files). \membersection{wxFileType::GetPrintCommand}\label{wxfiletypegetprintcommand} @@ -205,7 +212,7 @@ retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class. This function is primarily 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. +to use some non-default command to open the file. The function replaces all occurrences of