openldev/openldev-settings/openldev-settings.h File Reference

EnvironmentSettings. More...

#include <gconf/gconf-client.h>
#include <cstdlib>
#include <glib.h>
#include <iostream>
#include <fstream>
#include <vector>

Data Structures

struct  EnvironmentSettings
 General settings defined by the user's preferences. More...

Functions

EnvironmentSettingsopenldev_environment_settings_new ()
void openldev_environment_set_auto_indent (EnvironmentSettings *settings, gboolean value)
void openldev_environment_set_auto_load (EnvironmentSettings *settings, gboolean value)
void openldev_environment_set_brackets (EnvironmentSettings *settings, gboolean value)
void openldev_environment_set_line_numbers (EnvironmentSettings *settings, gboolean value)
void openldev_environment_set_replace_tabs (EnvironmentSettings *settings, gboolean value)
void openldev_environment_set_right_margin (EnvironmentSettings *settings, gboolean value)
void openldev_environment_set_wrap (EnvironmentSettings *settings, gboolean value)
void openldev_environment_set_wrap_split (EnvironmentSettings *settings, gboolean value)
void openldev_environment_set_auto_save (EnvironmentSettings *settings, int value)
void openldev_environment_set_sidebar_width (EnvironmentSettings *settings, int value)
void openldev_environment_set_height (EnvironmentSettings *settings, int value)
void openldev_environment_set_outputmanager_height (EnvironmentSettings *settings, int value)
void openldev_environment_set_tab_size (EnvironmentSettings *settings, int value)
void openldev_environment_set_undo (EnvironmentSettings *settings, int value)
void openldev_environment_set_width (EnvironmentSettings *settings, int value)
void openldev_environment_set_error (EnvironmentSettings *settings, const char *value)
void openldev_environment_set_font_face (EnvironmentSettings *settings, const char *value)
void openldev_environment_set_font_size (EnvironmentSettings *settings, const char *value)
void openldev_environment_set_last_project (EnvironmentSettings *settings, const char *value)
void openldev_environment_set_warning (EnvironmentSettings *settings, const char *value)
void openldev_environment_add_recent_file (EnvironmentSettings *settings, const char *file)
const char * openldev_environment_get_recent_short (EnvironmentSettings *settings, int id)
gboolean openldev_environment_get_plugin (EnvironmentSettings *settings, const char *plugin)
void openldev_environment_remove_plugin (EnvironmentSettings *settings, const char *plugin)
void openldev_environment_add_plugin (EnvironmentSettings *settings, const char *plugin)


Detailed Description


Function Documentation

void openldev_environment_add_plugin EnvironmentSettings settings,
const char *  plugin
 

Add a plugin to the list of enabled. The changes will be saved to GConf so it can be enabled in the future.

Parameters:
settings A non-NULL EnvironmentSettings object.
plugin A short plugin name.

void openldev_environment_add_recent_file EnvironmentSettings settings,
const char *  file
 

Add a file that was just opened to the recent files list. If there are 5 files already on the list, the last one will be deleted.

Parameters:
settings A non-NULL EnvironmentSettings object.
file The full path of a file that is currently opened.

gboolean openldev_environment_get_plugin EnvironmentSettings settings,
const char *  plugin
 

Check whether a plugin is currently enabled. You must pass the short name of the plugin, not the full file name.

Parameters:
settings A non-NULL EnvironmentSettings object.
plugin A short plugin name.
Returns:
TRUE if the plugin is enabled.

const char* openldev_environment_get_recent_short EnvironmentSettings settings,
int  id
 

Get the short file name of a plugin located at position id. This helps when trying to make a menu list of recent files.

Parameters:
settings A non-NULL EnvironmentSettings object.
id The id of the recent file to obtain, from 0 to 4.
Returns:
The short name of a recent file located at id.

void openldev_environment_remove_plugin EnvironmentSettings settings,
const char *  plugin
 

Remove a plugin from the list of enabled. The changes will be saved to GConf so it can be disabled in the future.

Parameters:
settings A non-NULL EnvironmentSettings object.
plugin A short plugin name.

void openldev_environment_set_auto_indent EnvironmentSettings settings,
gboolean  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value TRUE if auto indentation should be enabled.

void openldev_environment_set_auto_load EnvironmentSettings settings,
gboolean  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value TRUE if the last opened project should be loaded when OpenLDev is restarted.

void openldev_environment_set_auto_save EnvironmentSettings settings,
int  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The number of minutes OpenLDev should wait before saving all of the open and modified files. Set to 0 to disable.

void openldev_environment_set_brackets EnvironmentSettings settings,
gboolean  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value TRUE if the matching bracket should be highlighted.

void openldev_environment_set_error EnvironmentSettings settings,
const char *  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The 6-digit hexadecimal color used for error messages in the build output (e.g. FF0000).

void openldev_environment_set_font_face EnvironmentSettings settings,
const char *  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The font face string to be used in each editor tab.

void openldev_environment_set_font_size EnvironmentSettings settings,
const char *  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value A string representation of the font size to be used in each editor tab (e.g. 12).

void openldev_environment_set_height EnvironmentSettings settings,
int  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The height in pixels of the OpenLDev application window.

void openldev_environment_set_last_project EnvironmentSettings settings,
const char *  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The full path of the last opened project.

void openldev_environment_set_line_numbers EnvironmentSettings settings,
gboolean  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value TRUE if line numbers should be displayed in the editor.

void openldev_environment_set_outputmanager_height EnvironmentSettings settings,
int  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The height in pixels of the output manager.

void openldev_environment_set_replace_tabs EnvironmentSettings settings,
gboolean  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value TRUE if tabs should be replaced by spaces.

void openldev_environment_set_right_margin EnvironmentSettings settings,
gboolean  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value TRUE if the right margin should be shown at 80 characters.

void openldev_environment_set_sidebar_width EnvironmentSettings settings,
int  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The width in pixels of the project file sidebar.

void openldev_environment_set_tab_size EnvironmentSettings settings,
int  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The number of spaces that should be inserted when the tab key is pressed.

void openldev_environment_set_undo EnvironmentSettings settings,
int  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The number of undoable actions to remember for each editor tab.

void openldev_environment_set_warning EnvironmentSettings settings,
const char *  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The 6-digit hexadecimal color used for warning messages in the build output (e.g. FF00FF).

void openldev_environment_set_width EnvironmentSettings settings,
int  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value The width in pixels of the OpenLDev application window.

void openldev_environment_set_wrap EnvironmentSettings settings,
gboolean  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value TRUE if text wrapping should be enabled.

void openldev_environment_set_wrap_split EnvironmentSettings settings,
gboolean  value
 

Parameters:
settings A non-NULL EnvironmentSettings object.
value TRUE if words should be split when wrapped around the edge of the buffer.

EnvironmentSettings* openldev_environment_settings_new  ) 
 

This will create a new EnvironmentSettings project with the settings loaded from the user's GConf database.

Returns:
A new EnvironmentSettings object.


Generated on Sun May 14 14:57:41 2006 for OpenLDev by  doxygen 1.4.6