]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/filetype.tex
cross-reference types in the generated docs (patch 1038083)
[wxWidgets.git] / docs / latex / wx / filetype.tex
index 30d87dd9418f68e55232f1a72fbdd4dec2c23bb8..9cbeb4f35a7585fc3e3fadc5c3ec62f4a12bddd5 100644 (file)
@@ -152,13 +152,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 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).
+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.
+
+{\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