|  |  |  | Libxklavier Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
XklConfigRec; XklConfigRec * xkl_config_rec_new (void); gboolean xkl_config_rec_activate (const XklConfigRec *data,XklEngine *engine); gboolean xkl_config_rec_get_from_server (XklConfigRec *data,XklEngine *engine); gboolean xkl_config_rec_get_from_backup (XklConfigRec *data,XklEngine *engine); gboolean xkl_config_rec_write_to_file (XklEngine *engine,const gchar *file_name,const XklConfigRec *data,const gboolean binary); gboolean xkl_config_rec_get_from_root_window_property (XklConfigRec *config_out,Atom rules_atom_name,gchar **rules_file_out,XklEngine *engine); gboolean xkl_config_rec_set_to_root_window_property (const XklConfigRec *config,Atom rules_atom_name,gchar *rules_file,XklEngine *engine); gboolean xkl_engine_backup_names_prop (XklEngine *engine); gboolean xkl_restore_names_prop (XklEngine *engine); void xkl_config_rec_reset (XklConfigRec *data); gboolean xkl_config_rec_equals (XklConfigRec *data1,XklConfigRec *data2);
XklConfigRec *      xkl_config_rec_new                  (void);
Create new XklConfigRec
| Returns : | new instance | 
gboolean xkl_config_rec_activate (const XklConfigRec *data,XklEngine *engine);
Activates some XKB configuration description. Can be NULL
| 
 | valid XKB configuration | 
| 
 | the engine | 
| Returns : | TRUE on success | 
gboolean xkl_config_rec_get_from_server (XklConfigRec *data,XklEngine *engine);
Loads the current XKB configuration (from X server)
| 
 | buffer for XKB configuration | 
| 
 | the engine | 
| Returns : | TRUE on success | 
gboolean xkl_config_rec_get_from_backup (XklConfigRec *data,XklEngine *engine);
Loads the current XKB configuration (from backup)
| 
 | buffer for XKB configuration | 
| 
 | the engine | 
| Returns : | TRUE on success | 
gboolean xkl_config_rec_write_to_file (XklEngine *engine,const gchar *file_name,const XklConfigRec *data,const gboolean binary);
Writes some XKB configuration into XKM/XKB/... file
| 
 | the engine | 
| 
 | name of the file to create | 
| 
 | valid XKB configuration description. Can be NULL | 
| 
 | flag indicating whether the output file should be binary | 
| Returns : | TRUE on success | 
gboolean xkl_config_rec_get_from_root_window_property (XklConfigRec *config_out,Atom rules_atom_name,gchar **rules_file_out,XklEngine *engine);
Gets the XKB configuration from any root window property
| 
 | buffer to hold the result | 
| 
 | atom name of the root window property to read | 
| 
 | pointer to hold the file name | 
| 
 | the engine | 
| Returns : | TRUE on success | 
gboolean xkl_config_rec_set_to_root_window_property (const XklConfigRec *config,Atom rules_atom_name,gchar *rules_file,XklEngine *engine);
Saves the XKB configuration into any root window property
| 
 | configuration to save | 
| 
 | atom name of the root window property to write | 
| 
 | rules file name | 
| 
 | the engine | 
| Returns : | TRUE on success | 
gboolean            xkl_engine_backup_names_prop        (XklEngine *engine);
Backups current XKB configuration into some property - if this property is not defined yet.
| 
 | the engine | 
| Returns : | TRUE on success | 
gboolean            xkl_restore_names_prop              (XklEngine *engine);
Restores XKB from the property saved by xkl_backup_names_prop
| 
 | the engine | 
| Returns : | TRUE on success | 
void                xkl_config_rec_reset                (XklConfigRec *data);
Resets the record (equal to Destroy and Init)
| 
 | record to reset | 
gboolean xkl_config_rec_equals (XklConfigRec *data1,XklConfigRec *data2);
Compares two records
| 
 | record to compare | 
| 
 | another record | 
| Returns : | TRUE if records are same |