AlpScrollSelector
[UI Widgets]


Data Structures

struct  _AlpScrollSelector
struct  _AlpScrollSelectorClass

Defines

#define ALP_IS_SCROLL_SELECTOR(obj)   GTK_CHECK_TYPE (obj, alp_scroll_selector_get_type ())
#define ALP_SCROLL_SELECTOR(obj)   GTK_CHECK_CAST (obj, alp_scroll_selector_get_type (), AlpScrollSelector)
#define ALP_SCROLL_SELECTOR_CLASS(klass)   GTK_CHECK_CLASS_CAST (klass, alp_scroll_selector_get_type (), AlpScrollSelectorClass)

Typedefs

typedef _AlpScrollSelector AlpScrollSelector
typedef _AlpScrollSelectorClass AlpScrollSelectorClass

Functions

void alp_scroll_selector_get_alignment (AlpScrollSelector *selector, gfloat *halign, gfloat *valign)
 Enable the user to get the alignment of the Scroll Selector.
gint alp_scroll_selector_get_current_index (AlpScrollSelector *selector)
 Returns the index of the current selected item.
const gchar * alp_scroll_selector_get_current_string (AlpScrollSelector *selector)
 Returns the string associated with the current selected item. The string is a reference to an internally stored string, so the caller should not delete it!
const gchar * alp_scroll_selector_get_title (AlpScrollSelector *selector)
 Returns the title string.
GtkType alp_scroll_selector_get_type (void)
 Get the AlpScrollSelector object type.
GtkWidget * alp_scroll_selector_new (GtkWindow *parent, const gchar *title)
 Create a scroll selector widget.
void alp_scroll_selector_popup (AlpScrollSelector *selector)
 Pop-up the scroll selector widget on top of the current window.
void alp_scroll_selector_set_alignment (AlpScrollSelector *selector, float halign, float valign)
 Sets the vertical and horizontal alignment of the scroll selector relative to the ScrollSelector's parent window. Alignment values to from 0 to 1. A value of 0 aligns the selector with the left or top of the parent window. A value of 1 aligns the selector with the right or bottom of the parent window. A value of 0.5 centers the selector on the parent window. The default value is (1.0, 1.0) for bottom/right alignment.
void alp_scroll_selector_set_list_mode (AlpScrollSelector *selector, const gchar *value_name_array[], const gint size, const gint current)
 Sets the scroll selector widget to list mode.
void alp_scroll_selector_set_text_entry_mode (AlpScrollSelector *selector)
 Sets the scroll selector widget to text entry mode.
void alp_scroll_selector_set_title (AlpScrollSelector *selector, const gchar *title)
 Adds a title string above the selector. Setting the title string to the empty string removes the title string. The default is to have no title.

Define Documentation

#define ALP_IS_SCROLL_SELECTOR (  obj   )     GTK_CHECK_TYPE (obj, alp_scroll_selector_get_type ())
 

#define ALP_SCROLL_SELECTOR (  obj   )     GTK_CHECK_CAST (obj, alp_scroll_selector_get_type (), AlpScrollSelector)
 

#define ALP_SCROLL_SELECTOR_CLASS (  klass   )     GTK_CHECK_CLASS_CAST (klass, alp_scroll_selector_get_type (), AlpScrollSelectorClass)
 

Typedef Documentation

typedef struct _AlpScrollSelector AlpScrollSelector
 

typedef struct _AlpScrollSelectorClass AlpScrollSelectorClass
 

Function Documentation

void alp_scroll_selector_get_alignment (  AlpScrollSelector *  selector,
gfloat *  halign,
gfloat *  valign
) 
 

Enable the user to get the alignment of the Scroll Selector.

Parameters:
[in] selector Pointer to the AlpScrollSelector widget
[in] halign Pointer to return the horizontal 0 to 1 alignment
[in] valign Pointer to return the vertical 0 to 1 alignment
Returns:
none

gint alp_scroll_selector_get_current_index (  AlpScrollSelector *  selector  ) 
 

Returns the index of the current selected item.

Parameters:
[in] selector Pointer to the AlpScrollSelector widget
Returns:
If in list mode, returns the index of the current item in the list

If in text entry mode, returns -1

const gchar* alp_scroll_selector_get_current_string (  AlpScrollSelector *  selector  ) 
 

Returns the string associated with the current selected item. The string is a reference to an internally stored string, so the caller should not delete it!

Parameters:
[in] selector Pointer to the AlpScrollSelector widget
Returns:
If in list mode, returns the string associated with the current item in the list

If in text entry mode, returns the current string that has been entered

const gchar* alp_scroll_selector_get_title (  AlpScrollSelector *  selector  ) 
 

Returns the title string.

Parameters:
[in] selector Pointer to the AlpScrollSelector widget
Returns:
none

GtkType alp_scroll_selector_get_type (  void   ) 
 

Get the AlpScrollSelector object type.

Parameters:
[in] none. 
Returns:
The AlpScrollSelector type identifier

GtkWidget* alp_scroll_selector_new (  GtkWindow *  parent,
const gchar *  title
) 
 

Create a scroll selector widget.

Parameters:
[in] parent The window this widget will pop-up over
[in] title The title to display (or NULL for none)
Returns:
widget created

void alp_scroll_selector_popup (  AlpScrollSelector *  selector  ) 
 

Pop-up the scroll selector widget on top of the current window.

Parameters:
[in] selector Pointer to the AlpScrollSelector widget
Returns:
none

void alp_scroll_selector_set_alignment (  AlpScrollSelector *  selector,
float  halign,
float  valign
) 
 

Sets the vertical and horizontal alignment of the scroll selector relative to the ScrollSelector's parent window. Alignment values to from 0 to 1. A value of 0 aligns the selector with the left or top of the parent window. A value of 1 aligns the selector with the right or bottom of the parent window. A value of 0.5 centers the selector on the parent window. The default value is (1.0, 1.0) for bottom/right alignment.

Parameters:
[in] selector Pointer to the AlpScrollSelector widget
[in] halign Horizontal alignment from 0 to 1 (default 1.0)
[in] valign Vertical alignment from 0 to 1 (default 1.0)
Returns:
none

void alp_scroll_selector_set_list_mode (  AlpScrollSelector *  selector,
const gchar *  value_name_array[],
const gint  size,
const gint  current
) 
 

Sets the scroll selector widget to list mode.

Parameters:
[in] selector Pointer to the AlpScrollSelector widget
[in] value_name_array Pointer to a string array used to specify the values to choose from.
[in] size Specifies the number of values in value_name_array
[in] current The index of the initially selected item
Returns:
none

void alp_scroll_selector_set_text_entry_mode (  AlpScrollSelector *  selector  ) 
 

Sets the scroll selector widget to text entry mode.

Parameters:
[in] selector Pointer to the AlpScrollSelector widget
Returns:
none

void alp_scroll_selector_set_title (  AlpScrollSelector *  selector,
const gchar *  title
) 
 

Adds a title string above the selector. Setting the title string to the empty string removes the title string. The default is to have no title.

Parameters:
[in] selector Pointer to the AlpScrollSelector widget
[in] title The string to display as the title (default "")
Returns:
none

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.