erbrowser/src/mozillaPreferences.h File Reference

browser - interface with gecko for setting/getting preference values More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
gboolean	mozilla_save_prefs (void)
gboolean	mozilla_pref_remove (const gchar *preferenceName)
gboolean	mozilla_pref_set_char (const char *preferenceName, const char *newValue)
gboolean	mozilla_pref_set_boolean (const char *preferenceName, gboolean newValue)
gboolean	mozilla_pref_set_int (const char *preferenceName, int newValue)
gchar *	mozilla_pref_get_char (const char *preferenceName)
gboolean	mozilla_pref_get_boolean (const gchar *preferenceName, gboolean defaultValue)
gint	mozilla_pref_get_int (const char *preferenceName)

---

Detailed Description

browser - interface with gecko for setting/getting preference values

browser - interface with gecko for setting/getting preference values (the startup preferences of the browser app should be put in a "*.js" file in the mozilla three) <File description>="">

<File description>="">

Definition in file mozillaPreferences.h.

---

Function Documentation

gboolean mozilla_pref_get_boolean	(	const gchar *	preferenceName,
		gboolean	defaultValue
	)

get a boolean mozilla preference

Parameters:

	preferenceName	ID of the mozilla reference
	defaultValue	value that will be returned in case of error

Returns:

boolean (default_value on failure)

gchar* mozilla_pref_get_char

(

const char *

preferenceName

)

get a string mozilla preference (calling app should handle free)

Parameters:

preferenceName

ID of the mozilla reference

Returns:

string

get a string mozilla preference (calling app should handle free)

Definition at line 166 of file mozillaPreferences.cpp.

{
    gchar  *value = NULL;
    gchar  *result = NULL;

    g_return_val_if_fail(preferenceName != NULL, FALSE);
    nsCOMPtr < nsIPrefService > prefService = do_GetService(NS_PREFSERVICE_CONTRACTID);
    nsCOMPtr < nsIPrefBranch > pref;
    prefService->GetBranch("", getter_AddRefs(pref));

    if (pref)
    {
        pref->GetCharPref(preferenceName, &value);
    }

    if (value)
    {
        result = g_strdup(value);
        nsMemory::Free(value);
    }

    return result;
}

gint mozilla_pref_get_int

(

const char *

preferenceName

)

get an integer mozilla preference

Parameters:

preferenceName

ID of the mozilla reference

Returns:

int (default_value = -1 on failure)

get an integer mozilla preference / default value -1

Definition at line 145 of file mozillaPreferences.cpp.

{
    int     value = -1;

    g_return_val_if_fail(preferenceName != NULL, FALSE);

    nsCOMPtr < nsIPrefService > prefService = do_GetService(NS_PREFSERVICE_CONTRACTID);
    nsCOMPtr < nsIPrefBranch > pref;
    prefService->GetBranch("", getter_AddRefs(pref));

    if (pref)
    {
        pref->GetIntPref(preferenceName, &value);
    }

    return value;
}

gboolean mozilla_pref_remove

(

const gchar *

preferenceName

)

remove a mozilla preference, reverting to the default value

Parameters:

preferenceName

ID of the mozilla reference

Returns:

TRUE on succes

gboolean mozilla_pref_set_boolean	(	const char *	preferenceName,
		gboolean	newValue
	)

set a boolean mozilla preference

Parameters:

	preferenceName	ID of the mozilla reference
	newValue	new boolean value

Returns:

TRUE on succes

set a boolean mozilla preference

Definition at line 79 of file mozillaPreferences.cpp.

{
    g_return_val_if_fail(preferenceName != NULL, FALSE);

    nsCOMPtr < nsIPrefService > prefService = do_GetService(NS_PREFSERVICE_CONTRACTID);
    nsCOMPtr < nsIPrefBranch > pref;
    prefService->GetBranch("", getter_AddRefs(pref));

    if (pref)
    {
        nsresult rv = pref->SetBoolPref(preferenceName, newValue ? PR_TRUE : PR_FALSE);

        return NS_SUCCEEDED(rv) ? TRUE : FALSE;
    }

    return FALSE;
}

gboolean mozilla_pref_set_char	(	const char *	preferenceName,
		const char *	newValue
	)

set a string mozilla preference

Parameters:

	preferenceName	ID of the mozilla reference
	newValue	new string value

Returns:

TRUE on succes

set a string mozilla preference

Definition at line 52 of file mozillaPreferences.cpp.

{
    g_return_val_if_fail(preferenceName != NULL, FALSE);

    /*It is legitimate to pass in a NULL value sometimes. So let's not
     *assert and just check and return.
     */
    if (!newValue)
        return FALSE;

    nsCOMPtr < nsIPrefService > prefService = do_GetService(NS_PREFSERVICE_CONTRACTID);
    nsCOMPtr < nsIPrefBranch > pref;
    prefService->GetBranch("", getter_AddRefs(pref));

    if (pref)
    {
        nsresult rv = pref->SetCharPref(preferenceName, newValue);

        return NS_SUCCEEDED(rv) ? TRUE : FALSE;
    }

    return FALSE;
}

gboolean mozilla_pref_set_int	(	const char *	preferenceName,
		int	newValue
	)

set a integer mozilla preference

Parameters:

	preferenceName	ID of the mozilla reference
	newValue	new integer value

Returns:

TRUE on succes

set an integer mozilla preference

Definition at line 100 of file mozillaPreferences.cpp.

{
    g_return_val_if_fail(preferenceName != NULL, FALSE);

    nsCOMPtr < nsIPrefService > prefService = do_GetService(NS_PREFSERVICE_CONTRACTID);
    nsCOMPtr < nsIPrefBranch > pref;
    prefService->GetBranch("", getter_AddRefs(pref));

    if (pref)
    {
        nsresult rv = pref->SetIntPref(preferenceName, newValue);

        return NS_SUCCEEDED(rv) ? TRUE : FALSE;
    }
    return FALSE;
}

gboolean mozilla_save_prefs

(

void

)

store the preference changes

Parameters:

void

Returns:

TRUE on succes

Definition at line 39 of file mozillaPreferences.cpp.

{
    nsCOMPtr < nsIPrefService > prefService = do_GetService(NS_PREFSERVICE_CONTRACTID);
    g_return_val_if_fail(prefService != nsnull, FALSE);

    nsresult rv = prefService->SavePrefFile(nsnull);

    return NS_SUCCEEDED(rv) ? TRUE : FALSE;
}