This widget is mostly used for colour selectors to achieve a compact
repestation of what will the impact of adjusting a slider to the resulting
colour.
A slider widget with coloured background.
Color Slider
The GPE Colour selection dialog is a smal and fast dialog to select
free defineable RGB colour values. In contrast to #GtkColorDialog it
is much faster and simpler to fit the needs of mobile devices.
The GPE Colour selection dialog
Color Dialog
This interface provides a simple function to open a directory browser
dialog.
Directory browser
Dirbrowser
These functions are used to display error messages. The output will take place in
an error dialog and on stderr.
Display error messages.
Error Messages
This widget is used to arrange icons in columns and rows. It provides functions
for user interactive actions clicking on a particular icon and methods to
manage icons in the list. This one is deprecated, use GpeIconListView in
new code.
Widget to arrange icons in columns and rows. (deprecated, will be removed soon)
GpeIconList
A widget to display an analogue clock face.
Used by: #GpeTimeSel widget, gpe-watch, gpe-clock
Clock face widget
GpeClockFace
Simple interface to provide a call for an external application
to display help information. Currently this is fixed to a list
of help browsers (gpe-helpviewer, gpe-mini-browser, dillo, minimo).
The help system is configured in /etc/gpe/gpe-help.conf.
For an example how to provide help for applications check out
gpe-edit.
Call external help browser.
GPE simple help
The GpeIconListItem represents a single item inside of a GpeIconListView.
Icon item to use with GpeIconListView
GpeIconListItem
This widget is used to arrange icons in columns and rows. It provides functions
for user interactive actions clicking on a particular icon and methods to
manage icons in the list.
Widget to arrange icons in columns and rows.
GpeIconListView
This widget is used to enter time values. It displays an editing field
for a time value and an extra button which opens a time selection popup.
Time selection widget
GpeTimeSel
An object maintaining a list of open windows. This can be used for
task managers and window selection applications.
Application window list.
GpeWindowList
The GtkDateCombo widget is used to display a formated date value. The display
format used for the date depends on the locale setting. Additionally this
widget provides a calendar popup for easy value changes. Direct editing
of the date value in the display entry of the widget is supported too.
Widget to display and alter a date.
GtkDateCombo
This widget provides a simple selection menu with an easy to use interface.
Simple menu widget
GtkSimpleMenu
Infoprints are short text messages usually displayed in a corner of the screen
to provide additional information for the user to show what is going on. These
messages are displayed for a short time and disappear from screen without
user interaction.
Displaying infoprints
Infoprints
Functions used for application initialisation.
Used by: Any GPE application.
Initialisation of applications
Init
GPE uses compact buttons containing a label and a pixmap for dialog buttons.
The PictureButton widget provides a simple interface dealing with these buttons.
A small button with label and pixmap.
PictureButton
GPE provides a set of functions for maintaining a shared icons to avoid
loading icon sets multiple times. These icons are loaded into an internal
storage list and identified by a name string.
Used by: Most GPE applications.
Handling pixmaps for applications.
Pixmaps
Functions used for popup and dock windows.
Used by: minilite, minimix
Popup window tools.
Popup
In order to construct popup menus for various purposes libgpewidget contains
some functions to make construction of this kind of menus easier.
Used by: gpe-sketchbook, gpe-word
Functions to construct popup menus.
Popup menus
These functions provide support for displaying simple interactive question
dialogs and handle the users answers.
Question Dialogs
Question
Functions to create a simple inputbox offering multiple selections or an
input field.
Small input box.
Smallbox
For creating graphical user interfaces with an unified look and feel it is
important to have a set of functions to provide spacing information.
The GPE spacing functions provide a basic set of functions for determining
the most frquently used sizes for GUI development.
Application GUI spacings
Spacing
Function to get information if GUI is set up for stylus
user input or not.
Stylus mode information.
Stylus Input
Support for widgets with "instant-apply" language switching.
Translation-aware GtkLabel variant
Translation label
Some functions that provide easier handling of applications that dock
to some kind of tray or panel. (e.g. a notification area of a Gnome panel
or a Matchbox-Panel.)
Used by: gpe-aerial, gpe-bluetooth, gpe-beam and gpe-buttonbox
Useful functions dealing with trays.
Tray Tools
windows
@v:
@o:
@k:
Maximum length of the colour description string.
@parent:
@dragging:
@adjustment:
@value:
@oldvalue:
@c0:
@c1:
@b0:
@b1:
@bmask:
@mapsize:
@map:
@priv:
@dispose_has_run:
@class:
@title:
@icon:
@udata:
@pb:
@pb_scaled:
@parent:
@class:
@screen:
@net_client_list_atom:
@net_active_window_atom:
@windows:
Macro to cast a an object (usually GtkWidget*) to GpeClockFace type.
@obj: Object to cast.
@obj:
@obj:
@obj:
Type checking macro.
@obj:
Macro to return class from object instance.
@obj:
The widget struct has no public members which should accessed directly.
@hbox:
@hour_adj:
@minute_adj:
@hour_spin:
@minute_spin:
@label:
@button:
@popup:
@clock:
@changing_time:
@hour_edit:
@minute_edit:
@p_hbox:
@dragging:
@editing:
@o:
@k:
@r:
@g:
@b:
@a:
@r:
@g:
@b:
@a:
@label:
@value:
@label:
@value:
@suggestions:
@Returns:
@adjustment:
@Returns:
@slider:
@adjustment:
@slider:
@dark:
@light:
@size:
@slider:
@start:
@end:
@slider:
@map:
Initialise a GPE application. This function is called on startup of a GPE
application. It replaces gtk_init() which is used in normal GTK applications.
@argc: argument count passed to main()
@argv: argument array passed to main()
@Returns: TRUE on success, FALSE on failure
Returns the shape mask of the given clockface widget. This is used to set up
a shaped window only containing a GtkClockFace widget.
@clock: Widget
@Returns: The widget's shape mask
Returns type for a GpeClockFace widget. Internally used to create a new
instance of a GpeClockFace.
@Returns: Object type
Create a new instance of a GpeClockFace widget.
@Param1: Adjustmennt for hour setting.
@Param2: Adjustment for minute setting.
@Param3: Adjustment for second setting.
@Returns: New GpeClockFace widget.
@clock:
@border:
Set wether to allow user interactive moving of the hands or not.
@clock: Widget
@yes: TRUE to allow, FALSE to deny
Change the width of clock hands.
@clock: Widget
@width: New with in pixels.
Turn hour labels on the clockface on/off.
@clock: Widget
@yes: TRUE to enable, FALSE to disable
Sets the radius of the clockface (in pixels).
@clock: Widget
@radius: New radius.
Set if the widget should use a background image.
@clock: Widget
@yes: TRUE to enable, FALSE to disable
@color_dialog:
@Returns:
@color_dialog:
@Returns:
@parent:
@flags:
@initcolor:
@Returns:
@color_dialog:
@new_color:
@color_dialog:
@colordesc:
Creates and opens a directory browser dialog.
@title: Dialog title
@current_path: Path to start with.
@mode: A selection mode to set in directory browser.
@handler: Function to handle directory selection.
@Returns: Dialof widget
Creates and shows normal, blocking error dialog.
@text: Error message
Shows a formated error message using a printf style argument list.
@format: Message format string
@Varargs: Argument list
Creates and shows a non-blocking error message.
@text: Error message
Get an icon by name from storage list.
@name: Icon name to find.
@Returns: Pixbuf pointer on success, NULL on failure.
[Deprecated - do not use.]
@name:
@pixmap:
@bitmap:
@Returns:
As GTK uses icons in several sizes for different purposes this function
renders a given icon to one of the common GTK icon sizes.
@name: Icon to use.
@size: GTK icon size to use.
@Returns: A new allocated pixbuf containing the icon of the desired size.
@name:
@width:
@height:
@Returns:
Get the size of borders around widgets. This is used for borders around windows
and dialogs mostly.
@Returns: Border size in pixels.
Returns spacings used to separate contents of boxes and tables.
@Returns: Spacing in pixels.
Returns size for identing of GUI categories.
@Returns: Size in pixels.
Returns spacing between categories.
@Returns: Size in pixels.
@dpy:
@list:
@nr:
@Returns:
Return a window's position.
@dpy: Display
@win: Window to query for position
@x: Pointer to X position
@y: Pointer to Y position
@Returns: TRUE on success, FALSE otherwise.
@dpy:
@w:
@Returns:
@dpy:
@w:
@Returns:
@dpy:
@w:
@property:
@Returns:
@dpy:
@w:
@instance:
@class:
@Returns:
@dpy:
@w:
@Returns:
@shortname:
@filename:
@pixbuf:
@i:
@b:
@i:
@b:
@i:
@Returns:
@Returns:
@i:
@view:
@i:
@pixbuf:
Add a new icon item to a GpeIconList widget.
@self: Widget
@title: Short text to label the icon.
@icon: Icon bitmap file.
@udata: Pointer to user data passed to signal handlers.
@Returns: New item widget
Add a new icon item to a GpeIconList widget using a GdkPixbuf for icon
data instead of a file.
@self: Widget
@title: Short text to label the icon.
@icon: Icon pixbuf.
@udata: Pointer to user data passed to signal handlers.
@Returns: New item widget
Removes all items from an icon list.
@self: Widget to clear
This function creates a new GpeIconListView widget.
@Returns: New widget
@self:
Remove an item from a GpeIconListView.
@self: Widget
@item: Item widget
Removes an item from an icon list identified by its user data.
@self: Widget
@udata: Data pointer to identify item.
Change widget background to a pixmap from a file.
@self: Widget
@bg: Bitmap file to display in background.
Change background color of icon list.
@self: Widget
@color: 32 bit integer defining the color.
Set the widget background from a GdkPixbuf.
@self: Widget
@bg: Pixbuf to use for background.
This function is used to set the colour of the icon lists border.
@self: Widget
@color: New border color
This function is used to change the width of the icon lists border.
@self: Widget
@width: New width in pixels
Turn bold text for selected items on/off.
@self: Widget
@yes: Set TRUE to enable bold text, FALSE to disable.
Changes the size of the icons displayed in the icon list view.
@self: Widget
@size: Size in pixels
Change margin in X dimension for icons inside a GpeIconListView.
@self: Widget
@margin: Margin in pixels
Updates the icon of a list view item.
@self: Widget
@item: Item of icon list to become updated.
@new_pixbuf: GdkPixbuf containing the new icon.
Sets the number of rows used for arranging icons.
@self: Widget
@rows: Number of rows
Turn titles on/off.
@self: Widget
@yes: Set TRUE to enable, FALSE to disable.
This function sets the position of the descriptive text of items.
@self: Widget
@textpos: Text position
Updates the icon of an item identified by its user data.
@self: Widget
@pixbuf: GdkPixbuf containing the new icon.
@udata: Data pointer to identify item.
Add a new icon item to a GpeIconList widget.
@self: Widget
@title: Short text to label the icon.
@icon: Icon bitmap file.
@udata: Pointer to user data passed to signal handlers.
@Returns: New item widget
Add a new icon item to a GpeIconList widget using a GdkPixbuf for icon
data instead of a file.
@self: Widget
@title: Short text to label the icon.
@icon: Icon pixbuf.
@udata: Pointer to user data passed to signal handlers.
@Returns: New item widget
Removes all items from an icon list.
@self: Widget to clear
Emits the clicked signal for a GpeIconList widget.
@self: Iconlist widget
@udata: User data to pass to the signal handler.
@object:
@func:
@data:
@object:
@func:
@data:
@object:
@func:
@data:
@object:
@func:
@data:
@object:
@func:
@data:
@destroy_data:
@flags:
@object:
@func:
@data:
@destroy_data:
@flags:
This function creates a new GpeIconList widget.
@Returns: New widget
@self:
Remove an item from a GpeIconList.
@self: Widget
@item: Item widget
Change widget background to a pixmap from a file.
@self: Widget
@bg: Bitmap file to display in background.
Change background color of icon list.
@self: Widget
@color: 32 bit integer defining the color.
Set the widget background from a GdkPixbuf.
@self: Widget
@bg: Pixbuf to use for background.
Turn bold text for selected items on/off.
@self: Widget
@yes: Set TRUE to enable bold text, FALSE to disable.
Changes the size of the icons displayed in the icon list.
@self: Widget
@size: Size in pixels
Change margin in X dimension for icons inside a GpeIconList.
@self: Widget
@margin: Margin in pixels
Turn titles on/off.
@self: Widget
@yes: Set TRUE to enable, FALSE to disable.
Emits the show-popup signal for a GpeIconList widget.
@self: Iconlist widget
@udata: User data to pass to the signal handler.
This function is used to load a set of icons into memory and makes them
accessible for the applications. Usually you will have a fixed set of pixmaps
to load for each application on startup. The function will display an error
message if loading of an icon fails.
@Param1: List of icon defintions, terminated by NULL.
@Returns: TRUE on success.
Shows an error message with perror style information.
@text: Error message
Shows an error message with perror style information, non-blocking version.
@text: Error message
Displays an infoprint on a given X display. Usually you want to use current
X display which is determined by GDK_DISPLAY().
@dpy: Xlib display
@s: Message to show
This functions is used to determine a popup menu's position on screen. This is
usually used for constructing popup menus.
@menu: Popup menu to get position of.
@x: Pointer to X position
@y: Pointer to Y position
@push: (unused)
@p: Widget
Opens a blocking question dialog presenting a variable set of buttons to select
an answer from. The buttons may contain icons. Button definitions are passed
to the function in a list containing both label text and icon name for each button.
The label ist the first part of the button definition, the icon name the second.
To indicate a stock icon prepend the name by a '!' character.
It is possible to add buttons without icons setting using NULL for the icon
parameter.
@qn: Question text
@title: Dialog title
@iconname: GPE icon to use (needs to be loaded before calling this function)
@Varargs: Variable list of icon definitions. Terminate list with NULL.
@Returns: Position of button clicked.
[Deprecated, do not use.]
@qn:
@Returns:
[obsolete, use gtk_image_new_from_pixbuf()]
@style:
@pixbuf:
@Returns:
=======
>>>>>>> 1.4
Returns the arguments passed to gpe_application_init(). The returned values are
pointers to the data stored by gpe_application_init(), don't modify them if
you don't exactly know what are you doing.
@argc: Filled with number of arguments in argv.
@argv: Argument vector.
@theme_name:
Set the icon of a window from a named icon in storage list.
@window: Window to set icon for.
@icon: Icon name.
@appname:
@topic:
@Returns:
@Returns:
@window:
@id:
@window:
@window:
@text:
@timeout:
@Returns:
Retrieve current time value from a GpeTimeSel. The time is split up into
separate values for hour and minute.
@sel: Widget
@hour: Value to hold selected hour.
@minute: Value to hold selected minute.
This method is used to create a new GpeTimeSel widget.
@Returns: New widget
Set the time of the time selectior. We set hour and minute in separate
values passed to the method.
@sel: Widget
@hour: Hour value to set.
@minute: Minute value to set.
This function is used to get an icon which is not necessarily loaded when
the function is called. The icon is taken from internal storage if it is
already available and tried to load from a file with the same name like
the name passed to the function otherwise.
@name: Icon name to get.
@error: Returned error information if function fails.
@Returns: Pixbuf of icon or NULL on failure.
@Param1:
@Returns:
@Param1:
@Returns:
Remove all settings/values from a date combo.
@dp: Widget
If this function is enabled the widget will show and take dates without a
year value. This is used for recurring events like holidays and birthdays.
Default behaviour is to have dates including a year.
@Param1: Widget
@Param2: TRUE to enable, FALSE to disable
Creates a new GtkDateCombo widget.
@Returns: New Widget
Set the date of a GtkDateCombo widget. The date is defined with three separate
values representating year, month and date.
@Param1: Widget
@year: Year value to set
@month: Month value
@day: Day
This method changes the display behaviour of the calendar popup.
It will display a week starting sunday if set to FALSE, if set to TRUE
weeks will be displayed starting monday.
@Param1: Widget
@Param2: TRUE to have weeks starting monday, FALSE otherwise.
@pixmap:
@val:
@mask:
@pixmap:
@mask:
@Returns:
@pixmap:
@val:
@mask:
@pixmap:
@val:
@pixmap:
@build:
@pixmap:
@val:
@pixmap:
@val:
@domain:
@string:
@Returns:
@sel:
@item:
@items:
@sel:
@sel:
@Returns:
@Returns:
@w:
@func:
@data:
Create a new menu button containing a given widget.
@child: Widget to put into the menu button.
@Returns: New menu button.
Create a menu buton containing a stock item.
@stock_id: Id of the stock item to use.
@Returns: New menu button.
Create a menu button for color selection.
@Returns: A new menu button.
Create a menu button for font selection.
@Returns: A new menu button.
Close a popup menu.
@parent_button: Menu button the menu belongs to.
This function displays an input dialog box to query a user for text input.
@title: Dialog title
@labeltext: Query text displayed inside the box.
@dval: Default value
@Returns: Entered text if user taps OK, NULL otherwise.
@title:
@d:
@Returns:
@title:
@d:
@Returns:
Data type to define text postioning relative to a displayed icon.
@GPE_TEXT_BELOW: Show text below the icon.
@GPE_TEXT_RIGHT: Show text right besides the icon.
This function the status of the menu attached to a menu button. If the menu is
shown the function hides it, if it is hidden the function shows it.
@parent_button: Menu button the menu belongs to.