include/alp/scrollselector.h File Reference

---

Detailed Description

The scroll selector is a widget which enables the user to see visual transparency effect directly when perform some selection operations.

The AlpScrollSelector can operate in two modes, list mode and text entry mode. After you create the widget with alp_scroll_selector_new(), you must set one of the mode using either alp_scroll_selector_set_list_mode() or alp_scroll_selector_set_entry_mode().

In list mode, the selector displays a single item from a list of items. Up and down arrow events move to the previous or next item in the list.

In entry mode, the selector displays a type-in field that is intended to be used primarily for searching for text in a document. Up and down arrow events trigger signals that can be hooked up to search forward or backward in a document.

In list mode, AlpScrollSelector widgets emit the following signals:

• "changed" - whenever the list item changes
• "selected" - when the scroll selector is dismissed (e.g. with a center press)
• "up" - when the up arrow key is pressed
• "down" - when the down arrow key is pressed

In text entry mode, AlpScrollSelector widgets emit the following signals:

• "changed" - whenever the entered text changes
• "selected" - when the scroll selector is dismissed (e.g. with a center press)
• "up" - when the up arrow key is pressed
• "down" - when the down arrow key is pressed

Users of the widget can get the current text associated with the selector using the function alp_scroll_selector_get_current_string(). In addition, in list mode, users can get the index of the current item in the list with alp_scroll_selector_get_current_index().

#include <gdk/gdk.h>
#include <gtk/gtk.h>

Go to the source code of this file.

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.

---

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

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