Top | ![]() |
![]() |
![]() |
![]() |
enum | CallIds |
enum | RateType |
#define | MAX_DESCRIPTION_TEXT |
#define | MAX_RATE_NAME |
#define | MAX_DISPLAY_RATE_NAME |
#define | COMPARE_NO |
#define | COMPARE_EQUAL |
#define | COMPARE_LESSTHAN |
#define | COMPARE_GREATERTHAN |
#define | COMPARE_EQUALORLESSTHAN |
#define | COMPARE_EQUALORGREATERTHAN |
gboolean gok_scanner_initialize (const gchar *directory
,const gchar *accessmethod
,const gchar *selectaction
,const gchar *scanaction
);
Reads all the access methods from the given directory and gets them ready to go.
directory |
The name of the directory to read the access method files from. |
|
accessmethod |
If non-NULL, overrides access method name in gconf configuration data. |
|
selectaction |
If non-NULL, overrides action associated with 'select' for the current access method in gconf configuration data. |
|
scanaction |
If non-NULL, overrides access method associated with 'select' for the current access method in gconf configuration data. |
void
gok_scanner_close (void
);
Stops the current access method and frees any memory allocated for the access methods. This must be called at the end of the program.
gboolean
gok_scanner_change_method (gchar *NameAccessMethod
);
Changes the type of access method.
GokAccessMethod *
gok_scanner_create_access_method (gchar *Name
);
Creates a new access method structure and adds it to the list of access methods.
void
gok_scanner_reset_access_method (void
);
Resets the current access method so it's ready for use.
void gok_scanner_change_state (GokScannerState *pState
,gchar *NameAccessMethod
);
Maps event handlers to effects..
void
gok_scanner_set_handlers_null (void
);
Sets all the event handlers to NULL.
gboolean
gok_scanner_read_access_method (gchar *Filename
);
Read an access method file from disk and create a new access method. The new access method is added to the list of access methods.
GokScannerState *
gok_scanner_construct_state (void
);
Creates a new handler state.
GokAccessMethodRate *
gok_scanner_construct_rate (void
);
Creates a new access method rate.
GokScannerHandler *
gok_scanner_construct_handler (gchar *pHandlerName
);
Creates a new access method handler.
gboolean gok_scanner_read_rates (xmlNode *pNode
,GokAccessMethod *pAccessMethod
);
Reads the rates for the given access method and add them to the list of rates stored on the access method.
gboolean gok_scanner_read_description (xmlDoc *pDoc
,xmlNode *pNode
,GokAccessMethod *pAccessMethod
);
Reads the description of the access method and stores it on the structure.
gboolean gok_scanner_read_operation (xmlDoc *pDoc
,xmlNode *pNode
,GokAccessMethod *pAccessMethod
);
Reads the UI 'operation' of the access method and stores it on the structure.
void gok_scanner_read_ui_loop (GokControl *pControl
,xmlNode *pNode
);
Reads the UI 'operation' of the access method and stores it on the structure.
gboolean gok_scanner_read_feedback (xmlDoc *pDoc
,xmlNode *pNode
,GokAccessMethod *pAccessMethod
);
Reads the UI 'feedback' of the access method and stores it on the structure.
gboolean gok_scanner_read_options (xmlDoc *pDoc
,xmlNode *pNode
,GokAccessMethod *pAccessMethod
);
Reads the UI 'options' of the access method and stores it on the structure.
void
gok_scanner_update_rates (void
);
Updates all the rates in all access methods from the GokData.
GokAccessMethod *
gok_scanner_get_current_access_method (void
);
Accessor function to get the current access method.
GokAccessMethod *
gok_scanner_get_first_access_method (void
);
GokScannerState *
gok_scanner_get_current_state (void
);
Accessor function to get the current handler state.
void gok_scanner_get_pointer_location (gint *pX
,gint *pY
);
Gets the current location of the mouse pointer.
void
gok_scanner_timer_set_dwell_rate (gint rate
);
Sets the dwell rate.
gboolean
gok_scanner_timer_on_dwell (gpointer data
);
This will be called when the dwell timer counts down.
void
gok_scanner_left_button_down (void
);
Handler for the left mouse button down event.
void
gok_scanner_left_button_up (void
);
Handler for the left mouse button up event.
void
gok_scanner_right_button_down (void
);
Handler for the right mouse button down event.
void
gok_scanner_right_button_up (void
);
Handler for the right mouse button up event.
void
gok_scanner_middle_button_down (void
);
Handler for the middle mouse button down event.
void
gok_scanner_middle_button_up (void
);
Handler for the mouse middle button up event.
void gok_scanner_mouse_movement (gint x
,gint y
);
Handler for the mouse movement event. Stores the location of the mouse pointer.
gboolean
gok_scanner_on_timer1 (gpointer data
);
Handler for the timer1 event (timer 1 has counted down).
gboolean
gok_scanner_on_timer2 (gpointer data
);
Handler for the timer2 event (timer 2 has counted down).
gboolean
gok_scanner_on_timer3 (gpointer data
);
Handler for the timer3 event (timer 3 has counted down).
gboolean
gok_scanner_on_timer4 (gpointer data
);
Handler for the timer4 event (timer 4 has counted down).
gboolean
gok_scanner_on_timer5 (gpointer data
);
Handler for the timer5 event (timer 5 has counted down).
void
gok_scanner_on_key_enter (GokKey *pKey
);
Handler for the key enter notify.
void
gok_scanner_on_key_leave (GokKey *pKey
);
Handler for the key leave notify.
void
gok_scanner_on_switch1_down (void
);
Handler for the switch 1 down event.
void
gok_scanner_on_switch1_up (void
);
Handler for the switch 1 up event.
void
gok_scanner_on_switch2_down (void
);
Handler for the switch 2 down event.
void
gok_scanner_on_switch2_up (void
);
Handler for the switch 2 up event.
void
gok_scanner_on_switch3_down (void
);
Handler for the switch 3 down event.
void
gok_scanner_on_switch3_up (void
);
Handler for the switch 3 up event.
void
gok_scanner_on_switch4_down (void
);
Handler for the switch 4 down event.
void
gok_scanner_on_switch4_up (void
);
Handler for the switch 4 up event.
void
gok_scanner_on_switch5_down (void
);
Handler for the switch 5 down event.