include/alp/inputdialog.h File Reference

Detailed Description

ALP input dialog header file.

#include <gtk/gtk.h>
#include <alp/emoticon_parser.h>

Go to the source code of this file.

Typedefs

typedef void(* AlpInputFilterTextString )(GtkWidget *app_widget, GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, gpointer user_data)

when user input the character to software keypad, this callback function will check if the content is valid

typedef gboolean(* AlpInputSubmitCB )(GtkWidget *widget, gpointer user_data)

callback function invoked when submitted (i.e. "Ok" button was pushed in software keyboard)

Enumerations

enum AlpInputShortcutType { ALP_INPUT_SHORTCUT_NONE, ALP_INPUT_SHORTCUT_12, ALP_INPUT_SHORTCUT_LIST }

identifier of layout of shortcut (or quick text) keyboard. More...

Functions

void alp_get_text_string_filter_cb (GtkWidget *widget, AlpInputFilterTextString *callback, gpointer *user_data)

void alp_max_input_entry_dialog (GtkEntry *entry, GtkWindow *parent)

Display the ALP input dialog for an entry.

AlpEmoticonRef * alp_max_input_get_emoticon (GtkWidget *widget)

get emoticons list from GtkEntry or GtkTextView.

void alp_max_input_get_shortcut (GtkWidget *widget, AlpInputShortcutType *type, int *nstrings, const gchar ***strings)

get shortcut strings and layout for a GtkEntry or GtkTextView

void alp_max_input_get_submit_cb (GtkWidget *widget, gchar **label, AlpInputSubmitCB *callback, gpointer *user_data)

get callback function invoked when submitted

gboolean alp_max_input_is_software_keyboard_running (GtkWidget *widget)

See if the software keyboard is runnning.

void alp_max_input_set_emoticon (GtkWidget *widget, AlpEmoticonRef *emoticon)

set emoticons list for GtkEntry or GtkTextView. Input method will provide the way to input specified emoticons.

void alp_max_input_set_shortcut (GtkWidget *widget, AlpInputShortcutType type, int nstrings, const gchar **strings)

set shortcut strings and layout for a GtkEntry or GtkTextView

void alp_max_input_set_submit_cb (GtkWidget *widget, gchar *label, AlpInputSubmitCB callback, gpointer user_data)

set callback function invoked when submitted

void alp_max_input_text_view_dialog (GtkTextView *textView, GtkWindow *parent)

Display the ALP input dialog for a text view.

void alp_set_text_string_filter_cb (GtkWidget *widget, AlpInputFilterTextString callback, gpointer user_data)

set the callback function when the application starts or Widget is created

Typedef Documentation

typedef void(* AlpInputFilterTextString)(GtkWidget *app_widget, GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, gpointer user_data)

when user input the character to software keypad, this callback function will check if the content is valid

Parameters:

app_widget a GtkTextEntry or GtkTextView of the every application

textbuffer a GtkTextView of software keypad

location iterator of the textbuffer

text a new inserted string to the GtkTextView of software keypad

len the length of the inserted string

user_data the user data of application

typedef gboolean(* AlpInputSubmitCB)(GtkWidget *widget, gpointer user_data)

callback function invoked when submitted (i.e. "Ok" button was pushed in software keyboard)

Parameters:

widget a GtkEntry or GtkTextView, which triggered software keyboard.

user_data a user data specified by alp_max_input_set_submit_func.

Enumeration Type Documentation

enum AlpInputShortcutType

identifier of layout of shortcut (or quick text) keyboard.

Enumerator:

ALP_INPUT_SHORTCUT_NONE No shortcut nor quick text

ALP_INPUT_SHORTCUT_12 Twelve buttons. Mode label will be "Shortcut"

ALP_INPUT_SHORTCUT_LIST Using GtkTreeView. Mode label will be "Quick text"

Function Documentation

void alp_get_text_string_filter_cb ( GtkWidget * widget,

AlpInputFilterTextString * callback,

gpointer * user_data

)

void alp_max_input_entry_dialog ( GtkEntry * entry,

GtkWindow * parent

)

Display the ALP input dialog for an entry.

Parameters:

[in] entry the GtkEntry to be edited by the dialog

[in] parent the parent GtkWindow for the dialog or NULL to use entry's top level window

Returns:
Nothing

AlpEmoticonRef* alp_max_input_get_emoticon ( GtkWidget * widget )

get emoticons list from GtkEntry or GtkTextView.

Parameters:

widget a GtkEntry of a GtkTextView

Returns:
an AlpEmoticonRef

void alp_max_input_get_shortcut ( GtkWidget * widget,

AlpInputShortcutType * type,

int * nstrings,

const gchar *** strings

)

get shortcut strings and layout for a GtkEntry or GtkTextView

Parameters:

widget a GtkEntry or a GtkTextView

type a placeholder for appearance.

nstrings a placeholder of number of strings

strings placeholder of array of strings. This is shared, so caller must not modify its value.

void alp_max_input_get_submit_cb ( GtkWidget * widget,

gchar ** label,

AlpInputSubmitCB * callback,

gpointer * user_data

)

get callback function invoked when submitted

Parameters:

widget a GtkEntry or GtkText

label a placeholder of string shown in submit button.

func a placeholder of the callback function.

user_data a placeholder of an user data.

gboolean alp_max_input_is_software_keyboard_running ( GtkWidget * widget )

See if the software keyboard is runnning.

Parameters:

widget a GtkTextView or a GtkEntry

Returns:
TRUE iff software keyboard is runnning for given widget. Application can use this API to change its behavior depending on software keyboard state (ex. inhibit warning dialog for invalid data),

void alp_max_input_set_emoticon ( GtkWidget * widget,

AlpEmoticonRef * emoticon

)

set emoticons list for GtkEntry or GtkTextView. Input method will provide the way to input specified emoticons.

Parameters:

widget a GtkEntry of a GtkTextView

emoticon an AlpEmoticonRef

void alp_max_input_set_shortcut ( GtkWidget * widget,

AlpInputShortcutType type,

int nstrings,

const gchar ** strings

)

set shortcut strings and layout for a GtkEntry or GtkTextView

Parameters:

widget a GtkEntry or a GtkTextView

type specifies appearance

nstrings number of strings

strings array of strings. Caller must not changed this array or, if dynamically allocated, must not release it.

void alp_max_input_set_submit_cb ( GtkWidget * widget,

gchar * label,

AlpInputSubmitCB callback,

gpointer user_data

)

set callback function invoked when submitted

Parameters:

widget a GtkEntry or GtkText

label the string shown in submit button instead of "Ok"

func the function which will be invoked when user pushed submit button.

user_data an user data which will be passed to func.

void alp_max_input_text_view_dialog ( GtkTextView * textView,

GtkWindow * parent

)

Display the ALP input dialog for a text view.

Parameters:

[in] textView the GtkTextView to be edited by the dialog

[in] parent the parent GtkWindow for the dialog or NULL to use text view's top level window

Returns:
Nothing

void alp_set_text_string_filter_cb ( GtkWidget * widget,

AlpInputFilterTextString callback,

gpointer user_data

)

set the callback function when the application starts or Widget is created

Parameters:

widget a GtkTextEntry or GtkTextView of the every application

callback funtion point of callback

user_data the user data of application

Generated on Wed Jul 30 07:06:40 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation


Typedefs
typedef void(*	AlpInputFilterTextString )(GtkWidget app_widget, GtkTextBuffer textbuffer, GtkTextIter location, gchar text, gint len, gpointer user_data)
	when user input the character to software keypad, this callback function will check if the content is valid
typedef gboolean(*	AlpInputSubmitCB )(GtkWidget *widget, gpointer user_data)
	callback function invoked when submitted (i.e. "Ok" button was pushed in software keyboard)
Enumerations
enum	AlpInputShortcutType { ALP_INPUT_SHORTCUT_NONE, ALP_INPUT_SHORTCUT_12, ALP_INPUT_SHORTCUT_LIST }
	identifier of layout of shortcut (or quick text) keyboard. More...
Functions
void	alp_get_text_string_filter_cb (GtkWidget widget, AlpInputFilterTextString callback, gpointer *user_data)
void	alp_max_input_entry_dialog (GtkEntry entry, GtkWindow parent)
	Display the ALP input dialog for an entry.
AlpEmoticonRef *	alp_max_input_get_emoticon (GtkWidget *widget)
	get emoticons list from GtkEntry or GtkTextView.
void	alp_max_input_get_shortcut (GtkWidget widget, AlpInputShortcutType type, int nstrings, const gchar **strings)
	get shortcut strings and layout for a GtkEntry or GtkTextView
void	alp_max_input_get_submit_cb (GtkWidget widget, gchar label, AlpInputSubmitCB callback, gpointer *user_data)
	get callback function invoked when submitted
gboolean	alp_max_input_is_software_keyboard_running (GtkWidget *widget)
	See if the software keyboard is runnning.
void	alp_max_input_set_emoticon (GtkWidget widget, AlpEmoticonRef emoticon)
	set emoticons list for GtkEntry or GtkTextView. Input method will provide the way to input specified emoticons.
void	alp_max_input_set_shortcut (GtkWidget widget, AlpInputShortcutType type, int nstrings, const gchar *strings)
	set shortcut strings and layout for a GtkEntry or GtkTextView
void	alp_max_input_set_submit_cb (GtkWidget widget, gchar label, AlpInputSubmitCB callback, gpointer user_data)
	set callback function invoked when submitted
void	alp_max_input_text_view_dialog (GtkTextView textView, GtkWindow parent)
	Display the ALP input dialog for a text view.
void	alp_set_text_string_filter_cb (GtkWidget *widget, AlpInputFilterTextString callback, gpointer user_data)
	set the callback function when the application starts or Widget is created