Clase wxImageHandler
Esta es la clase base para implementar la carga/guardado de archivos de imagen, y la creación de imágenes a partir de datos.
Jerarquía:
Se utiliza dentro de wxImage y normalmente no es vista por la aplicación.
Si se desea ampliar las capacidades de wxImage, derivar una clase de wxImageHandler y añadir el manejador utilizando wxImage::AddHandler en la inicialización de la aplicación.
Hay que tener en cuenta que todos los wxImageHandlers proporcionados por wxWidgets forman parte de la librería wxCore. Para más detalles acerca de los manejadores por defecto, por favor ver la sección Manejadores de imagen disponibles en la documentación de la clase wxImage.
Nota (Cuestión legal)
Este software se basa en parte en el trabajo del Independent JPEG Group. (Se aplica cuando wxWidgets está enlazado con soporte JPEG. wxJPEGHandler utiliza libjpeg creada por IJG).
Funciones miembro
wxImageHandler()
wxImageHandler::wxImageHandler()
Constructor por defecto.
En un constructor propio por defecto, inicializar los miembros m_name, m_extension y m_type.
~wxImageHandler()
virtual wxImageHandler::~wxImageHandler()
Destruye el objeto wxImageHandler.
CanRead()
bool wxImageHandler::CanRead(const wxString & filename)
Devuelve true si este manejador soporta el formato de imagen contenido en el fichero con el nombre dado.
Esta función no modifica la posición actual del flujo (porque restaura la posición original antes de regresar; sin embargo, esto requiere que el flujo sea buscable; ver wxStreamBase::IsSeekable).
CanRead()
bool wxImageHandler::CanRead(wxInputStream & stream)
Devuelve true si este manejador soporta el formato de imagen contenido en el stream dado.
Esta función no modifica la posición actual del flujo (porque restaura la posición original antes de regresar; sin embargo, esto requiere que el flujo sea buscable; ver wxStreamBase::IsSeekable).
DoCanRead()
virtual bool wxImageHandler::DoCanRead(wxInputStream & stream)
Llamada para comprobar si este manejador puede leer una imagen del flujo dado.
Nota: esta función puede cambiar la posición actual del flujo ya que CallDoCanRead() se encargará de restaurarla más tarde.
Implementado en wxXPMHandler, wxTIFFHandler, wxTGAHandler, wxPNMHandler, wxPNGHandler, wxPCXHandler, wxJPEGHandler, wxIFFHandler y wxGIFHandler.
DoGetImageCount()
virtual int wxImageHandler::DoGetImageCount(wxInputStream & stream)
Llamada para obtener el número de imágenes disponibles en un tipo de archivo multi-imagen, si es soportado.
Nota: esta función puede cambiar la posición actual del flujo ya que CallDoCanRead() se encargará de restaurarla más tarde.
Reimplementado en wxTIFFHandler y wxGIFHandler.
GetAltExtensions()
const wxArrayString& wxImageHandler::GetAltExtensions() const
Devuelve las otras extensiones de archivo asociadas con este manejador.
La extensión preferida para este manejador es devuelta por GetExtension().
GetExtension()
const wxString& wxImageHandler::GetExtension() const
Obtiene la extensión de archivo preferida asociada a este manejador.
GetImageCount()
int wxImageHandler::GetImageCount(wxInputStream & stream)
Si el archivo de imagen contiene más de una imagen y el gestor de imágenes es capaz de recuperarlas individualmente, esta función devolverá el número de imágenes disponibles.
Parámetros
- stream
- Flujo de entrada abierto para leer los datos de la imagen. Esta función no modifica la posición actual del flujo (ya que restaura la posición original antes de volver; sin embargo, esto requiere que el flujo sea buscable; ver wxStreamBase::IsSeekable).
Valor de retorno
Número de imágenes disponibles. Para la mayoría de los manejadores de imágenes, es 1 (las excepciones son los formatos TIFF e ICO, así como los GIF animados, para los que esta función devuelve el número de fotogramas de la animación).
GetLibraryVersionInfo()
static wxVersionInfo wxImageHandler::GetLibraryVersionInfo()
Recupera la información de la versión de la librería de imágenes utilizada por este manejador.
Este método no está presente en la clase wxImageHandler pero sí en algunas de las clases que derivan de ella, actualmente wxJPEGHandler, wxPNGHandler y wxTIFFHandler. Devuelve la información sobre la versión de la biblioteca de imágenes que se está utilizando para la implementación del manejador correspondiente.
GetMimeType()
const wxString& wxImageHandler::GetMimeType() const
Obtiene el tipo MIME asociado a este manejador.
GetName()
const wxString& wxImageHandler::GetName() const
Obtiene el nombre de este manejador.
GetType()
wxBitmapType wxImageHandler::GetType() const
Obtiene el tipo de imagen asociado a este manejador.
LoadFile()
virtual bool wxImageHandler::LoadFile( wxImage * image, wxInputStream & stream, bool verbose = true, int index = -1 )
Carga una imagen desde un flujo, poniendo los datos resultantes en image.
Si el archivo de imagen contiene más de una imagen y el gestor de imágenes es capaz de recuperarlas individualmente, index indica qué imagen leer del flujo.
Parámetros
- image
- Objeto imagen al que afecta esta operación.
- stream
- Flujo de entrada abierto para leer los datos de la imagen.
- verbose
- Si se establece en true, los errores notificados por el manejador de imágenes producirán wxLogMessages.
- index
- Índice de la imagen en el archivo (empezando por cero).
Valor de retorno
true si la operación tuvo éxito, false en caso contrario.
Implementado en wxXPMHandler, wxTIFFHandler, wxTGAHandler, wxPNMHandler, wxPNGHandler, wxPCXHandler, wxJPEGHandler, wxIFFHandler y wxGIFHandler.
SaveFile()
virtual bool wxImageHandler::SaveFile( wxImage * image, wxOutputStream & stream, bool verbose = true )
Guarda una imagen en el flujo de salida.
Parámetros
- image
- Objeto imagen al que afecta esta operación.
- stream
- Flujo de salida abierto para escribir los datos.
- verbose
- Si se establece a true, los errores reportados por el manejador de imagen producirán wxLogMessages.
Valor de retorno
true si la operación tuvo éxito, false en caso contrario.
Implementado en wxXPMHandler, wxTIFFHandler, wxTGAHandler, wxPNMHandler, wxPNGHandler, wxPCXHandler, wxJPEGHandler, wxIFFHandler y wxGIFHandler.
SetAltExtensions()
void wxImageHandler::SetAltExtensions(const wxArrayString & extensions)
Establece las extensiones de archivo alternativas asociadas a este manejador.
Parámetros
- extensions
- Matriz de extensiones de archivo.
SetExtension()
void wxImageHandler::SetExtension(const wxString & extension)
Establece la extensión de archivo preferida asociada a este manejador.
Parámetros
- extension
- Extensión de archivo sin el punto inicial.
SetMimeType()
void wxImageHandler::SetMimeType(const wxString & mimetype)
Establece el tipo MIME del manejador.
Parámetros
- mimetype
- Tipo MIME del manejador.
SetName()
void wxImageHandler::SetName(const wxString & name)
Establece el nombre del manejador.
Parámetros
- name
- Nombre del manejador.
SetType()
void wxImageHandler::SetType(wxBitmapType type)
Establece el tipo de mapa de bits para el manejador.
Parámetros
- type
- Tipo de mapa de bits.
Métodos y datos heredados
Esta clase hereda los métodos y datos miembro públicos y protegidos de wxObject.