Version: 3.0.4
wxFileTypeInfo Class Reference

#include <wx/mimetype.h>

Detailed Description

Container of information about wxFileType.

This class simply stores information associated with the file type. It doesn't do anything on its own and is used only to allow constructing wxFileType from it (instead of specifying all the constituent pieces separately) and also with wxMimeTypesManager::AddFallbacks().

Public Member Functions

 wxFileTypeInfo ()
 Default constructor creates an invalid file type info object. More...
 
 wxFileTypeInfo (const wxString &mimeType)
 Constructor specifying just the MIME type name. More...
 
 wxFileTypeInfo (const wxString &mimeType, const wxString &openCmd, const wxString &printCmd, const wxString &description, const wxString &extension,...)
 Constructor allowing to specify all the fields at once. More...
 
 wxFileTypeInfo (const wxArrayString &sArray)
 Constuctor using an array of string elements corresponding to the parameters of the ctor above in the same order. More...
 
void AddExtension (const wxString &ext)
 Add another extension associated with this file type. More...
 
void SetDescription (const wxString &description)
 Set the file type description. More...
 
void SetOpenCommand (const wxString &command)
 Set the command to be used for opening files of this type. More...
 
void SetPrintCommand (const wxString &command)
 Set the command to be used for printing files of this type. More...
 
void SetShortDesc (const wxString &shortDesc)
 Set the short description for the files of this type. More...
 
void SetIcon (const wxString &iconFile, int iconIndex=0)
 Set the icon information. More...
 
const wxStringGetMimeType () const
 Get the MIME type. More...
 
const wxStringGetOpenCommand () const
 Get the open command. More...
 
const wxStringGetPrintCommand () const
 Get the print command. More...
 
const wxStringGetShortDesc () const
 Get the short description (only used under Win32 so far) More...
 
const wxStringGetDescription () const
 Get the long, user visible description. More...
 
const wxArrayStringGetExtensions () const
 Get the array of all extensions. More...
 
size_t GetExtensionsCount () const
 Get the number of extensions. More...
 
const wxStringGetIconFile () const
 Get the icon filename. More...
 
int GetIconIndex () const
 Get the index of the icon within the icon file. More...
 

Constructor & Destructor Documentation

wxFileTypeInfo::wxFileTypeInfo ( )

Default constructor creates an invalid file type info object.

Such invalid/empty object should be used to terminate the list of file types passed to wxMimeTypesManager::AddFallbacks().

wxFileTypeInfo::wxFileTypeInfo ( const wxString mimeType)

Constructor specifying just the MIME type name.

Use the various setter methods below to fully initialize the object.

Since
2.9.2
wxFileTypeInfo::wxFileTypeInfo ( const wxString mimeType,
const wxString openCmd,
const wxString printCmd,
const wxString description,
const wxString extension,
  ... 
)

Constructor allowing to specify all the fields at once.

This is a vararg constructor taking an arbitrary number of extensions after the first four required parameters. The list must be terminated by wxNullPtr, notice that NULL can't be used here in portable code (C++0x nullptr can be used as well if your compiler supports it).

wxFileTypeInfo::wxFileTypeInfo ( const wxArrayString sArray)

Constuctor using an array of string elements corresponding to the parameters of the ctor above in the same order.

Member Function Documentation

void wxFileTypeInfo::AddExtension ( const wxString ext)

Add another extension associated with this file type.

Since
2.9.2
const wxString& wxFileTypeInfo::GetDescription ( ) const

Get the long, user visible description.

const wxArrayString& wxFileTypeInfo::GetExtensions ( ) const

Get the array of all extensions.

size_t wxFileTypeInfo::GetExtensionsCount ( ) const

Get the number of extensions.

const wxString& wxFileTypeInfo::GetIconFile ( ) const

Get the icon filename.

int wxFileTypeInfo::GetIconIndex ( ) const

Get the index of the icon within the icon file.

const wxString& wxFileTypeInfo::GetMimeType ( ) const

Get the MIME type.

const wxString& wxFileTypeInfo::GetOpenCommand ( ) const

Get the open command.

const wxString& wxFileTypeInfo::GetPrintCommand ( ) const

Get the print command.

const wxString& wxFileTypeInfo::GetShortDesc ( ) const

Get the short description (only used under Win32 so far)

void wxFileTypeInfo::SetDescription ( const wxString description)

Set the file type description.

Since
2.9.2
void wxFileTypeInfo::SetIcon ( const wxString iconFile,
int  iconIndex = 0 
)

Set the icon information.

void wxFileTypeInfo::SetOpenCommand ( const wxString command)

Set the command to be used for opening files of this type.

Since
2.9.2
void wxFileTypeInfo::SetPrintCommand ( const wxString command)

Set the command to be used for printing files of this type.

Since
2.9.2
void wxFileTypeInfo::SetShortDesc ( const wxString shortDesc)

Set the short description for the files of this type.

This is only used under MSW for some of the registry keys used for the file type registration.