hildon-help-private

hildon-help-private

Synopsis




#define     HELP_HTML_TMPFILE
#define     OSSO_HELP_PATH
#define     OSSO_HELP_CSS
#define     DEFAULT_CSS
#define     HELPLIB_PICTURE_PATHS
#define     HELPLIB_PICTURE_EXTENSIONS
#define     HELPLIB_ICO_PATH
#define     HELP_KEY_MAXLEN
#define     HELP_TITLE_MAXLEN
#define     HELP_KEY_OR_TITLE_MAXLEN
#define     HELP_DIALOG_WIDTH
#define     HELP_DIALOG_HEIGHT
#define     HELPUI_DOMAIN
const gchar* ossohelp_getpath               (const gchar *language);
const gchar* ossohelp_getcss                (void);
struct      s_help_trail;
gboolean    ossohelp_html_ext               (FILE *f,
                                             const char *key,
                                             enum e_html_style flags,
                                             const struct s_help_trail *trail);
const char* ossohelp_file                   (const char *branch,
                                             char *fn_buf,
                                             size_t buflen);
gboolean    ossohelp_title                  (const char *key,
                                             char *buf,
                                             size_t bufsize);
gboolean    key_from_triplet                (const char *triplet,
                                             char *buf,
                                             size_t bufsize);
const gchar* helplib_ui_str                 (enum e_HelpStrId id);
char        last_char                       (const char *p);
char*       strcpy_safe_max                 (char *buf,
                                             const char *src,
                                             size_t buflen,
                                             int max);
char*       strcat_safe_max                 (char *buf,
                                             const char *src,
                                             size_t buflen,
                                             int max);
#define     strcpy_safe                     ( buf, src, buflen )
#define     strcat_safe                     ( buf, src, buflen )
#define     strcpy_safe_auto                ( buf, src )
#define     strcat_safe_auto                ( buf, src )
#define     strcpy_safe_auto_max            ( buf, str, max )
#define     strcat_safe_auto_max            ( buf, str, max )
typedef     h_OssoHelpWalker;
const char* ossohelp_next                   (h_OssoHelpWalker *h_ref,
                                             const char *branch_id);
void        ossohelp_link_clicked           (GtkHTML *html,
                                             const gchar *url,
                                             gpointer data);
GtkWidget*  browser_new                     (osso_context_t *osso);
void        browser_close                   (GtkWidget **browser_ref);
gboolean    browser_show                    (GtkWidget *browser,
                                             const char *file_url,
                                             gboolean is_dialog);
gboolean    browser_zoom                    (GtkWidget *browser,
                                             guint level);
gboolean    browser_find                    (GtkWidget *browser,
                                             const gchar *str,
                                             gboolean rewind,
                                             gboolean *retval_ref);
gboolean    browser_has_selection           (GtkWidget *browser,
                                             gboolean *retval_ref);
gboolean    browser_copy_selection          (GtkWidget *browser);
osso_return_t libosso_update_html           (osso_context_t *osso,
                                             GdkNativeWindow socket_id,
                                             const char *topic_key);
gboolean    browser_focus_forward_backward  (GtkWidget *browser,
                                             GtkDirectionType dir,
                                             gboolean start_from_first);
gboolean    browser_has_focus               (GtkWidget *browser);

Description

Details

HELP_HTML_TMPFILE

#define HELP_HTML_TMPFILE   "/tmp/osso-help.htm"

OSSO_HELP_PATH

#define OSSO_HELP_PATH  "OSSO_HELP_PATH"

OSSO_HELP_CSS

#define OSSO_HELP_CSS   "OSSO_HELP_CSS"

DEFAULT_CSS

#define DEFAULT_CSS   "help-default.css"

HELPLIB_PICTURE_PATHS

#define     HELPLIB_PICTURE_PATHS

HELPLIB_PICTURE_EXTENSIONS

#define HELPLIB_PICTURE_EXTENSIONS "%s.png", "%s.jpg", "%s.jpeg"

HELPLIB_ICO_PATH

#define HELPLIB_ICO_PATH "/usr/share/icons/hicolor/26x26/hildon/"

HELP_KEY_MAXLEN

#define HELP_KEY_MAXLEN 60

HELP_TITLE_MAXLEN

#define HELP_TITLE_MAXLEN 320

HELP_KEY_OR_TITLE_MAXLEN

#define HELP_KEY_OR_TITLE_MAXLEN  (HELP_KEY_MAXLEN)   /* longer of the two */

HELP_DIALOG_WIDTH

#define HELP_DIALOG_WIDTH   480    /* was: 450 (not fitting Italian title) */

HELP_DIALOG_HEIGHT

#define HELP_DIALOG_HEIGHT  280    /* was: 250 */

HELPUI_DOMAIN

#define HELPUI_DOMAIN "osso-help"

ossohelp_getpath ()

const gchar* ossohelp_getpath               (const gchar *language);

language :
Returns :

ossohelp_getcss ()

const gchar* ossohelp_getcss                (void);

Returns :

struct s_help_trail

struct s_help_trail {
    char key[HELP_KEY_MAXLEN];
    char title[HELP_TITLE_MAXLEN];
};

ossohelp_html_ext ()

gboolean    ossohelp_html_ext               (FILE *f,
                                             const char *key,
                                             enum e_html_style flags,
                                             const struct s_help_trail *trail);

f :
key :
flags :
trail :
Returns :

ossohelp_file ()

const char* ossohelp_file                   (const char *branch,
                                             char *fn_buf,
                                             size_t buflen);

branch :
fn_buf :
buflen :
Returns :

ossohelp_title ()

gboolean    ossohelp_title                  (const char *key,
                                             char *buf,
                                             size_t bufsize);

key :
buf :
bufsize :
Returns :

key_from_triplet ()

gboolean    key_from_triplet                (const char *triplet,
                                             char *buf,
                                             size_t bufsize);

triplet :
buf :
bufsize :
Returns :

helplib_ui_str ()

const gchar* helplib_ui_str                 (enum e_HelpStrId id);

id :
Returns :

last_char ()

char        last_char                       (const char *p);

p :
Returns :

strcpy_safe_max ()

char*       strcpy_safe_max                 (char *buf,
                                             const char *src,
                                             size_t buflen,
                                             int max);

buf :
src :
buflen :
max :
Returns :

strcat_safe_max ()

char*       strcat_safe_max                 (char *buf,
                                             const char *src,
                                             size_t buflen,
                                             int max);

buf :
src :
buflen :
max :
Returns :

strcpy_safe()

#define strcpy_safe( buf, src, buflen ) strcpy_safe_max( (buf), (src), (buflen), -1 )

buf :
src :
buflen :

strcat_safe()

#define strcat_safe( buf, src, buflen ) strcat_safe_max( (buf), (src), (buflen), -1 )

buf :
src :
buflen :

strcpy_safe_auto()

#define strcpy_safe_auto( buf, src )    strcpy_safe( (buf), (src), sizeof(buf) )

buf :
src :

strcat_safe_auto()

#define strcat_safe_auto( buf, src )    strcat_safe( (buf), (src), sizeof(buf) )

buf :
src :

strcpy_safe_auto_max()

#define strcpy_safe_auto_max( buf, str, max )   strcpy_safe_max( (buf), (str), sizeof(buf), (max) )

buf :
str :
max :

strcat_safe_auto_max()

#define strcat_safe_auto_max( buf, str, max )   strcat_safe_max( (buf), (str), sizeof(buf), (max) )

buf :
str :
max :

h_OssoHelpWalker

typedef struct s_OssoHelpWalker *h_OssoHelpWalker;

ossohelp_next ()

const char* ossohelp_next                   (h_OssoHelpWalker *h_ref,
                                             const char *branch_id);

h_ref :
branch_id :
Returns :

ossohelp_link_clicked ()

void        ossohelp_link_clicked           (GtkHTML *html,
                                             const gchar *url,
                                             gpointer data);

html :
url :
data :

browser_new ()

GtkWidget*  browser_new                     (osso_context_t *osso);

osso :
Returns :

browser_close ()

void        browser_close                   (GtkWidget **browser_ref);

browser_ref :

browser_show ()

gboolean    browser_show                    (GtkWidget *browser,
                                             const char *file_url,
                                             gboolean is_dialog);

browser :
file_url :
is_dialog :
Returns :

browser_zoom ()

gboolean    browser_zoom                    (GtkWidget *browser,
                                             guint level);

browser :
level :
Returns :

browser_find ()

gboolean    browser_find                    (GtkWidget *browser,
                                             const gchar *str,
                                             gboolean rewind,
                                             gboolean *retval_ref);

browser :
str :
rewind :
retval_ref :
Returns :

browser_has_selection ()

gboolean    browser_has_selection           (GtkWidget *browser,
                                             gboolean *retval_ref);

browser :
retval_ref :
Returns :

browser_copy_selection ()

gboolean    browser_copy_selection          (GtkWidget *browser);

browser :
Returns :

libosso_update_html ()

osso_return_t libosso_update_html           (osso_context_t *osso,
                                             GdkNativeWindow socket_id,
                                             const char *topic_key);

osso :
socket_id :
topic_key :
Returns :

browser_focus_forward_backward ()

gboolean    browser_focus_forward_backward  (GtkWidget *browser,
                                             GtkDirectionType dir,
                                             gboolean start_from_first);

browser :
dir :
start_from_first :
Returns :

browser_has_focus ()

gboolean    browser_has_focus               (GtkWidget *browser);

browser :
Returns :