Configuration User Interface
[Connection Manager, Connection Manager]

Detailed Description

UI for profile edition.


Data Structures

union  _AlpCncEditParameters
struct  _AlpCncGtkControl
struct  _AlpCncGtkControl

Generic User Interface

#define ALP_CNC_MODE_APP_SWITCH   ((uint32_t) 0x8000)
 launch panel doin an app switch
#define ALP_CNC_MODE_DELETE   ((uint32_t) 8)
 launch panel to delete a profile
#define ALP_CNC_MODE_EDIT   ((uint32_t) 16)
 launch panel to edit a profile
#define ALP_CNC_MODE_FULL   (ALP_CNC_MODE_TECHNOLOGY | ALP_CNC_MODE_PROFILE | ALP_CNC_MODE_NEW | ALP_CNC_MODE_DELETE | ALP_CNC_MODE_EDIT)
 full application mode
#define ALP_CNC_MODE_NEW   ((uint32_t) 4)
 launch panel in new profile mode
#define ALP_CNC_MODE_NO_DONE_BUTTON   ((uint32_t) 0x4000)
 don't display the "Done" button
#define ALP_CNC_MODE_PANEL   (ALP_CNC_MODE_PROFILE | ALP_CNC_MODE_NEW | ALP_CNC_MODE_DELETE | ALP_CNC_MODE_EDIT)
 panel mode
#define ALP_CNC_MODE_PROFILE   ((uint32_t) 2)
 launch panel in profile list mode
#define ALP_CNC_MODE_TECHNOLOGY   ((uint32_t) 1)
 deprecated
#define ALP_CNC_UI_CTL_OP_CANCEL   1
 When the edition of a profile is cancelled.
#define ALP_CNC_UI_CTL_OP_CHECK   3
 When the user changed the tab.
#define ALP_CNC_UI_CTL_OP_SAVE   2
 When the modification of a profile is confirmed.
typedef _AlpCncEditParameters AlpCncEditParameters

GTK User Interface

typedef _AlpCncGtkControl AlpCncGtkControl
alp_status_t alp_cnc_channel_settings (char *tags)
alp_status_t alp_cnc_plugins_gtk_control (uint32_t profile_id, uint8_t op, guint16 group_index, AlpCncGtkControl *context, gchar **error_message)
void alp_cnc_plugins_gtk_free (gchar *localized_names[], GtkWidget *ui_groups[])
alp_status_t alp_cnc_plugins_gtk_get (uint32_t profile_id, gchar ***localized_names, GtkWidget ***ui_groups, guint16 *ui_groups_size, GtkWidget *parent_window)
alp_status_t alp_cnc_plugins_gtk_group_check (uint32_t profile_id, guint16 group_index, gchar **error_message)
alp_status_t alp_cnc_plugins_gtk_validate (uint32_t profile_id, uint8_t op, guint16 *group_index, gchar **error_message)

Define Documentation

#define ALP_CNC_MODE_APP_SWITCH   ((uint32_t) 0x8000)
 

launch panel doin an app switch

#define ALP_CNC_MODE_DELETE   ((uint32_t) 8)
 

launch panel to delete a profile

#define ALP_CNC_MODE_EDIT   ((uint32_t) 16)
 

launch panel to edit a profile

#define ALP_CNC_MODE_FULL   (ALP_CNC_MODE_TECHNOLOGY | ALP_CNC_MODE_PROFILE | ALP_CNC_MODE_NEW | ALP_CNC_MODE_DELETE | ALP_CNC_MODE_EDIT)
 

full application mode

#define ALP_CNC_MODE_NEW   ((uint32_t) 4)
 

launch panel in new profile mode

#define ALP_CNC_MODE_NO_DONE_BUTTON   ((uint32_t) 0x4000)
 

don't display the "Done" button

#define ALP_CNC_MODE_PANEL   (ALP_CNC_MODE_PROFILE | ALP_CNC_MODE_NEW | ALP_CNC_MODE_DELETE | ALP_CNC_MODE_EDIT)
 

panel mode

#define ALP_CNC_MODE_PROFILE   ((uint32_t) 2)
 

launch panel in profile list mode

#define ALP_CNC_MODE_TECHNOLOGY   ((uint32_t) 1)
 

deprecated

#define ALP_CNC_UI_CTL_OP_CANCEL   1
 

When the edition of a profile is cancelled.

#define ALP_CNC_UI_CTL_OP_CHECK   3
 

When the user changed the tab.

#define ALP_CNC_UI_CTL_OP_SAVE   2
 

When the modification of a profile is confirmed.

Typedef Documentation

typedef union _AlpCncEditParameters AlpCncEditParameters
 

typedef struct _AlpCncGtkControl AlpCncGtkControl
 

Function Documentation

alp_status_t alp_cnc_channel_settings (  char *  tags  ) 
 

Display a list of compatible cnc profiles so the user can select the default one.

Parameters:
[in] tags The search criteria used to find a suitable profile (see ALP_CNC_CHANNEL_SRV_XXX and ALP_CNC_CHANNEL_LINK_XXX constants)
Returns:
ALP_STATUS_OK if no error. ALP_STATUS_CNC_INVALID_PARAM if tags is NULL or empty
Remarks:
None.

alp_status_t alp_cnc_plugins_gtk_control (  uint32_t  profile_id,
uint8_t  op,
guint16  group_index,
AlpCncGtkControl *  context,
gchar **  error_message
) 
 

Make a ALP_CNC_CTL_OP_CHECK for a specific GTK Widget.

Parameters:
[in] profile_id the profile to check
[in] op The control operation id
[in] group_index the index of widget to check
[in,out] context Context depending on control operation
[out] error_message address of an string (must be not NULL). *error_message is NULL if op is successful, else contains a localized error message
Returns:
ALP_STATUS_CNC_OBJECT_NOT_FOUND if the profile profile_id doesn't exist

void alp_cnc_plugins_gtk_free (  gchar *  localized_names[],
GtkWidget *  ui_groups[]
) 
 

Free all resources from plugins UI

Parameters:
[in] localized_names pointer on the names of each group
[in] ui_groups pointer on GTK Widgets plugins UI for a profile

alp_status_t alp_cnc_plugins_gtk_get (  uint32_t  profile_id,
gchar ***  localized_names,
GtkWidget ***  ui_groups,
guint16 *  ui_groups_size,
GtkWidget *  parent_window
) 
 

Retrieve all plugins UI for a profile.

Parameters:
[in] profile_id the profile to view
[in] parent_window the parent widget form
[out] localized_names address of a pointer on the names of each group (must be not NULL)
[out] ui_groups address of a pointer on GTK Widgets plugins UI for the profile (must be not NULL)
[out] ui_groups_size number of GTKWidgets
Remarks:
example: after a call on a profile like "NetOut/IPIF/Ethernet": ui_groups_size=3 ui_groups={TCP/IP GTK Widget,DNS GTK Widget,Domains GTK Widget} localized_names={"TCP/IP","DNS Servers","Domains"}
Returns:
ALP_STATUS_CNC_OBJECT_NOT_FOUND if the profile profile_id doesn't exist

alp_status_t alp_cnc_plugins_gtk_group_check (  uint32_t  profile_id,
guint16  group_index,
gchar **  error_message
) 
 

Make a ALP_CNC_CTL_OP_CHECK for a specific GTK Widget.

Parameters:
[in] profile_id the profile to check
[in] group_index the index of widget to check
[out] error_message address of an string (must be not NULL). *error_message is NULL if op is successful, else contains a localized error message
Returns:
ALP_STATUS_CNC_OBJECT_NOT_FOUND if the profile profile_id doesn't exist

alp_status_t alp_cnc_plugins_gtk_validate (  uint32_t  profile_id,
uint8_t  op,
guint16 *  group_index,
gchar **  error_message
) 
 

Try to make an operation on UI openned profile.

Parameters:
[in] profile_id the profile to edit
[in] op operation to do. See ALP_CNC_CTL_OP_XXX
[out] group_index the index of the last UI Widgets who failed the operation
[out] error_message address of an string (must be not NULL). *error_message is NULL if op is successful, else contains a localized error message
Returns:
ALP_STATUS_CNC_OBJECT_NOT_FOUND if the profile profile_id doesn't exist

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

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.