fileconf.h

Clase wxFileConfig

wxFileConfig implementa la interfaz wxConfigBase para almacenar y recuperar información de configuración utilizando archivos de texto plano.

Jerarquía:

Jerarquía de la clase wxFileConfig

Los ficheros tienen un formato sencillo que recuerda a los ficheros INI de Windows con líneas de la forma "clave = valor" definiendo las claves y líneas de forma especial "[grupo]" indicando el inicio de cada grupo.

Esta clase se utiliza por defecto para wxConfigBase en plataformas Unix pero también puede utilizarse explícitamente si se desea utilizar ficheros y no el registro incluso bajo Windows.

Funciones miembro

wxFileConfig()

wxFileConfig::wxFileConfig( const wxString & appName = wxEmptyString, const wxString & vendorName = wxEmptyString, const wxString & localFilename = wxEmptyString, const wxString & globalFilename = wxEmptyString, long style = wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE, const wxMBConv & conv = wxConvAuto() )

Constructor que permite elegir los nombres de archivo a utilizar.

Si localFilename y/o globalFilename se especifican explícitamente, se utilizan como los nombres de los archivos de configuración del usuario y de todo el sistema (el último solo es leído por el programa, mientras que el primero es leído desde y escrito en). En caso contrario, el comportamiento depende del parámetro de estilo. Si incluye wxCONFIG_USE_LOCAL_FILE, entonces el nombre del fichero local se construye a partir de la información de los argumentos appName y vendorName de forma dependiente del sistema. Si wxCONFIG_USE_GLOBAL_FILE no se especifica en absoluto (y globalFilename está vacío) entonces el archivo de todo el sistema no se utiliza en absoluto. En caso contrario, su nombre y ruta se construyen de la forma apropiada para la plataforma actual a partir de los nombres de la aplicación y del proveedor.>

wxFileConfig()

wxFileConfig::wxFileConfig( wxInputStream & is, const wxMBConv & conv = wxConvAuto() )

Lee los datos de configuración del flujo especificado en lugar del archivo asociado, como es habitual.

DeleteAll()

virtual bool wxFileConfig::DeleteAll()

Elimina todo el objeto subyacente (archivo de disco, clave de registro, ...).

Principalmente para uso de la rutina de desinstalación.

Implementa wxConfigBase.

DeleteEntry()

virtual bool wxFileConfig::DeleteEntry( const wxString & key, bool bDeleteGroupIfEmpty = true )

Elimina la entrada especificada y el grupo al que pertenece si era la última clave en él y el segundo parámetro es true.

Implementa wxConfigBase.

DeleteGroup()

virtual bool wxFileConfig::DeleteGroup(const wxString & key)

Elimina el grupo (con todos los subgrupos).

Si la ruta actual está bajo el grupo que se elimina, se cambia a su componente más profundo aún existente. Por ejemplo, si la ruta actual es "/A/B/C/D" y se elimina el grupo C, la ruta pasa a ser "/A/B".

Implementa wxConfigBase.

DisableAutoSave()

void wxFileConfig::DisableAutoSave()

Evita que este objeto guarde datos en el archivo de disco cuando es destruido.

Por defecto, los cambios de este objeto solo se guardan permanentemente cuando se llama explícitamente a Flush() o cuando se destruye. Si se llama a este método, Flush() no se llamará automáticamente desde el destructor, lo que significa que cualquier cambio que no se haya vaciado explícitamente se perderá.

EnableAutoSave()

void wxFileConfig::EnableAutoSave()

Permite guardar los datos en el archivo de disco cuando se destruye este objeto.

Este es el comportamiento por defecto y esta función no necesita ser llamada explícitamente a menos que DisableAutoSave() haya sido llamada previamente.

Flush()

virtual bool wxFileConfig::Flush(bool bCurrentOnly = false)

Escribe permanentemente todos los cambios (de lo contrario, solo se escriben desde el destructor del objeto).

Implementa wxConfigBase.

GetFirstEntry()

virtual bool wxFileConfig::GetFirstEntry( wxString & str, long & index ) const

Obtiene la primera entrada.

Nota: En wxPerl este método no toma parámetros y devuelve una lista de 3 elementos (continue_flag, string, index_for_getnextentry).

Implementa wxConfigBase.

GetFirstGroup()

virtual bool wxFileConfig::GetFirstGroup( wxString & str, long & index ) const

Obtiene el primer grupo.

Nota: En wxPerl este método no toma parámetros y devuelve una lista de 3 elementos (continue_flag, string, index_for_getnextentry).

Implementa wxConfigBase.

GetGlobalFile()

static wxFileName wxFileConfig::GetGlobalFile(const wxString & basename)

Devuelve la ruta completa al fichero que sería utilizado por wxFileConfig como fichero global, de todo el sistema, si se construyera con basename como parámetro "global filename" en el constructor.

Hay que tener en cuenta que esta función no se puede utilizar si basename ya es un nombre de ruta completo.

GetGlobalFileName()

static wxString wxFileConfig::GetGlobalFileName(const wxString & szFile)

Obtiene el nombre del fichero global.

GetLocalFile()

static wxFileName wxFileConfig::GetLocalFile( const wxString & basename, int style = 0 )

Devuelve la ruta completa al fichero que sería utilizado por wxFileConfig como fichero local, específico del usuario, si se construyera con basename como parámetro "local filename" en el constructor.

style tiene el mismo significado que en el constructor de wxConfigBase y puede contener cualquier combinación de estilos, pero esta función solo examina el bit wxCONFIG_USE_SUBDIR.

Hay que tener en cuenta que esta función no se puede utilizar si basename ya es un nombre de ruta completo.

GetLocalFileName()

static wxString wxFileConfig::GetLocalFileName( const wxString & szFile, int style = 0 )

Obtiene el nombre del fichero local.

GetNextEntry()

virtual bool wxFileConfig::GetNextEntry( wxString & str, long & index ) const

Obtiene la siguiente entrada.

Nota: En wxPerl este método sólo toma el parámetro index y devuelve una lista de 3 elementos (continue_flag, string, index_for_getnextentry).

Implementa wxConfigBase.

GetNextGroup()

virtual bool wxFileConfig::GetNextGroup( wxString & str, long & index ) const

Obtiene el siguiente grupo.

Nota: En wxPerl este método sólo toma el parámetro index y devuelve una lista de 3 elementos (continue_flag, string, index_for_getnextentry).

Implementa wxConfigBase.

GetNumberOfEntries()

virtual size_t wxFileConfig::GetNumberOfEntries(bool bRecursive = false) const

Obtiene el número de entradas del grupo actual.

Implementa wxConfigBase.

GetNumberOfGroups()

virtual size_t wxFileConfig::GetNumberOfGroups(bool bRecursive = false) const

Obtiene el número de entradas/subgrupos del grupo actual, con o sin sus subgrupos.

Implementa wxConfigBase.

GetPath()

virtual const wxString& wxFileConfig::GetPath() const

Recupera la ruta actual (siempre como ruta absoluta).

Implementa wxConfigBase.

HasEntry()

virtual bool wxFileConfig::HasEntry(const wxString & strName) const

Devuelve true si la entrada con este nombre existe.

Implementa wxConfigBase.

HasGroup()

virtual bool wxFileConfig::HasGroup(const wxString & strName) const

Devuelve true si el grupo con este nombre existe.

Implementa wxConfigBase.

RenameEntry()

virtual bool wxFileConfig::RenameEntry( const wxString & oldName, const wxString & newName )

Cambia el nombre de una entrada del grupo actual.

Los nombres de las entradas (tanto la antigua como la nueva) no deben contener barras invertidas, es decir, esta función solo acepta nombres simples y no rutas arbitrarias.

Valor de retorno

false si oldName no existe o si newName ya existe.

Implementa wxConfigBase.

RenameGroup()

virtual bool wxFileConfig::RenameGroup( const wxString & oldName, const wxString & newName )

Renombra un subgrupo del grupo actual.

Los nombres de los subgrupos (tanto el antiguo como el nuevo) no deben contener barras invertidas, es decir, esta función solo acepta nombres simples y no rutas arbitrarias.

Valor de retorno

false si oldName no existe o si newName ya existe.

Implementa wxConfigBase.

Save()

virtual bool wxFileConfig::Save( wxOutputStream & os, const wxMBConv & conv = wxConvAuto() )

Guarda todos los datos de configuración en el flujo dado, devuelve true si los datos se han guardado correctamente o false en caso de error.

Obsérvese la interacción de esta función con la "bandera sucia" interna: los datos se guardan incondicionalmente, es decir, incluso si el objeto no está sucio. Sin embargo, después de guardarlo con éxito, el indicador de suciedad se restablece, por lo que no se escribirá ningún cambio en el archivo al que está asociado este objeto hasta que vuelva a cambiar su contenido.

SetPath()

virtual void wxFileConfig::SetPath(const wxString & strPath)

Establece la ruta actual: si el primer carácter es '/', se trata de la ruta absoluta, de lo contrario es una ruta relativa.

Se admite '..'. Si strPath no existe, se crea.

SetUmask()

void wxFileConfig::SetUmask(int mode)

Permite establecer el modo que se utilizará para la creación del fichero de configuración.

Por ejemplo, para crear un fichero config que no sea legible por otros usuarios (útil si almacena alguna información sensible, como contraseñas), se puede utilizar SetUmask(0077).

Esta función no hace nada en plataformas que no sean Unix.

Métodos y datos heredados

Esta clase hereda los métodos y datos miembro públicos y protegidos de wxObject y wxConfigBase