16. Graphic User Interface
Module GTK
- Description
GTK wrapper module.
This is a convenience module that is identical to the latest supported GTK versionm, if available. Currently only
GTK2is possible.- See also
GTK2
Module GTK2
- Methodadd_builtin_icon
voidadd_builtin_icon(stringname,intsize,GTK2.GdkPixbufpixbuf)- Description
Registers a built-in icon for icon theme lookups. The idea of build-in icons is to allow an application or library that uses themed icons to function requiring files to be present in the file system. For instance, the default images for all of GTK2+'s stock icons are registered as built-in icons.
In general, if you use add_builtin_icon() you should also install the icon in the icon theme, so that the icon is generally available.
- Methodflush
voidflush()- Description
Flush GDK. Not normally needed, can be useful while doing calculations.
- Methodget_default_icon_list
arrayget_default_icon_list()- Description
Gets the value set by set_default_icon_list().
- Methodget_file_info
mappingget_file_info(stringfilename)- Description
Parses an image file far enough to determine its format and size.
- Methodgnome_init
arraygnome_init(stringapp_id,stringapp_version,arrayargv)- Description
Initializes the application. This sets up all of the GNOME internals and prepares them (gdk/gtk, session-management, triggers, sound, user preferences). If corba init flags are specified, corba initialization is done as well as gnome initialization. corba_init_flags is 0 or more of GNORBA_INIT_SERVER_FUNC (1), GNORBA_INIT_DISABLE_COOKIES (2) and GNORBA_INIT_CORBA_PRIO_HIGH (4)
- Methodgtk_init
arraygtk_init(array|voidargc,int|voidno_pgtkrc)- Description
Low level GTK init function (used by setup_gtk). This function is more or less equivalent to the C-GTK+ function gtk_init. setup_gtk does some extra things (such as parsing ~/.pgtkrc).
- Methodlist_toplevels
arraylist_toplevels()- Description
Returns a list of all existing toplevel windows.
- Methodmain
voidmain()- Description
Start GTK in blocking mode. Doing this disables asynchronous I/O in pike. You can return -1 from main in pike to run GTK (and the rest of pike) in asynchronous mode.
- Methodmain_iteration_do
intmain_iteration_do(intblock)- Description
Run one iteration in the mainloop. If block is true, wait for an event before returning.
- Methodmove_cursor
voidmove_cursor(intdx,intdy)- Description
Move the mouse-cursor dx,dy pixels, relative to it's current position. This will generate a normal motion event.
Note that this is a low-level X11 function, and thus only works when GDK uses X11.
- Methodmove_cursor_abs
voidmove_cursor_abs(GTK2.GdkWindoww,intdx,intdy)- Description
Move the mouse-cursor to x,y, relative to the upper left corner of the specified window. This will generate a normal motion event.
Note that this is a low-level X11 function, and thus only works when GDK uses X11.
- Methodroot_window
GTK2.GdkWindowroot_window()- Description
Returns the root window of the current display
- Methodsaver_disable
voidsaver_disable()- Description
Disable the screensaver. This is a low-level X11 function, and thus only works when GDK uses X11
- Methodsaver_enable
voidsaver_enable()- Description
Enable the screensaver again after
saver_disablehas been called. This is a low-level X11 function, and thus only works when GDK uses X11.
- Methodset_auto_startup_notification
voidset_auto_startup_notification(intsetting)- Description
By default, after showing the first GTK2.Window for each GDK2.Screen, GTK+ calls GDK2.Screen->notify_startup_complete(). Call this function to disable the automatic startup notification. You might do this if your first window is a splash screen, and you want to delay notification until after your real main window has been shown, for example.
In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main window would automatically result in notification.
- Methodset_default_icon
voidset_default_icon(GTK2.GdkPixbufpix)- Description
Sets an icon to be used as fallback for windows that haven't had set_icon() called on them.
- Methodset_default_icon_from_file
voidset_default_icon_from_file(stringfilename)- Description
Sets an icon to be used as fallback from a file on disk.
- Methodset_default_icon_list
voidset_default_icon_list(arraylist)- Description
Sets an icon list to be used as fallback for windows that haven't had set_icon_list() called on them to set up a window-specific icon list. This function allows you to set up the icon for all windows in your app at once.
- Methodset_default_icon_name
voidset_default_icon_name(stringname)- Description
Sets an icon to be used as fallback for windows that haven't had set_icon_list() called on them from a named themed icon.
- Methodsetup_gtk
arraysetup_gtk(array|voidargv,int|voiddo_not_parse_rc)- Description
Initialize GTK, and all that comes with it. Also parses $HOME/.pgtkrc and $HOME/.gtkrc if they exists. The single argument, if supplied, is the argument array passed to the program. This is used to set default window titles etc. The second argument, if supplied, indicates that pike specific *rc files should not be parsed.
The most common usage is GTK2.setup_gtk(argv);
Class GTK2.AboutDialog
- Description
Properties: array(string) artists array(string) authors string comments string copyright array(string) documenters string license GDK2.Pixbuf logo string logo-icon-name string name string translator-credits string version string website string website-label
Style properties: GDK2.Color link-color
- Methodcreate
GTK2.AboutDialogGTK2.AboutDialog(mapping|voidprops)- Description
Create a new GTK2.AboutDialog.
- Methodget_artists
arrayget_artists()- Description
Returns the strings which are displayed in the artists tab of the secondary credits dialog.
- Methodget_authors
arrayget_authors()- Description
Returns the strings which are displayed in the authors tab of the secondary credits dialog.
- Methodget_documenters
arrayget_documenters()- Description
Returns the strings which are displayed in the documenters tab of the secondary credits dialog.
- Methodget_website_label
stringget_website_label()- Description
Returns the label used for the website link.
- Methodget_wrap_license
intget_wrap_license()- Description
Returns whether the license text is automatically wrapped.
- Methodset_artists
GTK2.AboutDialogset_artists(arrayart)- Description
Sets the strings which are displayed in the artists tab of the secondary credits dialog.
- Methodset_authors
GTK2.AboutDialogset_authors(arrayauth)- Description
Sets the strings which are displayed in the authors tab of the secondary credits dialog.
- Methodset_copyright
GTK2.AboutDialogset_copyright(stringcopyright)- Description
Sets the copyright string.
- Methodset_documenters
GTK2.AboutDialogset_documenters(arraydoc)- Description
Sets the strings which are displayed in the documenters tab of the secondary credits dialog.
- Methodset_logo
GTK2.AboutDialogset_logo(GTK2.GdkPixbuflogo)- Description
Sets the pixbuf to be displayed as the logo.
- Methodset_logo_icon_name
GTK2.AboutDialogset_logo_icon_name(stringname)- Description
Sets the icon name.
- Methodset_program_name
GTK2.AboutDialogset_program_name(stringname)- Description
Sets the name to display in the dialog.
- Methodset_translator_credits
GTK2.AboutDialogset_translator_credits(stringcredits)- Description
Sets the translator credits.
- Methodset_website
GTK2.AboutDialogset_website(stringwebsite)- Description
Sets the URL to use for the website link.
- Methodset_website_label
GTK2.AboutDialogset_website_label(stringlabel)- Description
Sets the label used for the website link. Defaults to the website URL.
Class GTK2.AccelGroup
- Description
An AccelGroup stores keybindings. A group is automatically created by W(MenuFactory)
NOIMG
Signals: accel_activate
accel_changed
- Methodconnect
GTK2.AccelGroupconnect(intaccel_key,intaccel_mods,intaccel_flags,function(:void)cb,mixeduser_data)- Description
Installs an accelerator in this group.
- Methodconnect_by_path
GTK2.AccelGroupconnect_by_path(stringaccel_path,function(:void)cb,mixeduser_data)- Description
Installs an accelerator in this group, using an accelerator path to look up the appropriate key and modifiers.
- Methoddisconnect
GTK2.AccelGroupdisconnect(intaccel_key,intaccel_mods)- Description
Removes an accelerator previously installed.
Class GTK2.AccelLabel
- Description
A label for accelerators. Properties: GTK2.Widget accel-widget
- Methodcreate
GTK2.AccelLabelGTK2.AccelLabel(string|mappingtext_or_props)- Description
Creates a new W(AccelLabel).
- Methodget_accel_widget
GTK2.Widgetget_accel_widget()- Description
Fetches the widget monitored by this accelerator label.
- Methodget_accel_width
intget_accel_width()- Description
Returns the width needed to display the accelerator key(s). This is used by menus to align all of the W(MenuItem).
- Methodrefetch
intrefetch()- Description
Recreates the string representing the accelerator keys. This should not be needed since the string is automatically updated whenever accelerators are added or removed from the associated widget.
Class GTK2.Action
- Description
Properties: GTK2.ActionGroup action-group int hide-if-empty int is-important string label string name int sensitive string short-label string stock-id string tooltip int visible int visible-horizontal int visible-overflown int visible-vertical
Signals: activate
- Methodblock_activate_from
GTK2.Actionblock_activate_from(GTK2.Widgetproxy)- Description
Disables calls to the activate() function by signals on the proxy. This is used to break notification loops for things like check or radio actions.
- Methodconnect_accelerator
GTK2.Actionconnect_accelerator()- Description
Installs the accelerator if this action widget has an accel path and group.
- Methodconnect_proxy
GTK2.Actionconnect_proxy(GTK2.Widgetproxy)- Description
Connects a widget to an action object as a proxy. Synchronises various properties of the action with the widget (such as label text, icon, tooltip, etc), and attaches a callback so that the action gets activated when the proxy widget does.
- Methodcreate
GTK2.ActionGTK2.Action(string|mappingname_or_props,string|voidlabel,string|voidtooltip,string|voidstock_id)- Description
Creates a new object.
- Methodcreate_icon
GTK2.Widgetcreate_icon(inticon_size)- Description
This function is intended for use by action implementations to create icons displayed in the proxy widgets. One of
ICON_SIZE_BUTTON,ICON_SIZE_DIALOG,ICON_SIZE_DND,ICON_SIZE_INVALID,ICON_SIZE_LARGE_TOOLBAR,ICON_SIZE_MENUandICON_SIZE_SMALL_TOOLBAR.
- Methodcreate_menu
GTK2.Widgetcreate_menu()- Description
If this action provides a W(Menu) widget as a submenu for the menu item or the toolbar item it creates, this function returns an instance of that menu.
- Methodcreate_menu_item
GTK2.Widgetcreate_menu_item()- Description
Creates a menu item widget that proxies for the action.
- Methodcreate_tool_item
GTK2.Widgetcreate_tool_item()- Description
Creates a toolbar item widget that proxies for the action.
- Methoddisconnect_accelerator
GTK2.Actiondisconnect_accelerator()- Description
Undoes the effect of one call to connect_accelerator().
- Methoddisconnect_proxy
GTK2.Actiondisconnect_proxy(GTK2.Widgetproxy)- Description
Disconnects a proxy widget. Does not destroy the widget.
- Methodget_sensitive
intget_sensitive()- Description
Returns whether the action itself is sensitive. Note that this doesn't necessarily mean effective sensitivity.
- Methodset_accel_group
GTK2.Actionset_accel_group(GTK2.AccelGroupgroup)- Description
Sets the GTK2.AccelGroup in which the accelerator for this action will be installed.
- Methodset_accel_path
GTK2.Actionset_accel_path(stringaccel_path)- Description
Sets the accel path for this action. All proxy widgets associated with this action will have this accel path, so that their accelerators are consistent.
Class GTK2.ActionGroup
- Description
Actions are organized into groups. An action group is essentially a map from names to GTK2.Action objects.
All actions that would make sense to use in a particular context should be in a single group. Multiple action groups may be used for a particular user interface. In fact, it is expected that most non-trivial applications will make use of multiple groups. For example, in an application that can edit multiple documents, one group holding global actions (e.g. quit, about, new), and one group per document holding actions that act on that document (eg. save, cut/copy/paste, etc). Each window's menus would be constructed from a combination of two action groups.
Accelerators are handled by the GTK2+ accelerator map. All actions are assigned an accelerator path (which normally has the form <Actions>/group-name/action-name) and a shortcut is associated with this accelerator path. All menuitems and toolitems take on this accelerator path. The GTK2+ accelerator map code makes sure that the correct shortcut is displayed next to the menu item. Properties: string name int sensitive int visible
Signals: connect_proxy
disconnect_proxy
post_activate
pre_activate
- Methodadd_action
GTK2.ActionGroupadd_action(GTK2.Actionaction,string|voidaccelerator)- Description
Adds an action object to the action group and sets up the accelerator.
If accelerator is omitted, attempts to use the accelerator associated with the stock_id of the action.
Accel paths are set to <Actions>/group-name/action-name.
- Methodadd_actions
GTK2.ActionGroupadd_actions(arrayentries)- Description
This is a convenience function to create a number of actions and add them to the action group.
The "activate" signals of the actions are connect to the callbacks and their accel paths are set to <Actions>/group-name/action-name.
Mapping is: ([ "name": string, "stock_id": string, "label": string, "accelerator": string, "tooltip": string, "callback": function(callback) "data": mixed ]);
- Methodadd_radio_actions
GTK2.ActionGroupadd_radio_actions(arrayentries,function(:void)cb,mixeduser_data)- Description
This is a convenience routine to create a group of radio actions and add them to the action group.
Mapping is: ([ "name": string, "stock_id": string, "label": string, "accelerator": string, "tooltip": string, "value": int ]);
- Methodadd_toggle_actions
GTK2.ActionGroupadd_toggle_actions(arrayentries)- Description
This is a convenience function to create a number of toggle actions and add them to the action group.
Mapping is: ([ "name": string, "stock_id": string, "label": string, "accelerator": string, "tooltip": string, "callback": function(callback), "data": mixed, "is_active": int ]);
- Methodcreate
GTK2.ActionGroupGTK2.ActionGroup(string|mappingname_or_props)- Description
Creates a new GTK2.ActionGroup object. The name of the action group is used when associating keybindings with the actions.
- Methodget_action
GTK2.Actionget_action(stringname)- Description
Looks up an action in the action group by name.
- Methodget_sensitive
intget_sensitive()- Description
Returns true if the group is sensitive. The constituent actions can only be logically sensitive if they are sensitive and their group is sensitive.
- Methodget_visible
intget_visible()- Description
Returns true if the group is visible. The constituent actions can only be logically visible if they are visible and their group is visible.
- Methodremove_action
GTK2.ActionGroupremove_action(GTK2.Actionaction)- Description
Removes an action object.
Class GTK2.Activatable
- Description
Activatable widgets can be connected to a GTK.Action and reflects the state of its action. A GTK.Activatable can also provide feedback through its action, as they are responsible for activating their related actions. Properties: GTK2.Action related-action int use-action-apperance
- Methodget_use_action_appearance
intget_use_action_appearance()- Description
Gets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance.
- Methodset_related_action
GTK2.Activatableset_related_action(GTK2.Actiona)- Description
Sets the related action
Class GTK2.Adjustment
- Description
The GTK2.Adjustment object represents a value which has an associated lower and upper bound, together with step and page increments, and a page size. It is used within several GTK2+ widgets, including GtkSpinButton, GtkViewport, and GtkRange (which is a base class for GtkHScrollbar, GtkVScrollbar, GtkHScale, and GtkVScale).
The GtkAdjustment object does not update the value itself. Instead it is left up to the owner of the GtkAdjustment to control the value.
The owner of the GtkAdjustment typically calls the value_changed() and changed() functions after changing the value or its bounds. This results in the emission of the "value_changed" or "changed" signal respectively.
Properties: float lower float page-increment float page-size float step-increment float upper float value
Signals: changed The adjustment changed in some way
value_changed The value changed
- Methodclamp_page
GTK2.Adjustmentclamp_page(floatlower,floatupper)- Description
Updates the W(Adjustment) value to ensure that the range between lower and upper is in the current page (i.e. between value and value+page_size). If the range is larger than the page size, then only the start of it will be in the current page. A "changed" signal will be emitted if the value is changed.
- Methodcreate
GTK2.AdjustmentGTK2.Adjustment(float|mappingvalue_or_props,float|voidlower,float|voidupper,float|voidstep_increment,float|voidpage_increment,float|voidpage_size)- Description
The value argument is the initial value you want to give to the adjustment, usually corresponding to the topmost or leftmost position of an adjustable widget. The lower argument specifies the lowest value which the adjustment can hold. The step_increment argument specifies the "smaller" of the two increments by which the user can change the value, while the page_increment is the "larger" one. The page_size argument usually corresponds somehow to the visible area of a panning widget. The upper argument is used to represent the bottom most or right most coordinate in a panning widget's child. Therefore it is not always the largest number that value can take, since the page_size of such widgets is usually non-zero.
All values are optional, they default to 0.0. For most widgets the unit is pixels.
- Methodset_value
GTK2.Adjustmentset_value(floatto)- Description
Sets the value. The value is clamped to lie between lower and upper.
Note that for adjustments which are used in a W(Scrollbar), the effective range of allowed values goes from lower to upper-page_size.
Class GTK2.Alignment
- Description
The W(Alignment) widget controls the alignment and size of its child widget. It has four settings: xscale, yscale, xalign, and yalign.
The scale settings are used to specify how much the child widget should expand to fill the space allocated to the W(Alignment). The values can range from 0 (meaning the child doesn't expand at all) to 1 (meaning the child expands to fill all of the available space).
The align settings are used to place the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). Of course, if the scale settings are both set to 1, the alignment settings have no effect.
NOIMG Properties: int bottom-padding int left-padding int right-padding int top-padding float xalign float xscale float yalign float yscale
- Methodcreate
GTK2.AlignmentGTK2.Alignment(float|mappingxalign_or_props,float|voidyalign,float|voidxscale,float|voidyscale)- Description
xalign : the horizontal alignment of the child widget, from 0 (left) to 1 (right). yalign : the vertical alignment of the child widget, from 0 (top) to 1 (bottom). xscale : the amount that the child widget expands horizontally to fill up unused space, from 0 to 1. A value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the GTK2.Alignment. yscale : the amount that the child widget expands vertically to fill up unused space, from 0 to 1. The values are similar to xscale.
- Methodset
GTK2.Alignmentset(floatxalign,floatyalign,floatxscale,floatyscale)- Description
xalign : the horizontal alignment of the child widget, from 0 (left) to 1 (right). yalign : the vertical alignment of the child widget, from 0 (top) to 1 (bottom). xscale : the amount that the child widget expands horizontally to fill up unused space, from 0 to 1. A value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the GTK2.Alignment. yscale : the amount that the child widget expands vertically to fill up unused space, from 0 to 1. The values are similar to xscale.
Class GTK2.Arrow
- Description
An arrow pointing in one of four directions. The 'etched' shadow types does not work.
GTK2.Arrow(GTK2.ARROW_UP, GTK2.SHADOW_OUT)
GTK2.Arrow(GTK2.ARROW_LEFT, GTK2.SHADOW_IN)
GTK2.Arrow(GTK2.ARROW_RIGHT, GTK2.SHADOW_IN)
GTK2.Arrow(GTK2.ARROW_DOWN, GTK2.SHADOW_OUT)
Properties: int arrow-type
ARROW_DOWN,ARROW_LEFT,ARROW_RIGHTandARROW_UPint shadow-typeSHADOW_ETCHED_IN,SHADOW_ETCHED_OUT,SHADOW_IN,SHADOW_NONEandSHADOW_OUT
- Methodcreate
GTK2.ArrowGTK2.Arrow(int|mappingarrow_type_or_props,int|voidshadow_type)- Description
First argument is one of
ARROW_DOWN,ARROW_LEFT,ARROW_RIGHTandARROW_UP, second one ofSHADOW_ETCHED_IN,SHADOW_ETCHED_OUT,SHADOW_IN,SHADOW_NONEandSHADOW_OUT.
Class GTK2.AspectFrame
- Description
A W(Frame) widget that always maintain a specified ratio between width and height. width/height == ratio
GTK2.AspectFrame("Title",0.5,0.5,0.4,0)->add( GTK2.Label("Wrong aspect"))->set_size_request(200,200)
Properties: int obey-child float ratio float xalign float yalign
- Methodcreate
GTK2.AspectFrameGTK2.AspectFrame(mapping|stringlabel,float|voidxalign,float|voidyalign,float|voidratio,int|voidobey_child)- Description
Create a new frame. Arguments are label, xalign, yalign, ratio, obey_child xalign is floats between 0 and 1, 0.0 is upper (or leftmost), 1.0 is lower (or rightmost). If 'obey_child' is true, the frame will use the aspect ratio of it's (one and only) child widget instead of 'ratio'.
- Methodset
GTK2.AspectFrameset(floatxalign,floatyalign,floatratio,intobey_child)- Description
Set the aspec values. Arguments are xalign, yalign, ratio, obey_child xalign is floats between 0 and 1, 0.0 is upper (or leftmost), 1.0 is lower (or rightmost). If 'obey_child' is true, the frame will use the aspect ratio of it's (one and only) child widget instead of 'ratio'.
Class GTK2.Assistant
- Description
Properties:
int complete GDK2.Pixbuf header-image GTK2.AssistantPageType page-type GDK2.Pixbuf sidebar-image string title
Style properties:
int content-padding int header-padding
Signals: apply
cancel
close
prepare A GTK2.Assistant is a widget used to represent a generally complex operation splitted in several steps, guiding the user through its pages and controlling the page flow to collect the necessary data.
- Methodadd_action_widget
GTK2.Assistantadd_action_widget(GTK2.Widgetchild)- Description
Adds a widget to the action area.
- Methodget_current_page
intget_current_page()- Description
Returns the page number of the current page. Returns -1 if there are no pages.
- Methodget_nth_page
GTK2.Widgetget_nth_page(intpage_num)- Description
Returnss the child widget contained in page number page_num.
- Methodget_page_complete
intget_page_complete(GTK2.Widgetpage)- Description
Gets whether page is complete.
- Methodget_page_header_image
GTK2.GdkPixbufget_page_header_image(GTK2.Widgetpage)- Description
Gets the header image for page.
- Methodget_page_side_image
GTK2.GdkPixbufget_page_side_image(GTK2.Widgetpage)- Description
Gets the side image for page.
- Methodinsert_page
intinsert_page(GTK2.Widgetpage,intpos)- Description
Inserts a page at a given position. If pos equals -1 it will append the page.
- Methodremove_action_widget
GTK2.Assistantremove_action_widget(GTK2.Widgetchild)- Description
Removes a widget from the action area.
- Methodset_current_page
GTK2.Assistantset_current_page(intpage_num)- Description
Switches the page to page_num.
- Methodset_forward_page_func
GTK2.Assistantset_forward_page_func(function(:void)f,mixeddata)- Description
Set the forward page function.
- Methodset_page_complete
GTK2.Assistantset_page_complete(GTK2.Widgetpage,intcomplete)- Description
Sets whether page contents are complete. This will make assistant update the buttons state to be able to continue the task.
- Methodset_page_header_image
GTK2.Assistantset_page_header_image(GTK2.Widgetpage,GTK2.GdkPixbufpixbuf)- Description
Sets a header image for page. This image is displayed in the header area of the assistant when page is the current page.
- Methodset_page_side_image
GTK2.Assistantset_page_side_image(GTK2.Widgetpage,GTK2.GdkPixbufpixbuf)- Description
Sets a side image for page. This image is displayed in the side area of the assistant when page is the current page.
- Methodset_page_title
GTK2.Assistantset_page_title(GTK2.Widgetpage,stringtitle)- Description
Sets a title for page. The title is displayed in the header area of the assistant when page is the current page.
- Methodset_page_type
GTK2.Assistantset_page_type(GTK2.Widgetpage,inttype)- Description
Sets the page type for page. The page type determines the page behavior.
- Methodupdate_buttons_state
GTK2.Assistantupdate_buttons_state()- Description
Forces the assistant to recompute the buttons state.
GTK+ automatically takes care of this in most situations, e.g. when the user goes to a different page, or when the visibility or completeness of a page changes.
One situation where it can be necessary to call this function is when changing a value on the current page affects the future page flow of the assistant.
Class GTK2.Bin
- Description
A container that can only contain one child.
Class GTK2.Box
- Description
A box is a container that can contain more than one child. The basic 'Box' class cannot be instantiated, it is a virtual class that only defines some common 'Box' functions shared with all other Box widgets. Properties: int homogeneous int spacing
Child properties: int expand int fill int pack-type int padding int position
- Methodpack_end
GTK2.Boxpack_end(GTK2.Widgetwidget,intexpandp,intfillp,intpadding)- Description
Pack from the right (or bottom) of the box. Arguments are widget, expand, fill, paddingb widget, expand, fill, padding
- Methodpack_end_defaults
GTK2.Boxpack_end_defaults(GTK2.Widgetwidget)- Description
The argument is the widget to add.
- Methodpack_start
GTK2.Boxpack_start(GTK2.Widgetwidget,intexpandp,intfillp,intpadding)- Description
Pack from the left (or top) of the box. Argument are widget, expand, fill, padding pack(widget,1,1,0) is equivalent to 'add' or 'pack_start_defaults'
- Methodpack_start_defaults
GTK2.Boxpack_start_defaults(GTK2.Widgetwidget)- Description
The argument is the widget to add. This function is equivalent to 'add'
- Methodquery_child_packing
mappingquery_child_packing(GTK2.Widgetchild)- Description
Return a mapping: ([ "expand":expandp, "fill":fillp, "padding":paddingp, "type":type ])
- Methodreorder_child
GTK2.Boxreorder_child(GTK2.Widgetchild,intnew_position)- Description
Move widget to pos, pos is an integer, between 0 and sizeof(box->children())-1
- Methodset_child_packing
GTK2.Boxset_child_packing(GTK2.Widgetchild_widget,intexpandp,intfillp,intpadding,intpack_type)- Description
widget, expand, fill, padding, pack_type. If exand is true, the widget will be expanded when the box is resized. If 'fill' is true, the widget will be resized to fill up all available space. Padding is the amount of padding to use, and pack_type is one of
PACK_DIRECTION_BTT,PACK_DIRECTION_LTR,PACK_DIRECTION_RTL,PACK_DIRECTION_TTB,PACK_ENDandPACK_START.You can emulate pack_start and pack_end with add and set_child_packing.
- Methodset_homogeneous
GTK2.Boxset_homogeneous(inthomogeneousp)- Description
If true, all widgets in the box will get exactly the same amount of space
Class GTK2.Button
- Description
A container that can only contain one child, and accepts events. draws a bevelbox around itself.
GTK2.Button("A button")
GTK2.Button("A button\nwith multiple lines\nof text")
GTK2.Button()->add(GTK2.Image(GTK2.GdkImage(0)->set(Image.Image(100,40)->test())))
Properties: int focus-on-click GTK2.Widget image int image-position string label int relief int use-stock int use-underline float xalign float yalign
Style properties: int child-displacement-x int child-displacement-y GTK2.Border default-border GTK2.Border default-outside-border int displace-focus int image-spacing int inner-border
Signals: activate
clicked Called when the button is pressed, and then released
enter Called when the mouse enters the button
leave Called when the mouse leaves the button
pressed Called when the button is pressed
released Called when the button is released
- Methodcreate
GTK2.ButtonGTK2.Button(string|mappinglabel_or_props)- Description
If a string is supplied, a W(Label) is created and added to the button.
- Methodget_focus_on_click
intget_focus_on_click()- Description
Returns whether the button grabs focus when it is clicked.
- Methodget_image
GTK2.Widgetget_image()- Description
Gets the widget that is currently set as the image of the button.
- Methodget_image_position
intget_image_position()- Description
Gets the position of the image relative to the text inside the button.
- Methodget_relief
intget_relief()- Description
One of
RELIEF_HALF,RELIEF_NONEandRELIEF_NORMAL, set with set_relief()
- Methodget_use_underline
intget_use_underline()- Description
Returns whether an embedded underline in the button indicates a mnemonic.
- Methodset_alignment
GTK2.Buttonset_alignment(floatxalign,floatyalign)- Description
Sets the alignment of the child.
- Methodset_focus_on_click
GTK2.Buttonset_focus_on_click(intfocus_on_click)- Description
Sets whether the button will grab focus when it is clicked.
- Methodset_image
GTK2.Buttonset_image(GTK2.Widgetwidget)- Description
Set the image of the button to the given widget. Note that it depends on the gtk-button-images setting whether the image will be displayed or not.
- Methodset_image_position
GTK2.Buttonset_image_position(intposition)- Description
Sets the position of the image relative to the text inside the button.
- Methodset_relief
GTK2.Buttonset_relief(intnewstyle)- Description
One of
RELIEF_HALF,RELIEF_NONEandRELIEF_NORMAL
- Methodset_use_stock
GTK2.Buttonset_use_stock(intuse_stock)- Description
If true, the label set on the button is used as a stock id to select the stock item for the button.
Class GTK2.ButtonBox
- Description
More or less equivalent to a normal box, but you can set a few layout schemes that are not available for normal boxes. See the hbox and vbox documentation for examples. Properties: int layout-style
Child properties: int secondary
Style properties: int child-internal-pad-x int child-internal-pad-y int child-min-height int child-min-width
- Methodget_child_secondary
intget_child_secondary(GTK2.Widgetchild)- Description
Returns whether child should appear in a secondary group of children.
- Methodget_layout
intget_layout()- Description
Returns the currently configured layout. One of
BUTTONBOX_DEFAULT_STYLE,BUTTONBOX_EDGE,BUTTONBOX_END,BUTTONBOX_SPREADandBUTTONBOX_START
- Methodset_child_secondary
GTK2.ButtonBoxset_child_secondary(GTK2.Widgetchild,intis_secondary)- Description
Sets whether child should appear in a secondary group of children.
Class GTK2.Calendar
- Description
A calendar widget.
GTK2.Calendar();
GTK2.Calendar()->select_day( 16 );
Properties: int day int month int no-month-change int show-day-names int show-heading int show-week-numbers int year
Signals: day_selected
day_selected_double_click
month_changed
next_month
next_year
prev_month
prev_year
- Methodget_date
mappingget_date()- Description
returns a mapping: ([ "year":year, "month":month, "day":day ])
- Methodget_marked_dates
arrayget_marked_dates()- Description
Returns an array (with 31 elements) with 1es and 0es.
- Methodselect_day
GTK2.Calendarselect_day(intday_of_month)- Description
Select a certain day of the currently selected month
- Methodset_display_options
GTK2.Calendarset_display_options(intoptions)- Description
Bitwise or of one or more of
CALENDAR_NO_MONTH_CHANGE,CALENDAR_SHOW_DAY_NAMES,CALENDAR_SHOW_HEADING,CALENDAR_SHOW_WEEK_NUMBERSandCALENDAR_WEEK_START_MONDAY.
Class GTK2.CellEditable
- Description
Interface for widgets which are used for editing cells.
Signals: editing_done
remove_widget
- Methodediting_done
GTK2.CellEditableediting_done()- Description
Emits the "editing-done" signal. This signal is a sign for the cell renderer to update its value from the cell.
- Methodremove_widget
GTK2.CellEditableremove_widget()- Description
Emits the "remove-widget" signal. This signal is meant to indicate that the cell is finished editing, and the widget may now be destroyed.
Class GTK2.CellLayout
- Description
An interface for packing cells.
- Methodadd_attribute
GTK2.CellLayoutadd_attribute(GTK2.CellRenderercell,stringattribute,intcolumn)- Description
Adds an attribute mapping.
- Methodclear
GTK2.CellLayoutclear()- Description
Unsets all the mappings on all renderers and removes all renderers.
- Methodclear_attributes
GTK2.CellLayoutclear_attributes(GTK2.CellRenderercell)- Description
Clears all existing attributes.
- Methodpack_start
GTK2.CellLayoutpack_start(GTK2.CellRenderercell,intexpand)- Description
Packs the cell into the beginning. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divied evenly between the cells for which expand is true.
- Methodreorder
GTK2.CellLayoutreorder(GTK2.CellRenderercell,intposition)- Description
Re-inserts cell at position.
- Methodset_cell_data_func
GTK2.CellLayoutset_cell_data_func(GTK2.CellRenderercell,function(:void)f,mixeduser_data)- Description
Sets the callback to use for this cell layout. This function is used instead of the standard attributes mapping for setting the column value, and should set the value of the cell layout's cell renderer(s) as appropriate. f may be 0 to remove an older one.
Class GTK2.CellRenderer
- Description
Properties: string cell-background GDK2.Color cell-background-gdk int cell-background-set int height int is-expanded int is-expander int mode
CELL_RENDERER_MODE_ACTIVATABLE,CELL_RENDERER_MODE_EDITABLEandCELL_RENDERER_MODE_INERTint sensitive int visible int width float xalign int xpad float yalign int ypadSignals: editing_canceled
editing_started
- Methodactivate
intactivate(GTK2.GdkEventevent,GTK2.Widgetwidget,stringpath,GTK2.GdkRectanglebackground_area,GTK2.GdkRectanglecell_area,intflags)- Description
Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, W(CellRendererToggle) toggles when it gets a mouse click.
- Methodget_fixed_size
mappingget_fixed_size()- Description
Fills in width and height with the appropriate size of the cell.
- Methodget_size
mappingget_size(GTK2.Widgetwidget,GTK2.GdkRectanglecell_area)- Description
Obtains the width and heigh needed to render the cell. Used by widgets to determine the appropriate size for the cell_area passed to render(). If cell_area is present, fills in the x and y offset of the cell relative to this location. Please note that the values set in width and height, as well as those in x_offset and y_offset are inclusive of the xpad and ypad properties.
- Methodrender
GTK2.CellRendererrender(GTK2.GdkWindowwindow,GTK2.Widgetwidget,GTK2.GdkRectanglebackground_area,GTK2.GdkRectanglecell_area,GTK2.GdkRectangleexpose_area,intflags)- Description
Invokes the virtual render function of the W(CellRenderer). The three passed-in rectangles are areas of window. Most renderers will draw within cell_area; the xalign, yalign, xpad, and ypad fields of the W(CellRenderer) should be honored with respect to cell_area. background_area includes the blank space around the cell, and also the area containing the tree expander; so the background_area rectangles for all cells tile to cover the entire window. expose_area is a clip rectangle. flags is one of
CELL_RENDERER_ACCEL_MODE_GTK,CELL_RENDERER_ACCEL_MODE_OTHER,CELL_RENDERER_FOCUSED,CELL_RENDERER_INSENSITIVE,CELL_RENDERER_MODE_ACTIVATABLE,CELL_RENDERER_MODE_EDITABLE,CELL_RENDERER_MODE_INERT,CELL_RENDERER_PRELIT,CELL_RENDERER_SELECTEDandCELL_RENDERER_SORTED.
- Methodset_fixed_size
GTK2.CellRendererset_fixed_size(intwidth,intheight)- Description
Sets the renderer size to be explicit, independent of the properties set.
- Methodstart_editing
GTK2.CellRendererstart_editing(GTK2.GdkEventevent,GTK2.Widgetwidget,stringpath,GTK2.GdkRectanglebackground_area,GTK2.GdkRectanglecell_area,intflags)- Description
Passes an activate event to the cell renderer for possible processing.
- Methodstop_editing
GTK2.CellRendererstop_editing(intcanceled)- Description
Informs the cell renderer that the editing is stopped. If canceled is true, the cell renderer will emit the "editing-canceled" signal. This function should be called by cell renderer implementations in response to the "editing-done" signal of W(CellEditable).
Class GTK2.CellRendererAccel
- Description
Properties: int accel-key int accel-mode int accel-mods int keycode
Signals: accel_cleared
accel_edited
Class GTK2.CellRendererCombo
- Description
Properties: int has-entry GTK2.TreeModel model int text-column
Class GTK2.CellRendererPixbuf
- Description
Properties: GDK2.Pixbuf pixbuf GDK2.Pixbuf pixbuf-expander-closed GDK2.Pixbuf pixbuf-expander-open string stock-detail string stock-id int stock-size
- Methodcreate
GTK2.CellRendererPixbufGTK2.CellRendererPixbuf(mapping|voidprops)- Description
Creates a new W(CellRendererPixbuf). Adjust rendering parameters using object properties. Object properties can be set globally with G.Object->set(). Also, with W(TreeViewColumn), you can bind a property to a value in a W(TreeModel). For example, you can bind the "pixbuf" property on the cell renderer to a pixbuf value in the model, thus rendering a different image in each row of the W(TreeView).
Class GTK2.CellRendererProgress
- Description
Properties: int orientation int pulse string text float text-xalign float text-yalign int value
Class GTK2.CellRendererSpin
- Description
Properties: int digits GTK2.Adjustment adjustment float climb-rate
Class GTK2.CellRendererText
- Description
Properties: int alignment Pango.AttrList attributes string background GDK2.Color background-gdk int background-set int editable int editable-set int ellipsize
PANGO_ELLIPSIZE_END,PANGO_ELLIPSIZE_MIDDLE,PANGO_ELLIPSIZE_NONEandPANGO_ELLIPSIZE_STARTint ellipsize-set string family int family-set string font Pango.FontDescription font-desc string foreground GDK2.Color foreground-gdk int foreground-set string language int language-set string markup int rise int rise-set float scale int scale-set int single-paragraph-mode int size float size-points int size-set int stretchPANGO_STRETCH_CONDENSED,PANGO_STRETCH_EXPANDED,PANGO_STRETCH_EXTRA_CONDENSED,PANGO_STRETCH_EXTRA_EXPANDED,PANGO_STRETCH_NORMAL,PANGO_STRETCH_SEMI_CONDENSED,PANGO_STRETCH_SEMI_EXPANDED,PANGO_STRETCH_ULTRA_CONDENSEDandPANGO_STRETCH_ULTRA_EXPANDEDint stretch-set int strikethrough int strikethrough-set int stylePANGO_STYLE_ITALIC,PANGO_STYLE_NORMALandPANGO_STYLE_OBLIQUEint style-set string text int underlinePANGO_UNDERLINE_DOUBLE,PANGO_UNDERLINE_ERROR,PANGO_UNDERLINE_LOW,PANGO_UNDERLINE_NONEandPANGO_UNDERLINE_SINGLEint underline-set int variantPANGO_VARIANT_NORMALandPANGO_VARIANT_SMALL_CAPSint variant-set int weight int weight-set int width-charsSignals: edited
- Methodcreate
GTK2.CellRendererTextGTK2.CellRendererText(mapping|voidprops)- Description
Creates a new W(CellRendererText). Adjust how text is drawn using object properties. Object properties can be set globally (with G.Object->set()). Also, with W(TreeViewColumn), you can bind a property to a value in a W(TreeModel). For example, you can bind the "text" property on the cell renderer to a string value in the model, thus rendering a different string in each row of the W(TreeView).
- Methodset_fixed_height_from_font
GTK2.CellRendererTextset_fixed_height_from_font(intnumber_of_rows)- Description
Sets the height of a renderer to explicitly be determined by the "font" and "y_bad" property set on it. Further changes in these properties do not affect the height, so they must be accompanied by a subsequent call to this function. Using this function is unflexible, and should really only be used if calculating the size of cell is too slow (i.e., a massive number of cells displayed). If number_of_rows is -1, then the fixed height is unset, and the height is determined by the properties again.
Class GTK2.CellRendererToggle
- Description
Properties: int activatable The toggle button can be activated. int active The toggle state of the button. int inconsistent The inconsistent state of the button. int indicator-size int radio Draw the toggle butotn as a radio button.
Signals: toggled
- Methodcreate
GTK2.CellRendererToggleGTK2.CellRendererToggle(mapping|voidprops)- Description
Creates a new W(CellRendererToggle). Adjust rendering parameters using object properties. Object properties can be set globally with set().
- Methodget_radio
intget_radio()- Description
Returns whether we're rendering radio toggles rather than checkboxes.
- Methodset_active
GTK2.CellRendererToggleset_active(intsetting)- Description
Activates or deactivates a cell renderer.
- Methodset_radio
GTK2.CellRendererToggleset_radio(intradio)- Description
If radio is true, the cell renderer renders a radio toggle (i.e a toggle in a group of mutually-exclusive toggles). If false, it renders a check toggle (a standalone boolean option). This can be set globally for the cell renderer, or changed just before rendering each cell in the model (for W(TreeView), you set up a per-row setting using W(TreeViewColumn) to associate model columns with cell renderer properties).
Class GTK2.CellView
- Description
Properties: string background GDK2.Color background-gdk int background-set
- Methodcreate
GTK2.CellViewGTK2.CellView(string|GdkPixbuf|mappingtext,int|voidmarkup)- Description
Create a new W(CellView) widget.
- Methodget_cell_renderers
arrayget_cell_renderers()- Description
Returns the cell renderers which have been added to this view.
- Methodget_displayed_row
GTK2.TreePathget_displayed_row()- Description
Returns a W(TreePath) referring to the currently displayed row. If no row is currently displayed, 0 is returned.
- Methodget_size_of_row
mappingget_size_of_row(GTK2.TreePathpath)- Description
Returns width and height of the size needed to display the model row pointed to by path.
- Methodset_background_color
GTK2.CellViewset_background_color(GTK2.GdkColorcolor)- Description
Sets the background color.
- Methodset_displayed_row
GTK2.CellViewset_displayed_row(GTK2.TreePathpath)- Description
Sets the row of the model that is currently displayed. If the path is omitted, then the contents of the cellview "stick" at their last value; this is not normally a desired result, but may be a needed intermediate state if say, the mode becomes temporarily empty.
Class GTK2.CheckButton
- Description
Check buttons inherent many properties and functions from the the toggle buttons, but look a little different. Rather than being buttons with text inside them, they are small squares with the text to the right of them. These are often used for toggling options on and off in applications.
GTK2.CheckButton( "title" )
Style properties: int indicator-size int indicator-spacing
Class GTK2.CheckMenuItem
- Description
A check menu item is more or less identical to a check button, but it should be used in menus.
GTK2.CheckMenuItem("Hi there")
GTK2.CheckMenuItem("Hi there")->set_active(1)
Properties: int active int draw-as-radio int inconsistent
Style properties: int indicator-size
Signals: toggled Called when the state of the menu item is changed
- Methodcreate
GTK2.CheckMenuItemGTK2.CheckMenuItem(string|mappinglabel_or_props)- Description
The argument, if specified, is the label of the item. If no label is specified, use object->add() to add some other widget (such as an pixmap or image widget)
- Methodget_draw_as_radio
intget_draw_as_radio()- Description
Get whether check menu item is drawn like a radio button.
- Methodget_inconsistent
intget_inconsistent()- Description
Retrieves the value set by set_inconsistent().
- Methodset_active
GTK2.CheckMenuItemset_active(intnew_state)- Description
State is either 1 or 0. If 1, the button will be 'pressed'.
- Methodset_draw_as_radio
GTK2.CheckMenuItemset_draw_as_radio(intdraw_as_radio)- Description
Set whether check menu item is drawn like a radio button.
- Methodset_inconsistent
GTK2.CheckMenuItemset_inconsistent(intsetting)- Description
If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a boolean setting, and the current values in that range are inconsistent, you may want to display the check in an "in between" state. This function turns on "in between" display.
Class GTK2.Clipboard
- Description
Clipboard implementation.
- Methodget
GTK2.Clipboardget(GDK2.Atomselection)- Description
Returns the clipboard object for the given selection.
- Methodget_display
GTK2.GdkDisplayget_display()- Description
Gets the GDK2.Display associated with this clipboard.
- Methodget_for_display
GTK2.Clipboardget_for_display(GTK2.GdkDisplaydisplay,GDK2.Atomselection)- Description
Returns the clipboard object for the given selection.
- Methodset_image
GTK2.Clipboardset_image(GTK2.GdkPixbufpixbuf)- Description
Sets the contents of the clipboard to the given GDK2(Pixbuf).
- Methodset_text
GTK2.Clipboardset_text(sprintf_formattext,sprintf_args...fmt)- Description
Sets the contents of the clipboard to the given string. If multiple arguments are supplied, sprintf() is called implicitly.
- Methodwait_for_image
GTK2.GdkPixbufwait_for_image()- Description
Requests the contents of the clipboard as image and converts the result to a GDK2.Pixbuf.
- Methodwait_for_rich_text
stringwait_for_rich_text(GTK2.TextBufferbuffer)- Description
Requests the contents of the clipboard as rich text.
- Methodwait_is_image_available
intwait_is_image_available()- Description
Test to see if tehre is an image available to be pasted.
- Methodwait_is_rich_text_available
intwait_is_rich_text_available(GTK2.TextBufferbuffer)- Description
Test to see if there is rich text available to be pasted.
Class GTK2.ColorButton
- Description
Properties: int alpha GDK2.Color color string title int use-alpha
Signals: color_set When a user selects a color.
- Methodcreate
GTK2.ColorButtonGTK2.ColorButton(GTK2.GdkColorred_or_props,int|voidgreen,int|voidblue)- Description
Create a new W(ColorButton).
- Methodget_use_alpha
intget_use_alpha()- Description
Gets whether the color button uses the alpha channel.
- Methodset_color
GTK2.ColorButtonset_color(int|GdkColorred,int|voidgreen,int|voidblue)- Description
Sets the current color.
- Methodset_title
GTK2.ColorButtonset_title(stringtitle)- Description
Sets the title for the color selection dialog.
Class GTK2.ColorSelection
- Description
The color selection widget is, not surprisingly, a widget for interactive selection of colors. This composite widget lets the user select a color by manipulating RGB (Red, Green, Blue) and HSV (Hue, Saturation, Value) triples. This is done either by adjusting single values with sliders or entries, or by picking the desired color from a hue-saturation wheel/value bar. Optionally, the opacity of the color can also be set.
The color selection widget currently emits only one signal, "color_changed", which is emitted whenever the current color in the widget changes, either when the user changes it or if it's set explicitly through set_color().
GTK2.ColorSelection()
Properties: int current-alpha GDK2.Color current-color int has-opacity-control int has-palette
Signals: color_changed
- Methodcreate
GTK2.ColorSelectionGTK2.ColorSelection(mapping|voidprops)- Description
Create a new color selection.
- Methodget_current_color
mappingget_current_color()- Description
When you need to query the current color, typically when you've received a "color_changed" signal, you use this function. The return value is an array of floats, See the set_color() function for the description of this array.
- Methodget_has_opacity_control
intget_has_opacity_control()- Description
Determines whether the colorsel has an opacity control.
- Methodget_has_palette
intget_has_palette()- Description
Determines whether the color selector has a color palette.
- Methodset_current_alpha
GTK2.ColorSelectionset_current_alpha(intalpha)- Description
Sets the current opacity to be alpha. The first time this is called, it will also set the original opacity to be alpha too.
- Methodset_current_color
GTK2.ColorSelectionset_current_color(mappingcolor)- Description
You can set the current color explicitly by calling this function with an array of colors (floats). The length of the array depends on whether opacity is enabled or not. Position 0 contains the red component, 1 is green, 2 is blue and opacity is at position 3 (only if opacity is enabled, see set_opacity()) All values are between 0 and 65535
- Methodset_has_opacity_control
GTK2.ColorSelectionset_has_opacity_control(intsetting)- Description
Sets whether or not to use opacity.
- Methodset_has_palette
GTK2.ColorSelectionset_has_palette(inthas_palette)- Description
Shows and hides the palette based upon the value of has_palette
- Methodset_previous_alpha
GTK2.ColorSelectionset_previous_alpha(intalpha)- Description
Sets the 'previous' alpha to be alpha. This function should be called with some hesitation, as it might seem confusing to have that alpha change.
Class GTK2.ColorSelectionDialog
- Description
Color Selection Dialog
- Methodcreate
GTK2.ColorSelectionDialogGTK2.ColorSelectionDialog(string|mappingtitle_or_props)- Description
Create a new Color Selection Dialog
- Methodget_colorsel
GTK2.Widgetget_colorsel()- Description
The Color Selection widget contained within the dialog
Class GTK2.ComboBox
- Description
Properties: int active int add-tearoffs int column-span-column int focus-on-click int has-frame GTK2.TreeModel model int row-span-column string tearoff-title int wrap-width
Style properties: int appears-as-list int arrow-size int shadow-type
Signals: changed
- Methodappend_text
GTK2.ComboBoxappend_text(stringtext)- Description
Appends text to the list of strings stored in this combo box. Note that you can only use this function with combo boxes constructed with GTK2.ComboBox("a string").
- Methodcreate
GTK2.ComboBoxGTK2.ComboBox(GTK2.TreeModelmodel_or_props)- Description
Create a new ComboBox, either empty or with a model. If a string is passed int instead, it will create a new W(ComboBox) with only text strings. If you do so, you should only manipulate it with the following functions: append_text(), insert_text(), prepend_text(), and remove_text().
- Methodget_active
intget_active()- Description
Returns the index of the currently active item, or -1 if none. If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this function returns path_get_indices(path)[0], where path is the GTK2.TreePath of the active item.
- Methodget_active_text
stringget_active_text()- Description
Returns the currently active string. Note that you can only use this function with combo boxes constructed with GTK2.ComboBox("a string").
- Methodget_add_tearoffs
intget_add_tearoffs()- Description
Gets whether the popup menu has tearoff items.
- Methodget_column_span_column
intget_column_span_column()- Description
Returns the column with column span information.
- Methodget_focus_on_click
intget_focus_on_click()- Description
Returns whether the combo box grabs focus when it is clicked with the mouse.
- Methodget_model
GTK2.TreeModelget_model()- Description
Get the GTK2.TreeModel which is acting as a data source.
- Methodget_row_span_column
intget_row_span_column()- Description
Returns the column with row span information.
- Methodget_wrap_width
intget_wrap_width()- Description
Returns the wrap width which is used to determine the number of columns for the popup menu. If the wrap width is larger than 1, the combo box is in table mode.
- Methodinsert_text
GTK2.ComboBoxinsert_text(intposition,stringtext)- Description
Inserts string at position in the list of strings stored. Note that you can only use this function with combo boxes constructed with GTK2.ComboBox("a string").
- Methodprepend_text
GTK2.ComboBoxprepend_text(stringtext)- Description
Prepends string to the list of strings stored in this combo box. Note that you can only use this function with combo boxes constructed with GTK2.ComboBox("a string").
- Methodremove_text
GTK2.ComboBoxremove_text(intposition)- Description
Removes the string at position from this combo box. Note that you can only use this function with combo boxes constructed with GTK2.ComboBox("a string").
- Methodset_active_iter
GTK2.ComboBoxset_active_iter(GTK2.TreeIteriter)- Description
Sets the current active item to be the one referenced by iter. iter must correspond to a path of depth one.
- Methodset_add_tearoffs
GTK2.ComboBoxset_add_tearoffs(intsetting)- Description
Sets whether the popup menu should have a tearoff menu item.
- Methodset_column_span_column
GTK2.ComboBoxset_column_span_column(intcolumn_span)- Description
Sets the column span information. The column span column contains integers which indicate how many columns an item should span.
- Methodset_focus_on_click
GTK2.ComboBoxset_focus_on_click(intsetting)- Description
Sets whether the combo box will grab focus when it is clicked with the mouse.
- Methodset_model
GTK2.ComboBoxset_model(GTK2.TreeModelmodel)- Description
Sets the model used by this widget. Will unset a previously set model. If no arguments are passed, then it will unset the model.
- Methodset_row_separator_func
GTK2.ComboBoxset_row_separator_func(function(:void)f,mixeduser_data)- Description
Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is 0 no separators are drawn. This is the default value.
- Methodset_row_span_column
GTK2.ComboBoxset_row_span_column(introw_span)- Description
Sets the column with row span information. The row span column contains integers which indicate how many rows an item should span.
Class GTK2.ComboBoxEntry
- Description
Properties: int text-column
- Methodcreate
GTK2.ComboBoxEntryGTK2.ComboBoxEntry(string|TreeModel|mappingmodel,int|voidtext_column)- Description
Create a new ComboBoxEntry, either empty or with a model.
- Methodget_text_column
intget_text_column()- Description
Returns the column which this widget is using to get the strings from.
Class GTK2.Container
- Description
The basic container class. Properties: int border-width GTK2.Widget child int resize-mode
RESIZE_IMMEDIATE,RESIZE_PARENTandRESIZE_QUEUESignals: add Called when a new object is added to the container. (used internally)
check_resize Called when the container needs resizing (used internally)
remove Called when a object is removed from the container (used internally)
set_focus_child
- Methodadd
GTK2.Containeradd(GTK2.Widgetwidget)- Description
Add a subwidget to the container. Don't forget to call show() in the subwidget. Some (even most) containers can only contain one child. Calling this function might result in a resize of the container.
- Methodget_children
arrayget_children()- Description
This function returns all children of the container as an array.
- Methodget_focus_hadjustment
GTK2.Adjustmentget_focus_hadjustment()- Description
Retrieves the horizontal focus adjustment.
- Methodget_focus_vadjustment
GTK2.Adjustmentget_focus_vadjustment()- Description
Retrieves the vertical focus adjustment.
- Methodremove
GTK2.Containerremove(GTK2.Widgetwidget)- Description
Remove a child from the container. The argument is the child to remove. Calling this function might result in a resize of the container.
- Methodset_focus_chain
GTK2.Containerset_focus_chain(arrayfocusable_widgets)- Description
Sets a focus chain, overriding the one computer automatically by GTK+.
In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it's allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn't always packed. The necessary checks are done when the focus chain is actually traversed.
- Methodset_focus_child
GTK2.Containerset_focus_child(GTK2.Widgetchild)- Description
Emulate a set_focus_child signal. Focus on the specified child.
- Methodset_focus_hadjustment
GTK2.Containerset_focus_hadjustment(GTK2.Adjustmentadj)- Description
Set the hadjustment used to focus children.
- Methodset_focus_vadjustment
GTK2.Containerset_focus_vadjustment(GTK2.Adjustmentadj)- Description
Set the vadjustment used to focus children.
- Methodset_reallocate_redraws
GTK2.Containerset_reallocate_redraws(intsetting)- Description
Sets the reallocate_redraws flag.
Class GTK2.Data
- Description
A class inherited by all objects used to store data (they are not widgets)
Signals: disconnect
Class GTK2.Databox
- Description
GtkDatabox is designed to display large amounts of numerical data fast and easy. Thousands of data points (X and Y coordinate) may be displayed without any problems, zooming and scrolling as well as optional rulers are already included.
The widget may be used as display for oscilloscopes or other applications that need to display fast changes in their data.
GTK2.Databox x=GTK2.Databox(); x->data_add_x_y(3, ({ 1.0, 0.5, 0.0 }), ({1.0, -1.0, 0.0}),GTK2.GdkColor(Image.Color.red), GTK2.DataboxLines,2); x->rescale(); x->set_size_request(300,300); return x;
Signals: marked
selection_canceled
selection_changed
selection_started
selection_stopped
zoomed
- Methoddata_add
intdata_add(intnelems,arrayx,arrayy,GTK2.GdkColorcolor,inttype,intdot_size)- Description
Type is one of
DATABOX_BARS,DATABOX_CROSS_SIMPLE,DATABOX_GRID,DATABOX_LINES,DATABOX_NOT_DISPLAYEDandDATABOX_POINTS
- Methoddata_get_value
mappingdata_get_value(intx,inty)- Description
Get the value at the given coordinates.
- Methoddata_get_visible_extrema
arraydata_get_visible_extrema()- Description
Get the positions of the edges of the display.
- Methoddata_set_color
intdata_set_color(intindex,GTK2.GdkColorcolor)- Description
Set the color at index.
- Methoddata_set_grid_config
intdata_set_grid_config(intindex,inthlines,intvlines)- Description
Not useful unless the data type is GTK2.DATABOX_GRID.
- Methoddata_set_type
intdata_set_type(intindex,inttype,intdot_size)- Description
Type is one of
DATABOX_BARS,DATABOX_CROSS_SIMPLE,DATABOX_GRID,DATABOX_LINES,DATABOX_NOT_DISPLAYEDandDATABOX_POINTS
- Methodget_rulers_enable
GTK2.Databoxget_rulers_enable()- Description
Get whether rulers will be displayed.
- Methodget_scrollbars_enable
GTK2.Databoxget_scrollbars_enable()- Description
Get whether scrollbars will be displayed.
- Methodget_selection_fill_enable
intget_selection_fill_enable()- Description
Get whether the selection will be filled.
- Methodrescale_inverted
GTK2.Databoxrescale_inverted(intinvertX,intinvertY)- Description
Rescale with an inverted x and/or y direction.
- Methodrescale_with_values
GTK2.Databoxrescale_with_values(floatminx,floatminy,floatmaxx,floatmaxy)- Description
Rescale with specific data extrema.
- Methodset_background_color
GTK2.Databoxset_background_color(GTK2.GdkColorcolor)- Description
Set the background color.
- Methodset_rulers_enable
GTK2.Databoxset_rulers_enable(intsetting)- Description
Set whether rulers will be displayed.
- Methodset_scrollbars_enable
GTK2.Databoxset_scrollbars_enable(intsetting)- Description
Set whether scrollbars will be displayed.
- Methodset_selection_enable
GTK2.Databoxset_selection_enable(intsetting)- Description
Set whether selection is enabled.
- Methodset_selection_fill_enable
GTK2.Databoxset_selection_fill_enable(intsetting)- Description
Set whether the selection will be filled.
Class GTK2.Dialog
- Description
A dialog is a window with a few default widgets added. The 'vbox' is the main content area of the widget. The 'action_area' is allocated for buttons (ok, cancel etc) Properties: int has-separator
Style properties: int action-area-border int button-spacing int content-area-border
Signals: close
response
- Methodadd_action_widget
GTK2.Dialogadd_action_widget(GTK2.Widgetchild,intresponse_id)- Description
Adds an activatable widget to the action area, connecting a signal handler that will emit the "response" signal on the dialog when the widget is activated.
- Methodadd_button
GTK2.Widgetadd_button(stringbutton_text,intresponse_id)- Description
Adds a button with the given text (or a stock button) and sets things up so that clicking the button will emit the "response" signal with the given response_id.
- Methodget_action_area
GTK2.HbuttonBoxget_action_area()- Description
The action area, this is where the buttons (ok, cancel etc) go
- Methodget_has_separator
intget_has_separator()- Description
Accessor for whether the dialog has a separator.
- Methodget_response_for_widget
intget_response_for_widget(GTK2.Widgetwidget)- Description
Gets the response id of a widget in the action area.
- Methodget_vbox
GTK2.Vboxget_vbox()- Description
The vertical box that should contain the contents of the dialog
- Methodresponse
GTK2.Dialogresponse(intresponse_id)- Description
Emits the "response" signal with the given response ID.
- Methodset_default_response
GTK2.Dialogset_default_response(intresponse_id)- Description
Sets the last widget in the action area with the given response_id as the default widget. Pressing "Enter" normally activates the default widget.
- Methodset_has_separator
GTK2.Dialogset_has_separator(intsetting)- Description
Sets whether this dialog has a separator above the buttons. True by default.
Class GTK2.DrawingArea
- Description
The drawing area is a window you can draw in. Please note that you must handle refresh and resize events on your own. Use W(pDrawingArea) for a drawingarea with automatic refresh/resize handling.
GTK2.DrawingArea()->set_size_request(100,100)
- Methodclear
GTK2.DrawingAreaclear(int|voidx,int|voidy,int|voidwidth,int|voidheight)- Description
Either clears the rectangle defined by the arguments, of if no arguments are specified, the whole drawable.
- Methodcopy_area
GTK2.DrawingAreacopy_area(GTK2.GdkGCgc,intxdest,intydest,GTK2.Widgetsource,intxsource,intysource,intwidth,intheight)- Description
Copies the rectangle defined by xsource,ysource and width,height from the source drawable, and places the results at xdest,ydest in the drawable in which this function is called.
- Methodcreate
GTK2.DrawingAreaGTK2.DrawingArea(mapping|voidprops)- Description
Create a new drawing area.
- Methoddraw_arc
GTK2.DrawingAreadraw_arc(GTK2.GdkGCgc,intfilledp,intx1,inty1,intx2,inty2,intangle1,intangle2)- Description
Draws a single circular or elliptical arc. Each arc is specified by a rectangle and two angles. The center of the circle or ellipse is the center of the rectangle, and the major and minor axes are specified by the width and height. Positive angles indicate counterclockwise motion, and negative angles indicate clockwise motion. If the magnitude of angle2 is greater than 360 degrees, it is truncated to 360 degrees.
- Methoddraw_bitmap
GTK2.DrawingAreadraw_bitmap(GTK2.GdkGCgc,GTK2.GdkBitmapbitmap,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw a GDK2(Bitmap) in this drawable. NOTE: This drawable must be a bitmap as well. This will be fixed in GTK 1.3
- Methoddraw_image
GTK2.DrawingAreadraw_image(GTK2.GdkGCgc,GTK2.GdkImageimage,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw the rectangle specified by xsrc,ysrc+width,height from the GDK2(Image) at xdest,ydest in the destination drawable
- Methoddraw_line
GTK2.DrawingAreadraw_line(GTK2.GdkGCgc,intx1,inty1,intx2,inty2)- Description
img_begin w = GTK2.DrawingArea()->set_size_request(100,100); delay: g = GDK2.GC(w)->set_foreground( GDK2.Color(255,0,0) ); delay: for(int x = 0; x<10; x++) w->draw_line(g,x*10,0,100-x*10,99); img_end
- Methoddraw_pixbuf
GTK2.DrawingAreadraw_pixbuf(GTK2.GdkGCgc,GTK2.GdkPixbufpixbuf,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw a GDK2(Pixbuf) in this drawable.
- Methoddraw_pixmap
GTK2.DrawingAreadraw_pixmap(GTK2.GdkGCgc,GTK2.GdkPixmappixmap,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw the rectangle specified by xsrc,ysrc+width,height from the GDK2(Pixmap) at xdest,ydest in the destination drawable
- Methoddraw_point
GTK2.DrawingAreadraw_point(GTK2.GdkGCgc,intx,inty)- Description
img_begin w = GTK2.DrawingArea()->set_size_request(10,10); delay: g = GDK2.GC(w)->set_foreground( GDK2.Color(255,0,0) ); delay: for(int x = 0; x<10; x++) w->draw_point(g, x, x); img_end
- Methoddraw_rectangle
GTK2.DrawingAreadraw_rectangle(GTK2.GdkGCgc,intfilledp,intx1,inty1,intx2,inty2)- Description
img_begin w = GTK2.DrawingArea()->set_size_request(100,100); delay: g = GDK2.GC(w)->set_foreground( GDK2.Color(255,0,0) ); delay: for(int x = 0; x<10; x++) w->draw_rectangle(g,0,x*10,0,100-x*10,99); img_end img_begin w = GTK2.DrawingArea()->set_size_request(100,100); delay: g = GDK2.GC(w); delay: for(int x = 0; x<30; x++) { delay: g->set_foreground(GDK2.Color(random(255),random(255),random(255)) ); delay: w->draw_rectangle(g,1,x*10,0,100-x*10,99); delay: } img_end
- Methoddraw_text
GTK2.DrawingAreadraw_text(GTK2.GdkGCgc,intx,inty,string|PangoLayouttext)- Description
y is used as the baseline for the text.
Class GTK2.Editable
- Description
Interface for text-editing widgets.
Signals: changed
delete_text
insert_text
- Methodcopy_clipboard
GTK2.Editablecopy_clipboard()- Description
Causes the characters in the current selection to be copied to the clipboard.
- Methodcut_clipboard
GTK2.Editablecut_clipboard()- Description
Causes the characters in the current selection to be copied to the clipboard and then deleted.
- Methoddelete_selection
GTK2.Editabledelete_selection()- Description
Deletes the current contents of the selection.
- Methoddelete_text
GTK2.Editabledelete_text(intstart,intend)- Description
Deletes a sequence of characters.
- Methodinsert_text
intinsert_text(stringtext,intlength,intpos)- Description
Inserts text at a given position. Returns the position after the new text.
- Methodpaste_clipboard
GTK2.Editablepaste_clipboard()- Description
Causes the contents of the clipboard to be pasted into the given widget at the current cursor position.
- Methodset_editable
GTK2.Editableset_editable(intsetting)- Description
Determines if the user can edit the text or not.
Class GTK2.Entry
- Description
Use this widget when you want the user to input a single line of text.
GTK2.Entry()->set_text("Hello world")->set_editable(1)
Properties: int activates-default int cursor-position int editable int has-frame int inner-border int invisible-char int max-length int scroll-offset int selection-bound int shadow-type string text int truncate-multiline int visibility int width-chars float xalign
Style properties:
Signals: activate
backspace
copy_clipboard
cut_clipboard
delete_from_cursor
insert_at_cursor
move_cursor
paste_clipboard
populate_popup
toggle_overwrite
- Methodcreate
GTK2.EntryGTK2.Entry(int|mappingmaxlen_or_props)- Description
Create a new W(Entry) widget.
- Methodget_activates_default
intget_activates_default()- Description
Retrieves the value set by set_activates_default().
- Methodget_cursor_hadjustment
GTK2.Adjustmentget_cursor_hadjustment()- Description
Retrieves the horizontal cursor adjustment
- Methodget_inner_border
arrayget_inner_border()- Description
This function returns the entry's inner-border property.
- Methodget_invisible_char
intget_invisible_char()- Description
Retrieves the character displayed in place of the real characters for entries with visibility set to false.
- Methodget_layout
GTK2.Pango.Layoutget_layout()- Description
Gets the Pango.Layout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with get_layout_offsets().
Keep in mind that the layout text may contain a preedit string, so layout_index_to_text_index() and text_index_to_layout_index() are needed to convert byte indices in the layout to byte indices in the entry contents.
- Methodget_layout_offsets
mappingget_layout_offsets()- Description
Obtains the position of the Pango.Layout used to render text in the entry, in widget coordinates. Useful if you want to line up the text in an entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget.
Also useful to convert mouse events into coordinates inside the Pango.Layout, e.g. to take some action if some part of the entry text is clicked.
Keep in mind that the layout text may contain a preedit string, so layout_index_to_text_index() and text_index_to_layout_index() are needed to convert byte indices in the layout to byte indices in the entry contents.
- Methodlayout_index_to_text_index
intlayout_index_to_text_index(intlayout_index)- Description
Converts from a position in the entry contents (returned by get_text()) to a position in the entry's Pango.Layout (returned by get_layout()), with text retrieved via Pango.Layout->get_text().
- Methodset_activates_default
GTK2.Entryset_activates_default(intsetting)- Description
If setting is true, pressing Enter will activate the default widget for the window containing the entry. This usually means that the dialog box containing the entry will be closed, since the default widget is usually one of the dialog buttons.
- Methodset_alignment
GTK2.Entryset_alignment(floatalign)- Description
Sets the alignment for the ocntents of the entry. This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry.
- Methodset_completion
GTK2.Entryset_completion(GTK2.EntryCompletioncompletion)- Description
Sets completion to be the auxiliary completion object to use. All further configuration of the completion mechanism is done on completion using the GTK2.EntryCompletion API.
- Methodset_cursor_hadjustment
GTK2.Entryset_cursor_hadjustment(GTK2.Adjustmentadj)- Description
Hooks up an adjustment to the cursor position in an entry, so that when the cursor is moved, the adjustment is scrolled to show that position.
- Methodset_has_frame
GTK2.Entryset_has_frame(intsetting)- Description
Sets whether the entry has a beveled frame around it.
- Methodset_icon_from_pixbuf
GTK2.Entryset_icon_from_pixbuf(inticon_pos,GTK2.GdkPixbufb)- Description
Set the icon from the given in-memory image, or 0 to remove the icon at that position.
- Methodset_icon_from_stock
GTK2.Entryset_icon_from_stock(inticon_pos,stringid)- Description
Set the icon using a stock icon. To remove the icon, use set_icon_from_pixbuf().
- Methodset_inner_border
GTK2.Entryset_inner_border(intleft,intright,inttop,intbottom)- Description
Sets the inner-border property to border, or clears it if 0 is passed. The inner-border is the area around the entry's text, but inside its frame.
If set, this property overrides the inner-border style property. Overriding the style-provided border is useful when you want to do in-place editing of some text in a canvas or list widget, where pixel-exact positioning of the entry is important.
- Methodset_invisible_char
GTK2.Entryset_invisible_char(intch)- Description
Sets the character to use in place of the actual text when set_visibility() has been called to set text visibility to false. i.e. this is the character used in "password" mode to show the user how many characters have been type. The default invisible char is an asterisk ('*'). If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type.
- Methodset_max_length
GTK2.Entryset_max_length(intmaxlen)- Description
Sets the maximum allowed length of the contents. If the current contents are longer than the given length, then they will be truncated to fit. Range is 0-65536. 0 means no maximum.
- Methodset_text
GTK2.Entryset_text(sprintf_formattext,sprintf_args...fmt)- Description
Set the text to the specified string, replacing the current contents.
- Methodset_visibility
GTK2.Entryset_visibility(intvisiblep)- Description
0 indicates invisible text (password boxes, as an example)
- Methodset_width_chars
GTK2.Entryset_width_chars(intn_chars)- Description
changes the size request of the entry to be about the right size for n_chars characters. Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If n_chars is -1, the size reverts to the default entry size.
Class GTK2.EntryCompletion
- Description
Properties: int inline-completion int minimum-key-length GTK2.TreeModel model int popup-completion int popup-single-match int text-column
Signals: action_activated
insert_prefix
match_selected
- Methodcomplete
GTK2.EntryCompletioncomplete()- Description
Requests a completion operation, or in other words a refiltering of the current list with completions, using the current key. The completion list view will be updated accordingly.
- Methodcreate
GTK2.EntryCompletionGTK2.EntryCompletion(mapping|voidprops)- Description
Creates a new widget.
- Methoddelete_action
GTK2.EntryCompletiondelete_action(intindex)- Description
Deletes the action at index.
- Methodget_inline_completion
intget_inline_completion()- Description
Returns whether the common prefix of the possible completions should be automatically inserted in the entry.
- Methodget_popup_completion
intget_popup_completion()- Description
Returns whether completions should be presented in a popup window.
- Methodget_popup_set_width
intget_popup_set_width()- Description
Returns whether the completion popup window will be resized to the width of the entry.
- Methodget_popup_single_match
intget_popup_single_match()- Description
Returns whether the completion popup window will appear even if there is only a single match.
- Methodget_text_column
intget_text_column()- Description
Returns the column in the model to get strings from.
- Methodinsert_action_markup
GTK2.EntryCompletioninsert_action_markup(intindex,stringmarkup)- Description
Inserts an action in the action item list at position index with the specified markup.
- Methodinsert_action_text
GTK2.EntryCompletioninsert_action_text(intindex,stringtext)- Description
Inserts an action in the action item list at position index with the specified text. If you want the action item to have markup, use insert_action_markup().
- Methodset_inline_completion
GTK2.EntryCompletionset_inline_completion(intinline_completion)- Description
Sets whether the common prefix of the possible completions should be automatically inserted in the entry.
- Methodset_inline_selection
GTK2.EntryCompletionset_inline_selection(intinline_selection)- Description
Sets whether it is possible to cycle through the possible completions inside the entry.
- Methodset_match_func
GTK2.EntryCompletionset_match_func(function(:void)cb)- Description
Sets the function to be called to decide if a specific row should be displayed.
- Methodset_minimum_key_length
GTK2.EntryCompletionset_minimum_key_length(intlength)- Description
Requires the length of the search key to be at least length long. This is useful for long lists, where completing using a small key takes a lot of time and will come up with meaningless results anyway (i.e. a too large dataset).
- Methodset_model
GTK2.EntryCompletionset_model(GTK2.TreeModelmodel)- Description
Sets the model. If this completion already has a model set, it will remove it before setting the new model. If omitted it will unset the model.
- Methodset_popup_completion
GTK2.EntryCompletionset_popup_completion(intsetting)- Description
Sets whether the completions should be presented in a popup window.
- Methodset_popup_set_width
GTK2.EntryCompletionset_popup_set_width(intsetting)- Description
Sets whether the completion popup window will be resized to be the same width as the entry.
- Methodset_popup_single_match
GTK2.EntryCompletionset_popup_single_match(intsetting)- Description
Sets whether the completion popup window will appear even if there is only a single match. You may want to set this to 0 if you are using inline completion.
- Methodset_text_column
GTK2.EntryCompletionset_text_column(intcolumn)- Description
Convenience function for setting up the most used case of this code: a completion list with just strings. This function will set up the completion to have a list displaying all (and just) strings in the list, and to get those strings from column column in the model.
Class GTK2.EventBox
- Description
Some gtk widgets don't have associated X windows, so they just draw on their parents. Because of this, they cannot receive events and if they are incorrectly sized, they don't clip so you can get messy overwritting etc. If you require more from these widgets, the EventBox is for you.
At first glance, the EventBox widget might appear to be totally useless. It draws nothing on the screen and responds to no events. However, it does serve a function - it provides an X window for its child widget. This is important as many GTK2 widgets do not have an associated X window. Not having an X window saves memory and improves performance, but also has some drawbacks. A widget without an X window cannot receive events, and does not perform any clipping on it's contents. Although the name EventBox emphasizes the event-handling function, the widget can also be used for clipping.
The primary use for this widget is when you want to receive events for a widget without a window. Examples of such widgets are labels and images.
GTK2.EventBox()->set_size_request(100,100)
Properties: int above-child int visible-window
- Methodget_above_child
intget_above_child()- Description
Returns whether the event box window is above or below the windows of its child.
- Methodget_visible_window
intget_visible_window()- Description
Returns whether the event box has a visible window.
- Methodset_above_child
GTK2.EventBoxset_above_child(intabove_child)- Description
Sets whether the event box window is positioned above the windows of its child, as opposed to below it. If the window is above, all events inside the event box will go to the event box. If the window is below, events in windows of child widgets will first go to that widget, and then to its parents.
The default is to keep the window below the child.
Class GTK2.Expander
- Description
Properties: int expanded string label GTK2.Widget label-widget int spacing int use-markup int use-underline
Style properties: int expander-size int expander-spacing
Signals: activate
- Methodcreate
GTK2.ExpanderGTK2.Expander(string|mappinglabel)- Description
Create a new GTK2.Expander. Set mnemonic to 1 for a mnemonic expander, otherwise omitting it creates a regular expander.
- Methodget_label_widget
GTK2.Widgetget_label_widget()- Description
Retrieves the label widget for the frame.
- Methodget_use_markup
intget_use_markup()- Description
Returns whether the label's text is interpreted as marked up with the Pango text markup language.
- Methodget_use_underline
intget_use_underline()- Description
Returns whether an embedded underline in the label indicates a mnemonic.
- Methodset_expanded
GTK2.Expanderset_expanded(intexpanded)- Description
Sets the state of the expander. Set to true if you want the child widget to be revealed, and false if you want the child widget to be hidden.
- Methodset_label
GTK2.Expanderset_label(stringlabel)- Description
Sets the text of the label of the expander.
- Methodset_label_widget
GTK2.Expanderset_label_widget(GTK2.Widgetlabel)- Description
Set the label widget for the expander. This is the widget that will appear embedded alongside the expander arrow.
- Methodset_spacing
GTK2.Expanderset_spacing(intspacing)- Description
Sets the spacing field of the expander, which is the number of pixels to place between the expander and the child.
- Methodset_use_markup
GTK2.Expanderset_use_markup(intuse_markup)- Description
Sets whether the text of the label contains markup in Pango's text markup language.
Class GTK2.FileChooser
- Description
Properties: int action GTK2.Widget extra-widget string file-system-backend GTK2.FileFilter filter int local-only GTk.Widget preview-widget int preview-widget-active int select-multiple int show-hidden int use-preview-label
Signals: current_folder_changed
file_activated
selection_changed
update_preview
- Methodadd_filter
GTK2.FileChooseradd_filter(GTK2.FileFilterfilter)- Description
Adds filter to the list of filters that the user can select between. When a filter is selected, only files that are passed by that filter are displayed.
- Methodadd_shortcut_folder
intadd_shortcut_folder(stringfolder)- Description
Adds a folder to be displayed with the shortcut folders in a file chooser. Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a "/usr/share/mydrawprogram/Clipart" folder to the volume list.
- Methodadd_shortcut_folder_uri
intadd_shortcut_folder_uri(stringuri)- Description
Adds a folder URI to be displayed with the shortcut folders.
- Methodget_current_folder
stringget_current_folder()- Description
Gets the current folder as a local filename.
- Methodget_current_folder_uri
stringget_current_folder_uri()- Description
Gets the current folder as a URI.
- Methodget_do_overwrite_confirmation
intget_do_overwrite_confirmation()- Description
Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists.
- Methodget_filenames
arrayget_filenames()- Description
Get a list of all selected file and subfolders. The returned names are full absolute paths. If files in the current folder cannot be represented as local filenames, they will be ignored. If you want those files, You may want to use get_uris() instead.
- Methodget_local_only
intget_local_only()- Description
Gets whether only local files can be selected in the file selector.
- Methodget_preview_filename
stringget_preview_filename()- Description
Gets the filename that should be previewed in a custom preview widget.
- Methodget_preview_uri
stringget_preview_uri()- Description
Gets the URI that should be previewed in a custom preview widget.
- Methodget_preview_widget_active
intget_preview_widget_active()- Description
Gets whether the preview widget set by set_preview_widget_active() should be shown for the current filename.
- Methodget_select_multiple
intget_select_multiple()- Description
Gets whether multiple files can be selected.
- Methodget_show_hidden
intget_show_hidden()- Description
Gets whether hidden files and folders are displayed.
- Methodget_uris
arrayget_uris()- Description
List all the selected files and subfolders in the current folder. The returned names are full absolute URIs.
- Methodget_use_preview_label
intget_use_preview_label()- Description
Gets whether a stock label should be drawn with the name of the previewed file.
- Methodlist_shortcut_folder_uris
arraylist_shortcut_folder_uris()- Description
Queries the list of shortcut folders.
- Methodlist_shortcut_folders
arraylist_shortcut_folders()- Description
Queries the list of shortcut folders.
- Methodremove_filter
GTK2.FileChooserremove_filter(GTK2.FileFilterfilter)- Description
Removes filter from the list of filters that the user can select between.
- Methodremove_shortcut_folder
GTK2.FileChooserremove_shortcut_folder(stringfolder)- Description
Removes a folder from the list of shortcut folders.
- Methodremove_shortcut_folder_uri
GTK2.FileChooserremove_shortcut_folder_uri(stringuri)- Description
Removes a folder URI.
- Methodset_action
GTK2.FileChooserset_action(intaction)- Description
Sets type of action, from opening or saving a file, or opening or saving a folder. Options are:
FILE_CHOOSER_ACTION_OPENFILE_CHOOSER_ACTION_SAVEFILE_CHOOSER_ACTION_SELECT_FOLDERFILE_CHOOSER_ACTION_CREATE_FOLDER
- Methodset_current_folder
intset_current_folder(stringfolder)- Description
Sets the current folder from a local filename. The user will be shown the full contents of the current folder, plus user interface elements for navigating to other folders.
- Methodset_current_folder_uri
intset_current_folder_uri(stringuri)- Description
Sets the current folder from a URI.
- Methodset_do_overwrite_confirmation
GTK2.FileChooserset_do_overwrite_confirmation(intsetting)- Description
Sets whether a file chooser in GTK2.FILE_CHOOSER_ACTION_SAVE mode will present a confirmation dialog if the users types a file name that already exists. This is FALSE by default.
Regardless of this setting, the chooser will emit the "confirm-overwrite" signal when appropriate.
If all you need is the stock confirmation dialog, set this property to TRUE. You can override the way confirmation is done by actually handling the "confirm-overwrite" signal.
- Methodset_extra_widget
GTK2.FileChooserset_extra_widget(GTK2.Widgetwidget)- Description
Sets an application-supplied widget to provide extra options to the user.
- Methodset_filename
intset_filename(stringfilename)- Description
Sets filename as the current filename. Same as unselect_all() followed by select_filename();
- Methodset_filter
GTK2.FileChooserset_filter(GTK2.FileFilterfilter)- Description
Sets the current filter; only the files that pass the filter will be displayed. If the user-selectable list of filters is non-empty, then the filter should be one of the filters in that list. Setting the current filter when the list of filters is empty is useful if you want to restrict the displayed set of files without letting the user change it.
- Methodset_local_only
GTK2.FileChooserset_local_only(intlocal_only)- Description
Sets whether on local files can be selected.
- Methodset_preview_widget
GTK2.FileChooserset_preview_widget(GTK2.Widgetwidget)- Description
Sets an application-supplied widget to use to display a custom preview of the currently selected file. To implement a preview, after setting the preview widget, you connect to the "update-preview" signal, and call get_preview_filename() or get_preview_uri() on each change. If you can display a preview of the new file, update your widget and set the preview active using set_preview_widget_active(). Otherwise, set the preview inactive.
When there is no application-supplied preview widget, or the application- supplied preview widget is not active, the file chooser may display an internally generated preview of the current file or it may display no preview at all.
- Methodset_preview_widget_active
GTK2.FileChooserset_preview_widget_active(intsetting)- Description
Sets whether the preview widget set by set_preview_widget() should be shown for the current filename. When setting is set to false, the file chooser may display an internally generated preview of the current file or it may display no preview at all.
- Methodset_select_multiple
GTK2.FileChooserset_select_multiple(intselect_multiple)- Description
Sets whether multiple files can be selected in the file selector. This is only relevant if the action is set to be
FILE_CHOOSER_ACTION_OPENorFILE_CHOOSER_ACTION_SAVE
- Methodset_show_hidden
GTK2.FileChooserset_show_hidden(intsetting)- Description
Sets whether hidden files and folders are displayed.
- Methodset_use_preview_label
GTK2.FileChooserset_use_preview_label(intsetting)- Description
Sets whether the file chooser should display a stock label with the name of the file that is being previewed; the default is true. Applications that want to draw the whole preview area themselves should set this to false and display the name themselves in their preview widget.
- Methodunselect_filename
GTK2.FileChooserunselect_filename(stringfilename)- Description
Unselects a currently selected filename.
Class GTK2.FileChooserButton
- Description
Properties: GTK2.FileChooserDialog dialog int focus-on-click string title int width-chars
- Methodcreate
GTK2.FileChooserButtonGTK2.FileChooserButton(string|mappingtitle_or_props,int|voidaction)- Description
Create a new file-selecting button widget. action is one of
FILE_CHOOSER_ACTION_CREATE_FOLDER,FILE_CHOOSER_ACTION_OPEN,FILE_CHOOSER_ACTION_SAVEandFILE_CHOOSER_ACTION_SELECT_FOLDER
- Methodget_focus_on_click
intget_focus_on_click()- Description
Returns whether the button grabs focus when it is clicked.
- Methodget_width_chars
intget_width_chars()- Description
Retrieves the width in characters of the button widget's entry and/or label.
- Methodset_focus_on_click
GTK2.FileChooserButtonset_focus_on_click(intfocus)- Description
Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don't want the keyboard focus removed from the main area of the application.
- Methodset_title
GTK2.FileChooserButtonset_title(stringtitle)- Description
Modifies the title of the browse dialog.
Class GTK2.FileChooserDialog
- Description
GtkFileChooserDialog should be used to retrieve file or directory names from the user. It will create a new dialog window containing a directory list, and a file list corresponding to the current working directory. The filesystem can be navigated using the directory list, the drop-down history menu, or the TAB key can be used to navigate using filename completion common in text based editors such as emacs and jed.
The default filename can be set using set_filename() and the selected filename retrieved using get_filename().
Use complete() to display files that match a given pattern. This can be used for example, to show only *.txt files, or only files beginning with gtk*.
Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog. These can be hidden using hide_fileop_buttons() and shown again using show_fileop_buttons().
GTK2.FileChooserDialog("File selector", 0, GTK2.FILE_CHOOSER_ACTION_OPEN, ({(["text":"Transmogrify", "id":17]), (["text":"Never mind", "id":42])}))
- Methodcreate
GTK2.FileChooserDialogGTK2.FileChooserDialog(stringtitle,GTK2.Windowparent,intmode,arraybuttons)- Description
Creates a new file selection dialog box. By default it will list the files in the current working directory. Operation buttons allowing the user to create a directory, delete files, and rename files will also be present by default.
Class GTK2.FileChooserWidget
- Description
File chooser widget that can be embedded in other widgets.
GTK2.FileChooserWidget(GTK2.FILE_CHOOSER_ACTION_OPEN);
Class GTK2.FileFilter
- Description
A filter for selecting a file subset.
- Methodadd_mime_type
GTK2.FileFilteradd_mime_type(stringmime_type)- Description
Adds a rule allowing a given mime type.
- Methodadd_pattern
GTK2.FileFilteradd_pattern(stringpattern)- Description
Adds a rule allowing a shell style glob.
- Methodadd_pixbuf_formats
GTK2.FileFilteradd_pixbuf_formats()- Description
Adds a rule allowing image files in the formats support by W(Pixbuf).
- Methodcreate
GTK2.FileFilterGTK2.FileFilter()- Description
Creates a new W(FileFilter) with no rules added to it. Such a filter doesn't accept any files, so is not particularly useful until you add rules with add_mime_type(), add_pattern(), or add_custom(). To create a filter accepts any file, use add_pattern("*").
Class GTK2.FileSelection
- Description
GtkFileSelection should be used to retrieve file or directory names from the user. It will create a new dialog window containing a directory list, and a file list corresponding to the current working directory. The filesystem can be navigated using the directory list, the drop-down history menu, or the TAB key can be used to navigate using filename completion common in text based editors such as emacs and jed.
The default filename can be set using set_filename() and the selected filename retrieved using get_filename().
Use complete() to display files that match a given pattern. This can be used for example, to show only *.txt files, or only files beginning with gtk*.
Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog. These can be hidden using hide_fileop_buttons() and shown again using show_fileop_buttons().
GTK2.FileSelection("File selector")
Properties: string filename int select-multiple int show-fileops
- Methodcomplete
GTK2.FileSelectioncomplete(stringpattern)- Description
Will attempt to match pattern to a valid filename in the current directory. If a match can be made, the matched filename will appear in the text entry field of the file selection dialog. If a partial match can be made, the "Files" list will contain those file names which have been partially matched.
- Methodcreate
GTK2.FileSelectionGTK2.FileSelection(string|mappingtitle_or_props)- Description
Creates a new file selection dialog box. By default it will list the files in the current working directory. Operation buttons allowing the user to create a directory, delete files, and rename files will also be present by default.
- Methodget_fileop_c_dir
GTK2.Buttonget_fileop_c_dir()- Description
The create directory button in the file operation button group
- Methodget_fileop_del_file
GTK2.Buttonget_fileop_del_file()- Description
The delete file button in the file operation button group
- Methodget_fileop_ren_file
GTK2.Buttonget_fileop_ren_file()- Description
The rename file button in the file operation button group
- Methodget_select_multiple
intget_select_multiple()- Description
Gets whether the user is allowed to select multiple files.
- Methodget_selection
arrayget_selection()- Description
Retrieves the list of selections the user has made.
- Methodhide_fileop_buttons
GTK2.FileSelectionhide_fileop_buttons()- Description
Hides the file operation buttons that normally appear at the top of the dialog. Useful if you wish to create a custom file selector, based on GTK2.FileSelection.
- Methodset_filename
GTK2.FileSelectionset_filename(stringfname)- Description
Sets a default path for the file requestor. If filename includes a directory path, then the requestor will open with that path as its current working directory.
- Methodset_select_multiple
GTK2.FileSelectionset_select_multiple(intselect_multiple)- Description
Sets whether the user is allowed to select multiple files.
Class GTK2.Fixed
- Description
A fixed container is a container that keeps it's children at fixed locations and give them fixed sizes, both given in pixels.
Example:
GTK2.Fixed()->put(GTK2.Label("100,100"), 100, 100)->put(GTK2.Label("0,0"), 0, 0)->set_size_request(150,115)
Child properties: int x int y
- Methodmove
GTK2.Fixedmove(GTK2.Widgetwidget,intnew_xpos,intnew_ypos)- Description
Move the widget to new_xpos,new_ypos from it's old location.
Class GTK2.FontButton
- Description
Properties: string font-name int show-size int show-style string title int use-font int use-size
Signals: font_set
- Methodcreate
GTK2.FontButtonGTK2.FontButton(string|mappingfont_or_props)- Description
Create a new font picker widget. If font is specified, it will be displayed in the font selection dialog.
- Methodget_font_name
stringget_font_name()- Description
Retrieves the name of the currently selected font.
- Methodget_show_size
intget_show_size()- Description
Returns whether the font size will be shown in the label.
- Methodget_show_style
intget_show_style()- Description
Returns whether the name of the font style will be shown in the label.
- Methodget_use_font
intget_use_font()- Description
Returns whether the selected font is used in the label.
- Methodget_use_size
intget_use_size()- Description
Returns whether the selected size is used in the label.
- Methodset_font_name
intset_font_name(stringfont)- Description
Sets or updates the currently-displayed font.
- Methodset_show_size
GTK2.FontButtonset_show_size(intsetting)- Description
If setting is true, the font size will be displayed along with the name of the selected of the selected font.
- Methodset_show_style
GTK2.FontButtonset_show_style(intsetting)- Description
If setting is true, the font style will be displayed along with the name of the selected font.
- Methodset_title
GTK2.FontButtonset_title(stringtitle)- Description
Sets the title for the font selection dialog.
- Methodset_use_font
GTK2.FontButtonset_use_font(intsetting)- Description
If setting is true, the font name will be written using the selected font.
Class GTK2.FontSelection
- Description
The W(FontSelection) widget lists the available fonts, styles and sizes, allowing the user to select a font. It is used in W(FontSelectionDialog).
GTK2.FontSelection();
Properties: string font-name string preview-text
- Methodcreate
GTK2.FontSelectionGTK2.FontSelection(mapping|voidprops)- Description
Create a new GTK2.FontSelection widget.
- Methodget_preview_text
stringget_preview_text()- Description
Gets the text displayed in the preview area.
- Methodset_font_name
GTK2.FontSelectionset_font_name(stringfontname)- Description
This sets the currently displayed font.
Class GTK2.FontSelectionDialog
- Description
The GtkFontSelectionDialog widget is a dialog box for selecting a font.
To set the font which is initially selected, use set_font_name().
To get the selected font use get_font_name().
To change the text which is shown in the preview area, use set_preview_text().
GTK2.FontSelectionDialog("Select a font")
- Methodcreate
GTK2.FontSelectionDialogGTK2.FontSelectionDialog(stringtitle)- Description
Create a new font selection dialog with the specified window title
- Methodget_preview_text
stringget_preview_text()- Description
Gets the text displayed in the preview area.
Class GTK2.Frame
- Description
The frame widget is a Bin that surrounds its child with a decorative frame and an optional label. If present, the label is drawn in a gap in the top side of the frame. The position of the label can be controlled with set_label_align().
Used to visually group objects.
GTK2.Frame("Title")->add(GTK2.Label("Contents"))
GTK2.Frame()->add(GTK2.Label("Contents"))
GTK2.Frame()->add(GTK2.Label("Contents"))->set_shadow_type(GTK2.SHADOW_IN)
Properties: string label GTK2.Widget label-widget float label-xalign float label-yalign int shadow int shadow-type
- Methodcreate
GTK2.FrameGTK2.Frame(string|mappinglabel_or_props)- Description
Create a new W(Frame) widget.
- Methodset_label_align
GTK2.Frameset_label_align(floatxalign,floatyalign)- Description
Arguments are xalignment and yalignment. 0.0 is left or topmost, 1.0 is right or bottommost. The default value for a newly created Frame is 0.0.
- Methodset_label_widget
GTK2.Frameset_label_widget(GTK2.Widgetlabel)- Description
Sets the label widget for the frame. This is the widget that will appear embedded in the top edge of the frame as a title.
Class GTK2.GdkBitmap
- Description
A bitmap is a black and white pixmap. Most commonly used as masks for images, widgets and pixmaps.
NOIMG
- Methodcreate
GTK2.GdkBitmapGTK2.GdkBitmap(int|Image.Imagexsize_or_image,int|voidysize,string|voidbitmap)- Description
Create a new GDK2.Bitmap object. Argument is either an Image.image object, or {xsisze,ysize,xbitmapdata}.
Class GTK2.GdkColor
- Description
The GDK2.Color object is used to represent a color. When you call GDK2.Color(r,g,b) the color will be allocated from the X-server. The constructor can return an exception if there are no more colors to allocate. NOIMG
- Method_destruct
protectedGDK2.Color_destruct()- Description
Destroys the color object. Please note that this function does not free the color from the X-colormap (in case of pseudocolor) right now.
- Methodcreate
GTK2.GdkColorGTK2.GdkColor(object|intcolor_or_r,int|voidg,int|voidb)- Description
r g and b are in the range 0 to 255, inclusive. If color is specified, it should be an Image.Color object, and the only argument.
- Methodimage_color_object
Image.Color.Colorimage_color_object()- Description
Return a Image.Color.Color instance. This gives better precision than the rgb function.
- Methodpixel
intpixel()- Description
Returns the pixel value of the color. See GDK2.Image->set_pixel.
Class GTK2.GdkColormap
- Description
A colormap is an object that contains the mapping between the color values stored in memory and the RGB values that are used to display color values. In general, colormaps only contain significant information for pseudo-color visuals, but even for other visual types, a colormap object is required in some circumstances.
- Methodalloc_color
intalloc_color(GTK2.GdkColorcolor,intwriteable,intbest_match)- Description
Alocates a single color from a colormap.
- Methodalloc_colors
intalloc_colors(arraycolors,intwriteable,intbest_match)- Description
Allocates colors from a colormap.
- Methodcreate
GTK2.GdkColormapGTK2.GdkColormap(GTK2.GdkVisualvisual,int|voidallocate,int|voidsystem)- Description
Creates a new colormap.
- Methodquery_color
GTK2.GdkColorquery_color(intpixel)- Description
Locates the RGB color corresponding to the given hardware pixel. pixel must be a valid pixel in the colormap; it's a programmer error to call this function with a pixel which is not in the colormap. Hardware pixels are normally obtained from alloc_colors(), or from a GDK2.Image.
Class GTK2.GdkDisplay
- Description
GdkDisplay object.
Signals: closed
- Methodclose
GDK2.Displayclose()- Description
Closes the connection to the window system for the given display, and cleans up associated resources.
- Methodflush
GDK2.Displayflush()- Description
Flushes any requests queued for the windowing system; this happens automatically when the main loop blocks waiting for new events, but if your application is drawing without returning control to the main loop, you may need to call this function explicitly. A common case where this function needs to be called is when an application is executing drawing commands from a thread other than the thread where the main loop is running.
- Methodget_default_cursor_size
intget_default_cursor_size()- Description
Returns the default size to use for cursors.
- Methodget_default_group
GTK2.GdkWindowget_default_group()- Description
Returns the default group leader window for all toplevel windows. This window is implicitly create by GDK.
- Methodget_event
GTK2.GdkEventget_event()- Description
Gets the next GDK2.Event to be processed, fetching events from the windowing system if necessary.
- Methodget_maximal_cursor_size
mappingget_maximal_cursor_size()- Description
Returns the maximal size to use for cursors.
- Methodget_pointer
mappingget_pointer()- Description
Gets the current location of the pointer and the current modifier mask.
- Methodget_screen
GTK2.GdkScreenget_screen(intscreen_num)- Description
Returns a screen for one of the screens.
- Methodget_window_at_pointer
mappingget_window_at_pointer()- Description
Obtains the window underneath the mouse pointer, and the x,y location. Returns 0 if the window is not known to GDK (for example, belongs to another application).
- Methodpeek_event
GTK2.GdkEventpeek_event()- Description
Gets a copy of the first GDK2.Event in the event queue, without removing the event from the queue. (Note that this function will not get more events from the windowing system. It only checks the events that have already been moved to the GDK event queue.)
- Methodput_event
GDK2.Displayput_event(GTK2.GdkEventevent)- Description
Appends a copy of the given event onto the front of the event queue.
- Methodrequest_selection_notification
intrequest_selection_notification(GDK2.Atomselection)- Description
Request GdkEventOwnerChange events for ownership changes of the selection named by the given atom.
- Methodset_double_click_distance
GDK2.Displayset_double_click_distance(intdistance)- Description
Sets the double click distance (two clicks within this distance count as a double click and result in a GDK_2BUTTON_PRESS event). See also set_double_click_time().
- Methodset_double_click_time
GDK2.Displayset_double_click_time(intmsec)- Description
Sets the double click time (two clicks within this time interval counts as a double click and result in a GDK_2BUTTON_PRESS event). Applications should not set this, it is a global user-configured setting.
- Methodstore_clipboard
GDK2.Displaystore_clipboard(GTK2.GdkWindowclipboard_window,arraytargets)- Description
Issues a request to the clipboard manager to store the clipboard data.
- Methodsupports_clipboard_persistence
intsupports_clipboard_persistence()- Description
Returns whether the specified display supports clipboard persistence, i.e. if it's possible to store the clipboard data after an application has quit. On X11 this checks if a clipboard daemon is running.
- Methodsupports_cursor_alpha
intsupports_cursor_alpha()- Description
Returns true if cursors can use an 8bit alpha channel. Otherwise, cursors are restricted to bilevel alpha (i.e. a mask).
- Methodsupports_cursor_color
intsupports_cursor_color()- Description
Returns true if multicolored cursors are supported. Otherwise, cursors have only a foreground and a background color.
- Methodsupports_input_shapes
intsupports_input_shapes()- Description
Returns true if GDK2.Window->input_shape_combine_mask() can be used to modify the input shape of windows.
- Methodsupports_selection_notification
intsupports_selection_notification()- Description
Returns whether GdkEventOwnerChange events will be sent when the owner of a selection changes.
- Methodsupports_shapes
intsupports_shapes()- Description
Returns true if GDK2.Window->shape_combine_mask() can be used to create shaped windows.
- Methodsync
GDK2.Displaysync()- Description
Flushes any requests queued for the windowing system and waits until all requests have been handled. This is often used for making sure that the display is synchronized with the current state of the program. Calling sync() before (gdk_error_trap_pop()) makes sure that any errors generated from earlier requests are handled before the error trap is removed.
This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing.
- Methodwarp_pointer
GDK2.Displaywarp_pointer(GTK2.GdkScreenscreen,intx,inty)- Description
Warps the pointer to the point x,y on the screen, unless the pointer is confined to a window by a grab, in which case it will be moved as far as allowed by the grab. Warping the pointer creates events as if the user had moved the mouse instantaneously to the destination.
Class GTK2.GdkDragContext
- Description
The drag context contains all information about the drag'n'drop connected to the signal to which it is an argument.
NOIMG
- Methoddrag_finish
GDK2.DragContextdrag_finish(intsuccess,intdel)- Description
If success is true, the drag succeded. If del is true, the source should be deleted. time is the current time.
- Methoddrag_set_icon_default
GDK2.DragContextdrag_set_icon_default()- Description
Use the default drag icon associated with the source widget.
- Methoddrag_set_icon_pixmap
GDK2.DragContextdrag_set_icon_pixmap(GTK2.GdkPixmapp,GTK2.GdkBitmapb,inthot_x,inthot_y)- Description
Set the drag pixmap, and optionally mask. The hot_x and hot_y coordinates will be the location of the mouse pointer, relative to the upper left corner of the pixmap.
- Methoddrag_set_icon_widget
GDK2.DragContextdrag_set_icon_widget(GTK2.Widgetwidget,inthot_x,inthot_y)- Description
Set the drag widget. This is a widget that will be shown, and then dragged around by the user during this drag.
- Methoddrag_status
GDK2.DragContextdrag_status(intaction)- Description
Setting action to -1 means use the suggested action
- Methodget_action
intget_action()- Description
One of
GDK_ACTION_ASK,GDK_ACTION_COPY,GDK_ACTION_DEFAULT,GDK_ACTION_LINK,GDK_ACTION_MOVEandGDK_ACTION_PRIVATE;
- Methodget_actions
intget_actions()- Description
A bitwise or of one or more of
GDK_ACTION_ASK,GDK_ACTION_COPY,GDK_ACTION_DEFAULT,GDK_ACTION_LINK,GDK_ACTION_MOVEandGDK_ACTION_PRIVATE;
- Methodget_protocol
intget_protocol()- Description
One of
GDK_DRAG_PROTO_LOCAL,GDK_DRAG_PROTO_MOTIF,GDK_DRAG_PROTO_NONE,GDK_DRAG_PROTO_OLE2,GDK_DRAG_PROTO_ROOTWIN,GDK_DRAG_PROTO_WIN32_DROPFILESandGDK_DRAG_PROTO_XDND
- Methodget_start_time
intget_start_time()- Description
The start time of this drag, as a unix time_t (seconds since 0:00 1/1 1970)
Class GTK2.GdkDrawable
- Description
The GDK2.Bitmap, GDK2.Window and GDK2.Pixmap classes are all GDK drawables.
This means that you can use the same set of functions to draw in them.
Pixmaps are offscreen drawables. They can be drawn upon with the standard drawing primitives, then copied to another drawable (such as a GDK2.Window) with window->draw_pixmap(), set as the background for a window or widget, or otherwise used to show graphics (in a W(Pixmap), as an example). The depth of a pixmap is the number of bits per pixels. Bitmaps are simply pixmaps with a depth of 1. (That is, they are monochrome bitmaps - each pixel can be either on or off).
Bitmaps are mostly used as masks when drawing pixmaps, or as a shape for a GDK2.Window or a W(Widget)
- Methodclear
GDK2.Drawableclear(int|voidx,int|voidy,int|voidwidth,int|voidheight)- Description
Either clears the rectangle defined by the arguments, of if no arguments are specified, the whole drawable.
- Methodcopy_area
GDK2.Drawablecopy_area(GTK2.GdkGCgc,intxdest,intydest,GTK2.Widgetsource,intxsource,intysource,intwidth,intheight)- Description
Copies the rectangle defined by xsource,ysource and width,height from the source drawable, and places the results at xdest,ydest in the drawable in which this function is called.
- Methoddraw_arc
GDK2.Drawabledraw_arc(GTK2.GdkGCgc,intfilledp,intx1,inty1,intx2,inty2,intangle1,intangle2)- Description
Draws a single circular or elliptical arc. Each arc is specified by a rectangle and two angles. The center of the circle or ellipse is the center of the rectangle, and the major and minor axes are specified by the width and height. Positive angles indicate counterclockwise motion, and negative angles indicate clockwise motion. If the magnitude of angle2 is greater than 360 degrees, it is truncated to 360 degrees.
- Methoddraw_bitmap
GDK2.Drawabledraw_bitmap(GTK2.GdkGCgc,GTK2.GdkBitmapbitmap,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw a GDK2(Bitmap) in this drawable. NOTE: This drawable must be a bitmap as well. This will be fixed in GTK 1.3
- Methoddraw_image
GDK2.Drawabledraw_image(GTK2.GdkGCgc,GTK2.GdkImageimage,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw the rectangle specified by xsrc,ysrc+width,height from the GDK2(Image) at xdest,ydest in the destination drawable
- Methoddraw_line
GDK2.Drawabledraw_line(GTK2.GdkGCgc,intx1,inty1,intx2,inty2)- Description
img_begin w = GTK2.DrawingArea()->set_size_request(100,100); delay: g = GDK2.GC(w)->set_foreground( GDK2.Color(255,0,0) ); delay: for(int x = 0; x<10; x++) w->draw_line(g,x*10,0,100-x*10,99); img_end
- Methoddraw_pixbuf
GDK2.Drawabledraw_pixbuf(GTK2.GdkGCgc,GTK2.GdkPixbufpixbuf,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw a GDK2(Pixbuf) in this drawable.
- Methoddraw_pixmap
GDK2.Drawabledraw_pixmap(GTK2.GdkGCgc,GTK2.GdkPixmappixmap,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw the rectangle specified by xsrc,ysrc+width,height from the GDK2(Pixmap) at xdest,ydest in the destination drawable
- Methoddraw_point
GDK2.Drawabledraw_point(GTK2.GdkGCgc,intx,inty)- Description
img_begin w = GTK2.DrawingArea()->set_size_request(10,10); delay: g = GDK2.GC(w)->set_foreground( GDK2.Color(255,0,0) ); delay: for(int x = 0; x<10; x++) w->draw_point(g, x, x); img_end
- Methoddraw_rectangle
GDK2.Drawabledraw_rectangle(GTK2.GdkGCgc,intfilledp,intx1,inty1,intx2,inty2)- Description
img_begin w = GTK2.DrawingArea()->set_size_request(100,100); delay: g = GDK2.GC(w)->set_foreground( GDK2.Color(255,0,0) ); delay: for(int x = 0; x<10; x++) w->draw_rectangle(g,0,x*10,0,100-x*10,99); img_end img_begin w = GTK2.DrawingArea()->set_size_request(100,100); delay: g = GDK2.GC(w); delay: for(int x = 0; x<30; x++) { delay: g->set_foreground(GDK2.Color(random(255),random(255),random(255)) ); delay: w->draw_rectangle(g,1,x*10,0,100-x*10,99); delay: } img_end
- Methoddraw_text
GDK2.Drawabledraw_text(GTK2.GdkGCgc,intx,inty,string|PangoLayouttext)- Description
y is used as the baseline for the text.
- Methodget_geometry
mappingget_geometry()- Description
Get width, height position and depth of the drawable as a mapping.
([ "x":xpos, "y":ypos, "width":xsize, "height":ysize, "depth":bits_per_pixel ])
- Methodset_background
GDK2.Drawableset_background(GTK2.GdkColorto)- Description
Set the background color or image. The argument is either a GDK2.Pixmap or a GDK2.Color object.
Class GTK2.GdkEvent
- Description
Gdk events.
Class GTK2.GdkGC
- Description
A GC, or Graphics Context, is used for most low-level drawing operations.
As an example, the foreground color, background color, and drawing function is stored in the GC.
NOIMG
- Methodcreate
GTK2.GdkGCGTK2.GdkGC(GTK2.Widgetcontext,mapping|voidattributes)- Description
The argument is either a W(Widget) or a GDK2(Drawable) in which the gc will be valid.
- Methodget_values
mappingget_values()- Description
Get all (or rather most) values from the GC. Even though GdkGCValues contains a GdkFont object, we won't return this value because GdkFont is deprecated. The Pango methods should be used instead.
- Methodset_background
GDK2.GCset_background(GTK2.GdkColorcolor)- Description
Set the background to the specified GDK2.Color.
- Methodset_clip_mask
GDK2.GCset_clip_mask(GTK2.GdkBitmapmask)- Description
Set the clip mask to the specified GDK2.Bitmap
- Methodset_clip_origin
GDK2.GCset_clip_origin(intx,inty)- Description
Set the clip mask origin to the specified point.
- Methodset_clip_rectangle
GDK2.GCset_clip_rectangle(GTK2.GdkRectanglerect)- Description
Sets the clip mask for a graphics context from a rectangle. The clip mask is interpreted relative to the clip origin.
- Methodset_clip_region
GDK2.GCset_clip_region(GTK2.GdkRegionrect)- Description
Sets the clip mask for a graphs context from a region. The clip mask is interpreted relative to the clip origin.
- Methodset_dashes
GDK2.GCset_dashes(intoffset,arraydashes)- Description
Sets the way dashed-lines are drawn. Lines will be drawn with alternating on and off segments of the lengths specified in dashes. The manner in which the on and off segments are drawn is determined by the line_style value of the GC.
- Methodset_exposures
GDK2.GCset_exposures(intexp)- Description
Sets whether copying non-visible portions of a drawable using this gc generates exposure events for the corresponding regions of the dest drawable.
- Methodset_foreground
GDK2.GCset_foreground(GTK2.GdkColorcolor)- Description
Set the foreground to the specified GDK2.Color.
- Methodset_function
GDK2.GCset_function(intfun)- Description
Set the function to the specified one. One of GDK2.Xor, GDK2.Invert and GDK2.Copy.
- Methodset_line_attributes
GDK2.GCset_line_attributes(intline_width,intline_style,intcap_style,intjoin_style)- Description
Control how lines are drawn. line_style is one of GDK2.LineSolid, GDK2,LineOnOffDash and GDK2.LineDoubleDash. cap_style is one of GDK2.CapNotLast, GDK2.CapButt, GDK2.CapRound and GDK2.CapProjecting. join_style is one of GDK2.JoinMiter, GDK2.JoinRound and GDK2.JoinBevel.
- Methodset_stipple
GDK2.GCset_stipple(GTK2.GdkBitmapstipple)- Description
Set the background type. Fill must be GDK_STIPPLED or GDK_OPAQUE_STIPPLED.
- Methodset_subwindow
GDK2.GCset_subwindow(intdraw_on_subwindows)- Description
If set, anything drawn with this GC will draw on subwindows as well as the window in which the drawing is done.
- Methodset_tile
GDK2.GCset_tile(GTK2.GdkPixmaptile)- Description
Set the background type. Fill must be GDK_TILED
Class GTK2.GdkImage
- Description
A gdk (low level) image. Mainly used for W(Image) objects.
NOIMG
- Methodcreate
GTK2.GdkImageGTK2.GdkImage(int|voidfast_mode,Image.Image|voidimage)- Description
Create a new GDK2.Image object. The first argument is either 0, which indicates that you want a 'slow' image. If you use '1', you indicate that you want a 'fast' image. Fast images are stored in shared memory, and thus are not sent over any network. But please limit your usage of fast images, they use up a possibly limited system resource set. See the man page for shmget(2) for more information on the limits on shared segments on your system.
A 'fast' image will automatically revert back to 'slow' mode if no shared memory is available.
If the second argument is specified, it is the actual image data.
- Methodget_pixel
intget_pixel(intx,inty)- Description
Get the pixel value of a pixel as a X-pixel value. It is usualy not very easy to convert this value to a rgb triple. See get_pnm.
- Methodget_pnm
stringget_pnm()- Description
Returns the data in the image as a pnm object. Currently, this is always a P6 (true color raw) image. This could change in the future. To get a pike image object do 'Image.PNM.decode( gdkimage->get_pnm() )'
- Methodgrab
GDK2.Imagegrab(GTK2.Widgetwidget,intxoffset,intyoffset,intwidth,intheight)- Description
Call this function to grab a portion of a widget (argument 1) to the image. Grabbing non-toplevel widgets may produce unexpected results. To get the size of a widget use ->xsize() and ->ysize(). To get the offset of the upper left corner of the widget, relative to it's X-window (this is what you want for the offset arguments), use ->xoffset() and ->yoffset().
- Methodset
GDK2.Imageset(Image.Image|intimage_or_xsize,int|voidysize)- Description
Call this to set this image to either the contents of a pike image or a blank image of a specified size.
Class GTK2.GdkPixbuf
- Description
Properties: int bits-per-sample int colorspace (GdkColorspace) int has-alpha int height int n-channels object pixels int rowstride int width
- Methodadd_alpha
GTK2.GdkPixbufadd_alpha(intsubstitute_color,intr,intg,intb)- Description
Adds an alpha channel to this pixbuf and returns a copy. If it already has an alpha channel, the channel values are copied from the original; otherwise, the alpha channel is initialized to 255 (full opacity). If substitute_color is true, then the color specified by (r,g,b) will be assigned zero opacity. That is, if you pass (255,255,255) for the substitute color, all white pixels will become fully transparent.
- Methodcomposite
GTK2.GdkPixbufcomposite(GTK2.GdkPixbufdest,intdest_x,intdest_y,intdest_width,intdest_height,floatoffset_x,floatoffset_y,floatscale_x,floatscale_y,inttype,intoverall_alpha)- Description
Creates a transformation of the source image by scalling by scale_x and scale_y, then translating by offset_x and offset_y. This gives an image in the coordinates of the destination pixbuf. The rectangle (dest_x,dest_y,dest_width,dest_height) is then composited onto the corresponding rectangle of the original destination image. when the destination rectangle contain parts not in the source image, the data at the edges of the source image is replicated to infinity.
- Methodcomposite_color
GTK2.GdkPixbufcomposite_color(GTK2.GdkPixbufdest,intdest_x,intdest_y,intdest_width,intdest_height,floatoffset_x,floatoffset_y,floatscale_x,floatscale_y,inttype,intoverall_alpha,intcheck_x,intcheck_y,intcheck_size,intcolor1,intcolor2)- Description
Creates a transformation of the source image by scaling by scale_x and scale_y, then translating by offset_x and offset_y, then composites the rectangle (dest_x,dest_y,dest_width,dest_height) of the resulting image with a checkboard of the colors color1 and color2 and renders it onto the destinagion image.
See composite_color_simple() for a simpler variant of this function suitable for many tasks.
- Methodcomposite_color_simple
GTK2.GdkPixbufcomposite_color_simple(intdest_width,intdest_height,inttype,intoverall_alpha,intcheck_size,intcolor1,intcolor2)- Description
Creates a new W(Pixbuf) by scalling src to dest_width x dest_height and compositing the result with a checkboard of colors color1 and color2.
- Methodcopy_area
GTK2.GdkPixbufcopy_area(GTK2.GdkPixbufdest,intsrc_x,intsrc_y,intwidt,intheight,intdest_x,intdest_y)- Description
Copies a rectangular area from this pixbuf to dest. Conversion of pixbuf formats is done automatically.
- Methodcreate
GTK2.GdkPixbufGTK2.GdkPixbuf(string|mappingoptions)- Description
Create a GDK2.Pixbuf object.
- Parameter
options optionsis either a filename or a mapping of options.If it is a mapping, it may contain:
"filename":stringName of file to load.
"xpm":stringIf this key exists, then value is xpm data to create from.
"data":stringIf this key exists, then value is pixel data.
"bits":intNumber of bits per sample.
"width":intWidth of image.
"height":intHeight of image.
"alpha":intTrue if alpha channel.
"scale":intTrue if use width and height as scale.
"preserve":intTrue if preserve aspect ratio.
The following is additional keys may exist if the member
"data"exists:"colorspace":intColorspace, default
GDK2.COLORSPACE_RGB, currently ignored."rowstride":intDistance in bytes between row starts.
- Methodflip
GTK2.GdkPixbufflip(inthorizontal)- Description
Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf.
- Methodget_bits_per_sample
intget_bits_per_sample()- Description
Queries the number of bits per color sample.
- Methodget_option
stringget_option(stringkey)- Description
Looks up key in the list of options that may have been attached to the pixbuf when it was loaded.
- Methodget_rowstride
intget_rowstride()- Description
Queries the rowstride of a pixbuf, which is the number of bytes between the start of a row and the start of the next row.
- Methodnew_subpixbuf
GTK2.GdkPixbufnew_subpixbuf(intsrc_x,intsrc_y,intwidth,intheight)- Description
Creates a new pixbuf which represents a sub-region of src. The new pixbuf shares its pixels with the original pixbuf, so writing to one affects both. The new pixbuf holds a reference to this one, so this object will not be finalized until the new pixbuf is finalized.
- Methodrender_threshold_alpha
GTK2.GdkBitmaprender_threshold_alpha(intsrc_x,intsrc_y,intdest_c,intdest_y,intwidth,intheight,intalpha_threshold)- Description
Takes the opacity values in a rectangular portion of a pixbuf and thresholds them to produce a bi-level alpha mask that can be used as a clipping mask for a drawable.
- Methodrotate_simple
GTK2.GdkPixbufrotate_simple(intangle)- Description
Rotates a pixbuf by a multiple of 90 degrees, and returns the result in a new pixbuf. angle is either a multiple of 90 degrees (0,90,180,270), or one of
GDK_PIXBUF_ROTATE_CLOCKWISE,GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE,GDK_PIXBUF_ROTATE_NONEandGDK_PIXBUF_ROTATE_UPSIDEDOWN, which are merely aliases.
- Methodsaturate_and_pixelate
GDK2.Pixbufsaturate_and_pixelate(GTK2.GdkPixbufdest,floatsaturation,intpixelate)- Description
Modifes saturation and optionally pixelates this pixbuf, placing the result in dest. The source and dest may be the same pixbuf with no ill effects. If saturation is 1.0 then saturation is not changed. If it's less than 1.0, saturation is reduced (the image is darkened); if greater than 1.0, saturation is increased (the image is brightened). If pixelate is true, then pixels are faded in a checkerboard pattern to create a pixelated image. This pixbuf and dest must have the same image format, size, and rowstride.
- Methodsave
GTK2.GdkPixbufsave(stringfilename,stringtype,mapping|voidoptions)- Description
Save to a file in format type. "jpeg", "png", "ico", "bmp", are the only valid writable types at this time. Quality is only valid for jpeg images.
- Methodscale
GTK2.GdkPixbufscale(GTK2.GdkPixbufdest,intdest_x,intdest_y,intdest_width,intdest_height,floatoffset_x,floatoffset_y,floatscale_x,floatscale_y,inttype)- Description
Creates a transformation of the source image by scaling by scale_x and scale_y, then translating by offset_x and offset_y, then renders the rectangle (dest_x,dest_y,dest_width,dest_height) of the resulting image onto the destination image replacing the previous contents. Try to use scale_simple() first, this function is the industrial- strength power tool you can fall back to if scale_simple() isn't powerful enough.
- Methodscale_simple
GTK2.GdkPixbufscale_simple(intdest_width,intdest_height,int|voidinterp_type)- Description
Create a new W(Pixbuf) containing a copy of this W(Pixbuf) scaled to dest_width x dest_height. Leaves this W(Pixbuf) unaffected. intertype should be GDK2.INTERP_NEAREST if you want maximum speed (but when scaling down GDK2.INTERP_NEAREST is usually unusably ugly). The default interp_type should be GDK2.INTERP_BILINEAR which offers reasonable quality and speed. You can scale a sub-portion by create a sub-pixbuf with new_subpixbuf().
Class GTK2.GdkPixbufAnimation
- Description
The GdkPixbufAnimation object. Holds animations, like gifs.
- Methodcreate
GTK2.GdkPixbufAnimationGTK2.GdkPixbufAnimation(stringfilename)- Description
Create a new PixbufAnimation.
- Methodget_iter
GTK2.GdkPixbufAnimationIterget_iter()- Description
Get an iterator for displaying an animation. The iterator provides the frames that should be displayed at a given time.
Returns the beginning of the animation. Afterwards you should probably immediately display the pixbuf return by GDK2.PixbufAnimationIter->get_pixbuf(). Then, you should install a timeout or by some other mechanism ensure that you'll update the image after GDK2.PixbufAnimationIter->get_delay_time() milliseconds. Each time the image is updated, you should reinstall the timeout with the new, possibly changed delay time.
To update the image, call GDK2.PixbufAnimationIter->advance().
- Methodget_static_image
GTK2.GdkPixbufget_static_image()- Description
If an animation is really just a plain image (has only one frame), this function returns that image. If the animation is an animation, this function returns reasonable thing to display as a static unanimated image, which might be the first frame, or something more sophisticated. If an animation hasn't loaded any frames yet, this function will return 0.
Class GTK2.GdkPixbufAnimationIter
- Description
An iterator for a PixbufAnimation.
- Methodget_delay_time
intget_delay_time()- Description
Gets the number of milliseconds the current pixbuf should be displayed, or -1 if the current pixbuf should be displayed forever.
- Methodget_pixbuf
GTK2.GdkPixbufget_pixbuf()- Description
Gets the current pixbuf which should be displayed; the pixbuf will be the same size as the animation itself (GDK2.PixbufAnimation->get_width(), GDK2.PixbufAnimation->get_height()). This pixbuf should be displayed for get_delay_time() milliseconds.
Class GTK2.GdkPixbufLoader
- Description
Application-driven progressive image loading.
Signals: area_prepared
area_updated
closed
size_prepared
- Methodclose
boolclose()- Description
informs a pixbuf loader that no further writes with write() will occur, so that it can free its internal loading structures. Also, tries to parse any data that hasn't yet been parsed; if the remaining data is partial or corrupt, FALSE will be returned.
- Methodget_animation
GTK2.GdkPixbufAnimationget_animation()- Description
Queries the GDK2.PixbufAnimation that a pixbuf loader is currently creating. In general it only makes sense to call this function after the "area-prepared" signal has been emitted by the loader. If the loader doesn't have enough bytes yet (hasn't emitted the "area-prepared" signal) this function will return NULL.
- Methodset_size
GDK2.PixbufLoaderset_size(intwidth,intheight)- Description
Causes the image to be scaled while it is loaded. Attempts to set the desired image size are ignored after the emission of the size-prepared signal. (once loading start)
Class GTK2.GdkPixbufSimpleAnim
- Description
Properties: bool loop
- Methodadd_frame
GDK2.PixbufSimpleAnimadd_frame(GTK2.GdkPixbufframe)- Description
Adds a new frame to animation . The pixbuf must have the dimensions specified when the animation was constructed.
- Methodget_loop
boolget_loop()- Description
Returns if animation will loop indefinitely when it reaches the end.
Class GTK2.GdkPixmap
- Description
This class creates a GDK2.Pixmap from either an GDK2.Image or Image.image object (or a numeric ID, see your X-manual for XIDs). The GDK2.Pixmap object can be used in a lot of different GTK widgets. The most notable is the W(Pixmap) widget.
NOIMG
- Methodcreate
GTK2.GdkPixmapGTK2.GdkPixmap(int|objectimage)- Description
Create a new GDK2.Pixmap object. Argument is a GDK2.Image object or a Image.Image object
- Methodset
GDK2.Pixmapset(GTK2.GdkImageimage)- Description
Argument is a GDK2.Image object or an Image.image object. It is much faster to use an gdkImage object, especially one allocated in shared memory. This is only an issue if you are going to change the contents of the pixmap often, toggling between a small number of images.
Class GTK2.GdkRectangle
- Description
Rectangle class.
- Methodcast
(int)GTK2.GdkRectangle()
(float)GTK2.GdkRectangle()
(string)GTK2.GdkRectangle()
(array)GTK2.GdkRectangle()
(mapping)GTK2.GdkRectangle()
(multiset)GTK2.GdkRectangle()- Description
Normally used like (mapping)rectangle or (array)rectangle.
- Methodcreate
GTK2.GdkRectangleGTK2.GdkRectangle(intx,inty,intwidth,intheight)- Description
Create a new rectangle
NOIMG
Class GTK2.GdkRegion
- Description
Region information.
- Methodequal
intequal(GTK2.GdkRegionvictim)- Description
Return true if the region used as an argument is equal to the current region. Also available as a==b when a is a region.
- Methodintersect
GTK2.GdkRegionintersect(GTK2.GdkRegionvictim)- Description
Computes the intersection of the given region and the region. Also available as region & region
- Methodpoint_in
intpoint_in(intx,inty)- Description
Returns true if the given point resides in the given region
- Methodrect_in
intrect_in(GTK2.GdkRectangler)- Description
Returns true if the given rectangle resides inside the given region
- Methodshrink
GDK2.Regionshrink(intdx,intdy)- Description
reduces the size of a region by a specified amount. Positive values shrink the size of the region, and negative values expand the region.
- Methodsubtract
GTK2.GdkRegionsubtract(GTK2.GdkRegionvictim)- Description
Computes the difference of the given region and the region. Also available as region - region
- Methodunion
GTK2.GdkRegionunion(GTK2.GdkRegionvictim)- Description
Computes the union of the given rectangle or region and the region. Also available as region | rectangle, region | region, region + region and region + rectangle.
Class GTK2.GdkScreen
- Description
Properties: font-options float resolution
Signals: composited_changed
size_changed
- Methodget_active_window
GTK2.GdkWindowget_active_window()- Description
Returns the currently active window.
- Methodget_default_colormap
GTK2.GdkColormapget_default_colormap()- Description
Gets the default colormap.
- Methodget_display
GTK2.GdkDisplayget_display()- Description
Gets the display to which this screen belongs.
- Methodget_monitor_at_point
intget_monitor_at_point(intx,inty)- Description
Returns the monitor number in which x,y is located.
- Methodget_monitor_at_window
intget_monitor_at_window(GTK2.GdkWindowwindow)- Description
Returns the number of the monitor in which the largest area of the bounding rectangle of window resides.
- Methodget_monitor_geometry
GTK2.GdkRectangleget_monitor_geometry(intnum)- Description
Retrieves the GDK2.Rectangle representing the size and position of the individual monitor within the entire screen area.
- Methodget_n_monitors
intget_n_monitors()- Description
Returns the number of monitors which this screen consists of.
- Methodget_number
intget_number()- Description
Gets the index of this screen among the screens in the display to which it belongs.
- Methodget_rgb_colormap
GTK2.GdkColormapget_rgb_colormap()- Description
Gets the preferred colormap for rendering image data.
- Methodget_rgb_visual
GTK2.GdkVisualget_rgb_visual()- Description
Get a "preferred visual" chosen by GdkRGB for rendering image data.
- Methodget_rgba_colormap
GTK2.GdkColormapget_rgba_colormap()- Description
Gets a colormap to use for creating windows or pixmaps with an alpha channel.
- Methodget_rgba_visual
GTK2.GdkVisualget_rgba_visual()- Description
Gets a visual to use for creating windows or pixmaps with an alpha channel.
- Methodget_system_colormap
GTK2.GdkColormapget_system_colormap()- Description
Gets the system default colormap.
- Methodget_toplevel_windows
arrayget_toplevel_windows()- Description
Returns a list of all toplevel windows known to GDK on the screen.
- Methodis_composited
intis_composited()- Description
Returns whether windows with an RGBA visual can reasonable be expected to have their alpha channel drawn correctly on the screen.
- Methodlist_visuals
arraylist_visuals(int|voiddef)- Description
List the available visuals. If def is true, return the available visuals for the default screen.
- Methodmake_display_name
stringmake_display_name()- Description
Determines the name to pass to GDK2.Display->open() to get a GDK2.Display with this screen as the default screen.
- Methodset_default_colormap
GDK2.Screenset_default_colormap(GTK2.GdkColormapcolormap)- Description
Sets the default colormap.
Class GTK2.GdkVisual
- Description
A GdkVisual describes a particular video hardware display format. It includes information about the number of bits used for each color, the way the bits are translated into an RGB value for display, and the way the bits are stored in memory.
- Methodcreate
GTK2.GdkVisualGTK2.GdkVisual(int|voidbest,int|voiddepth,int|voidtype)- Parameter
best If best is false the systems default GDK screen is returned, otherwise the screen that best fulfills the given depth and type. If none is given, the one with most colors is selected.
- Parameter
depth The requested bit depth, or 0.
- Parameter
type The requested visual type.
GDK_VISUAL_STATIC_GRAYEach pixel value indexes a grayscale value directly.
GDK_VISUAL_GRAYSCALEEach pixel is an index into a color map that maps pixel values into grayscale values. The color map can be changed by an application.
GDK_VISUAL_STATIC_COLOREach pixel value is an index into a predefined, unmodifiable color map that maps pixel values into RGB values.
GDK_VISUAL_PSEUDO_COLOREach pixel is an index into a color map that maps pixel values into rgb values. The color map can be changed by an application.
GDK_VISUAL_TRUE_COLOREach pixel value directly contains red, green, and blue components. The red_mask, green_mask, and blue_mask fields of the GdkVisual structure describe how the components are assembled into a pixel value.
GDK_VISUAL_DIRECT_COLOREach pixel value contains red, green, and blue components as for
GDK_VISUAL_TRUE_COLOR, but the components are mapped via a color table into the final output table instead of being converted directly.
Class GTK2.GdkWindow
- Description
a GDK2.Window object.
NOIMG
- Methodchange_property
GDK2.Windowchange_property(GDK2.Atomproperty,GDK2.Atomtype,intmode,stringdata)- Description
mode is one of
GDK_PROP_MODE_APPEND,GDK_PROP_MODE_PREPENDandGDK_PROP_MODE_REPLACE
- Methodcreate
GTK2.GdkWindowGTK2.GdkWindow(GTK2.GdkWindowparent,mapping|voidattributes)- Description
Not for non-experts. I promise.
- Methodget_geometry
mappingget_geometry()- Description
Returns ([ "x":xpos, "y":ypos, "width":width, "height":height, "depth":bits_per_pixel ])
- Methodget_property
mappingget_property(GDK2.Atomatom,int|voidoffset,int|voiddelete_when_done)- Description
Returns the value (as a string) of the specified property. The arguments are:
property: The property atom, as an example GDK2.Atom.__SWM_VROOT offset (optional): The starting offset, in elements delete_when_done (optional): If set, the property will be deleted when it has been fetched.
Example usage: Find the 'virtual' root window (many window managers put large windows over the screen)
GDK2.Window root = GTK.root_window(); array maybe=root->children()-> get_property(GDK2.Atom.__SWM_VROOT)-({0}); if(sizeof(maybe)) root=GDK2.Window( maybe[0]->data[0] );
- Methodgrab_input_focus
GDK2.Windowgrab_input_focus()- Description
Forcibly grab the input focus.
Useful for override-redirect windows in games. Note that the only way to get rid of the focus is to close the window, be careful.
- Methodis_visible
intis_visible()- Description
Return 1 if the window, or a part of the window, is visible right now.
- Methodmove_resize
GDK2.Windowmove_resize(intx,inty,intw,inth)- Description
Move and resize the window in one call.
- Methodset_background
GDK2.Windowset_background(GTK2.GdkColorto)- Description
Set the background color or image. The argument is either a GDK2.Pixmap or a GDK2.Color object.
- Methodset_bitmap_cursor
GDK2.Windowset_bitmap_cursor(GTK2.GdkBitmapimage,GTK2.GdkBitmapmask,GTK2.GdkColorfg,GTK2.GdkColorbg,intxhot,intyhot)- Description
xhot,yhot are the locations of the x and y hotspot relative to the upper left corner of the cursor image.
- Methodset_cursor
GDK2.Windowset_cursor(intnew_cursor)- Description
Change the window cursor.<table border="0" cellpadding="3" cellspacing="0"> CURS(GDK2.Arrow) CURS(GDK2.BasedArrowDown) CURS(GDK2.BasedArrowUp) CURS(GDK2.Boat) CURS(GDK2.Bogosity) CURS(GDK2.BottomLeftCorner) CURS(GDK2.BottomRightCorner) CURS(GDK2.BottomSide) CURS(GDK2.BottomTee) CURS(GDK2.BoxSpiral) CURS(GDK2.CenterPtr) CURS(GDK2.Circle) CURS(GDK2.Clock) CURS(GDK2.CoffeeMug) CURS(GDK2.Cross) CURS(GDK2.CrossReverse) CURS(GDK2.Crosshair) CURS(GDK2.DiamondCross) CURS(GDK2.Dot) CURS(GDK2.Dotbox) CURS(GDK2.DoubleArrow) CURS(GDK2.DraftLarge) CURS(GDK2.DraftSmall) CURS(GDK2.DrapedBox) CURS(GDK2.Exchange) CURS(GDK2.Fleur) CURS(GDK2.Gobbler) CURS(GDK2.Gumby) CURS(GDK2.Hand1) CURS(GDK2.Hand2) CURS(GDK2.Heart) CURS(GDK2.Icon) CURS(GDK2.IronCross) CURS(GDK2.LeftPtr) CURS(GDK2.LeftSide) CURS(GDK2.LeftTee) CURS(GDK2.Leftbutton) CURS(GDK2.LlAngle) CURS(GDK2.LrAngle) CURS(GDK2.Man) CURS(GDK2.Middlebutton) CURS(GDK2.Mouse) CURS(GDK2.Pencil) CURS(GDK2.Pirate) CURS(GDK2.Plus) CURS(GDK2.QuestionArrow) CURS(GDK2.RightPtr) CURS(GDK2.RightSide) CURS(GDK2.RightTee) CURS(GDK2.Rightbutton) CURS(GDK2.RtlLogo) CURS(GDK2.Sailboat) CURS(GDK2.SbDownArrow) CURS(GDK2.SbHDoubleArrow) CURS(GDK2.SbLeftArrow) CURS(GDK2.SbRightArrow) CURS(GDK2.SbUpArrow) CURS(GDK2.SbVDoubleArrow) CURS(GDK2.Shuttle) CURS(GDK2.Sizing) CURS(GDK2.Spider) CURS(GDK2.Spraycan) CURS(GDK2.Star) CURS(GDK2.Target) CURS(GDK2.Tcross) CURS(GDK2.TopLeftArrow) CURS(GDK2.TopLeftCorner) CURS(GDK2.TopRightCorner) CURS(GDK2.TopSide) CURS(GDK2.TopTee) CURS(GDK2.Trek) CURS(GDK2.UlAngle) CURS(GDK2.Umbrella) CURS(GDK2.UrAngle) CURS(GDK2.Watch) CURS(GDK2.Xterm) </table>
- Methodset_events
GDK2.Windowset_events(intevents)- Description
events is a bitwise or of one or more of the following constants: GDK2.ExposureMask, GDK2.PointerMotionMask, GDK2.PointerMotion_HINTMask, GDK2.ButtonMotionMask, GDK2.Button1MotionMask, GDK2.Button2MotionMask, GDK2.Button3MotionMask, GDK2.ButtonPressMask, GDK2.ButtonReleaseMask, GDK2.KeyPressMask, GDK2.KeyReleaseMask, GDK2.EnterNotifyMask, GDK2.LeaveNotifyMask, GDK2.FocusChangeMask, GDK2.StructureMask, GDK2.PropertyChangeMask, GDK2.VisibilityNotifyMask, GDK2.ProximityInMask, GDK2.ProximityOutMask and GDK2.AllEventsMask
- Methodset_icon
GDK2.Windowset_icon(GTK2.GdkPixmappixmap,GTK2.GdkBitmapmask,GTK2.GdkWindowwindow)- Description
Set the icon to the specified image (with mask) or the specified GDK2.Window. It is up to the window manager to display the icon. Most window manager handles window and pixmap icons, but only a few can handle the mask argument. If you want a shaped icon, the only safe bet is a shaped window.
- Methodset_icon_name
GDK2.Windowset_icon_name(stringname)- Description
Set the icon name to the specified string.
Class GTK2.Gdk_Atom
- Description
An X-atom. You most likely want to use GDK2.Atom.atom_name instead of GDK2._Atom(name).
- Methodcreate
GTK2.Gdk_AtomGTK2.Gdk_Atom(stringatom_name,int|voidonly_if_exists)- Description
Create a new low-level atom. You should normally not call this function directly. Use GDK2.Atom[name] instead of GDK2._Atom(name,0).
Class GTK2.GladeXML
- Description
Glade is a free GUI builder for GTK2+ and Gnome. It's normally used to create C-code, but can also produce code for other languages. Libglade is a utility library that builds the GI from the Glade XML save files. This module uses libglade and allows you to easily make GUI designs to be used with your Pike applications.
- Methodcreate
GTK2.GladeXMLGTK2.GladeXML(stringfilename_or_buffer,int|voidsize,string|voidroot,string|voiddomain)- Description
Creates a new GladeXML object (and the corresponding widgets) from the XML file. Optionally it will only build the interface from the widget node root. This feature is useful if you only want to build say a toolbar or menu from the XML file, but not the window it is embedded in. Note also that the XML parse tree is cached to speed up creating another GladeXML object from the same file. The third optional argument is used to specify a different translation domain from the default to be used. If xml description is in a string buffer instead, specify the size (or -1 to auto-calculate). If size is 0, then it will assume a file with root and/or domain specified.
- Methodget_signal_id
intget_signal_id(GTK2.Widgetwidget)- Description
Used to get the signal id attached to a GladeXML object.
- Methodget_widget
GTK2.Widgetget_widget(stringname)- Description
This function is used to get the widget corresponding to name in the interface description. You would use this if you have to do anything to the widget after loading.
- Methodget_widget_name
stringget_widget_name(GTK2.Widgetwidget)- Description
Used to get the name of a widget that was generated by a GladeXML object.
- Methodget_widget_prefix
arrayget_widget_prefix(stringname)- Description
This function is used to get a list GTK2.Widgets with names that start with the string name in the interface description.
- Methodsignal_autoconnect
GTK2.GladeXMLsignal_autoconnect(mappingcallbacks,mixeddata)- Description
Try to connect functions to all signals in the interface. The mapping should consist of handler name : function pairs. The data argument will be saved and sent as the first argument to all callback functions.
Class GTK2.Gnome2App
- Description
Toplevel GNOME applications would normally use one Gnome2.App widget as their toplevel window. You can create as many Gnome2.App widgets as you want, for example, some people use one GnomeApp per document their application loads.
Once you have created one instance of this widget, you would add your main application view information to this window by using set_contents() routine.
The GnomeApp has support for including a menubar, one or more toolbars and a statusbar for your application. It also takes care of intalling the accelerators for you when used in conjuction with the gnome-app-helper routines. The toolbars are inserted into Gnome2.Dock widgets.
The gnome-app-helper module provides various helper routines to simplify the configuration of your menus and toolbars, but you can create those yourself and use the set_menus(), add_toolbar(), set_toolbar(), add_dock_item() and add_docked(). Properties: string app-id
- Methodadd_docked
Gnome2.Appadd_docked(GTK2.Widgetwidget,stringname,intbehavior,intplacement,intband_num,intband_position,int|voidoffset)- Description
Create a new Gnome2.DockItem widget containing widget, and add it to app's dock with the specified layout information. Notice that, if automatic layout configuration is enabled, the layout is overridden by the saved configuration, if any.
widget : Widget to be added to app's dock name : Name for the dock item that will contain toolbar behavior : Behavior for the new dock item. One of
GNOME_DOCK_ITEM_BEH_EXCLUSIVE,GNOME_DOCK_ITEM_BEH_LOCKED,GNOME_DOCK_ITEM_BEH_NEVER_FLOATING,GNOME_DOCK_ITEM_BEH_NEVER_HORIZONTAL,GNOME_DOCK_ITEM_BEH_NEVER_VERTICALandGNOME_DOCK_ITEM_BEH_NORMALplacement : Placement for the new dock item, one of Gnome2.DockTop, Gnome2.DockRight, Gnome2.DockBottom, Gnome2.DockLeft and Gnome2.DockFloating band_num : Number of the band where the dock item should be placed band_position : Position of the new dock item in band band_num offset : Offset from the previous dock item in the band; if there is no previous item, offset from the beginning of the band.
- Methodadd_toolbar
Gnome2.Appadd_toolbar(GTK2.Toolbartoolbar,stringname,intbehavior,intplacement,intband_num,intband_position,int|voidoffset)- Description
Create a new Gnome2.DockItem widget containing toolbar, and add it to app's dock with the specified layout information. Notice that, if automatic layout configuration is enabled, the layout is overridden by the saved configuration, if any.
toolbar : Toolbar to be added to app's dock name : Name for the dock item that will contain toolbar behavior : Behavior for the new dock item. One or more of
GNOME_DOCK_ITEM_BEH_EXCLUSIVE,GNOME_DOCK_ITEM_BEH_LOCKED,GNOME_DOCK_ITEM_BEH_NEVER_FLOATING,GNOME_DOCK_ITEM_BEH_NEVER_HORIZONTAL,GNOME_DOCK_ITEM_BEH_NEVER_VERTICALandGNOME_DOCK_ITEM_BEH_NORMALplacement : Placement for the new dock item, one of Gnome2.DockTop, Gnome2.DockRight, Gnome2.DockBottom, Gnome2.DockLeft and Gnome2.DockFloating band_num : Number of the band where the dock item should be placed band_position : Position of the new dock item in band band_num offset : Offset from the previous dock item in the band; if there is no previous item, offset from the beginning of the band.
- Methodcreate
GTK2.Gnome2AppGTK2.Gnome2App(stringappname,string|voidtitle)- Description
Create a new (empty) application window. You must specify the application's name (used internally as an identifier). title can be left as 0, in which case the window's title will not be set.
- Methodenable_layout_config
Gnome2.Appenable_layout_config(intenable)- Description
Specify whether the the dock's layout configuration should be automatically saved via gnome-config whenever it changes, or not.
- Methodset_contents
Gnome2.Appset_contents(GTK2.Widgetcontents)- Description
Sets the status bar of the application window.
- Methodset_menus
Gnome2.Appset_menus(GTK2.MenuBarmenu_bar)- Description
Sets the menu bar of the application window.
- Methodset_statusbar
Gnome2.Appset_statusbar(GTK2.Widgetstatusbar)- Description
Sets the status bar of the application window.
- Methodset_statusbar_custom
Gnome2.Appset_statusbar_custom(GTK2.Widgetcontainer,GTK2.Widgetstatusbar)- Description
Sets the status bar of the application window, but use container as its container.
Class GTK2.Gnome2Appbar
- Description
A bar that GNOME applications put on the bottom of the windows to display status, progress, hints for menu items or a minibuffer for getting some sort of response. It has a stack for status messages
GTK2.Gnome2Appbar( 1, 1, GTK2.GNOME_PREFERENCES_USER )->set_progress_percentage( 0.4 );
Properties: int has-progress int has-status int interactivity
Signals: clear_prompt Emitted when the prompt is cleared. mixed user_data
user_response Emitted when the user hits enter after a prompt. mixed user_data
- Methodclear_stack
Gnome2.Appbarclear_stack()- Description
Remove all status messages from appbar, and display default status message (if present).
- Methodcreate
GTK2.Gnome2AppbarGTK2.Gnome2Appbar(inthas_progress,inthas_status,intinteractivity)- Description
Create a new GNOME application status bar. If has_progress is TRUE, a small progress bar widget will be created, and placed on the left side of the appbar. If has_status is TRUE, a status bar, possibly an editable one, is created.
interactivity determines whether the appbar is an interactive "minibuffer" or just a status bar. If it is set to Gnome2.PREFERENCES_NEVER, it is never interactive. If it is set to Gnome2.PREFERENCES_USER we respect user preferences from ui-properties. If it's Gnome2.PREFERENCES_ALWAYS we are interactive whether the user likes it or not. Basically, if your app supports both interactive and not (for example, if you use the gnome-app-util interfaces), you should use Gnome2.PREFERENCES_USER. Otherwise, use the setting you support. Please note that "interactive" mode is not functional now; GtkEntry is inadequate and so a custom widget will be written eventually.
- Methodget_progress
GTK2.ProgressBarget_progress()- Description
Returns GTK2.ProgressBar widget pointer, so that the progress bar may be manipulated further.
- Methodpop
Gnome2.Appbarpop()- Description
Remove current status message, and display previous status message, if any. It is OK to call this with an empty stack.
- Methodpush
Gnome2.Appbarpush(stringwhat)- Description
Push a new status message onto the status bar stack, and display it.
- Methodrefresh
Gnome2.Appbarrefresh()- Description
Reflect the current state of stack/default. Useful to force a set_status to disappear.
- Methodset_default
Gnome2.Appbarset_default(stringdefault_status)- Description
What to show when showing nothing else; defaults to "".
- Methodset_progress_percentage
Gnome2.Appbarset_progress_percentage(floatpercentage)- Description
Sets progress bar to the given percentage.
- Methodset_prompt
Gnome2.Appbarset_prompt(stringprompt,intmodal)- Description
Put a prompt in the appbar and wait for a response. When the user responds or cancels, a "user-response" signal is emitted.
Class GTK2.Gnome2Canvas
- Description
Gnome2.Canvas is an engine for structured graphics that offers a rich imaging model, high performance rendering, and a powerful, high level API. It offers a choice of two rendering back-ends, one based on Xlib for extremely fast display, and another based on Libart, a sophisticated, antialiased, alpha-compositing engine. This widget can be used for flexible display of graphics and for creating interactive user interface elements.
A Gnome2.Canvas widget contains one or more Gnome2.CanvasItem objects. Items consist of graphing elements like lines, ellipses, polygons, images, text, and curves. These items are organized using Gnome2.CanvasGroup objects, which are themselves derived from Gnome2.CanvasItem. Since a group is an item it can be contained within other groups, forming a tree of canvas items. Certain operations, like translating and scaling, can be performed on all items in a group. See http://developer.gnome.org/doc/API/2.0/libgnomecanvas/GnomeCanvas.html for more information. Properties: int aa
Signals: draw_background
render_background
- Methodcreate
GTK2.Gnome2CanvasGTK2.Gnome2Canvas(int|voidanti_alias)- Description
Create a new Gnome2.Canvas widget. Set anti_alias to true to create a canvas in antialias mode.
- Methodget_center_scroll_region
intget_center_scroll_region()- Description
Returns whether the canvas is set to center the scrolling region in the window if the former is smaller than the canvas' allocation.
- Methodget_color
GTK2.GdkColorget_color(string|voidspec)- Description
Allocates a color based on the specified X color specification. An omitted or empty string is considered transparent.
- Methodget_color_pixel
intget_color_pixel(intrgba)- Description
Allocates a color from the RGBA value passed into this function. The alpha opacity value is discarded, since normal X colors do not support it.
- Methodget_dither
intget_dither()- Description
Returns the type of dithering used to render an antialiased canvas.
- Methodget_item_at
GTK2.Gnome2CanvasItemget_item_at(floatx,floaty)- Description
Looks for the item that is under the specified position, which must be specified in world coordinates.
- Methodget_scroll_offsets
arrayget_scroll_offsets()- Description
Queries the scrolling offsets of a canvas. The values are returned in canvas pixel units.
- Methodget_scroll_region
mappingget_scroll_region()- Description
Queries the scrolling region of a canvas.
- Methodscroll_to
Gnome2.Canvasscroll_to(intcx,intcy)- Description
Makes a canvas scroll to the specified offsets, given in canvas pixel units. The canvas will adjust the view so that it is not outside the scrolling region. This function is typically not used, as it is better to hook scrollbars to the canvas layout's scrolling adjustments.
- Methodset_center_scroll_region
Gnome2.Canvasset_center_scroll_region(intsetting)- Description
When the scrolling region of the canvas is smaller than the canvas window, e.g. the allocation of the canvas, it can be either centered on the window or simply made to be on the upper-left corner on the window.
- Methodset_dither
Gnome2.Canvasset_dither(intdither)- Description
Controls the dithered rendering for antialiased canvases. The value of dither should be GDK2.RgbDitherNone, GDK2.RgbDitherNormal, or GDK2.RgbDitherMax. The default canvas setting is GDK2.RgbDitherNormal.
- Methodset_pixels_per_unit
Gnome2.Canvasset_pixels_per_unit(floatn)- Description
Sets the zooming factor of a canvas by specifying the number of pixels that correspond to one canvas unit.
The anchor point for zooming, i.e. the point that stays fixed and all others zoom inwards or outwards from it, depends on whether the canvas is set to center the scrolling region or not. You can contorl this using the set_center_scroll_region() function. If the canvas is set to center the scroll region, then the center of the canvas window is used as the anchor point for zooming. Otherwise, the upper-left corner of the canvas window is used as the anchor point.
- Methodset_scroll_region
Gnome2.Canvasset_scroll_region(floatx1,floaty1,floatx2,floaty2)- Description
Sets the scrolling region of a canvas to the specified rectangle. The canvas will then be able to scroll only within this region. The view of the canvas is adjusted as appropriate to display as much of the new region as possible.
- Methodw2c
arrayw2c(floatwx,floatwy)- Description
Converts world coordinates into canvas pixel coordinates.
- Methodw2c_affine
arrayw2c_affine()- Description
Gets the affine transform that converts from world coordinates to canvas pixel coordinates.
- Methodw2c_d
arrayw2c_d(floatwx,floatwy)- Description
Converts world coordinates into canvas pixel coordinates. This version returns coordinates in floating point coordinates, for greater precision.
- Methodwindow_to_world
arraywindow_to_world(floatwinx,floatwiny)- Description
Converts window-relative coordinates into world coordinates. You can use this when you need to convert mouse coordinates into world coordinates, for example.
Class GTK2.Gnome2CanvasClipgroup
- Description
Properties: string path int wind
Class GTK2.Gnome2CanvasItem
- Description
This is the base class for all canvas items. Canvas items are the drawing elements of a Gnome2.Canvas. Example items include lines, ellipses, polygons, images, text, curves, and even arbitary GTK+ widgets.
Properties: Gnome2.CanvasItem parent
Signals: event
Class GTK2.Gnome2CanvasLine
- Description
Properties: float arrow-shape-a float arrow-shape-b float arrow-shape-c int cap-style string fill-color GDK2.Color fill-color-gdk int fill-color-rgba GDK2.Drawable fill-stipple int first-arrowhead int join-style int last-arrowhead int line-style Gnome2.CanvasPoints points int smooth int spline-steps int width-pixels float width-units
Class GTK2.Gnome2CanvasPixbuf
- Description
Properties: int anchor float height int height-in-pixels int height-set GDK2.Pixbuf pixbuf float width int width-in-pixels int width-set float x int x-in-pixels float y int y-in-pixels
Class GTK2.Gnome2CanvasRE
- Description
Properties: float x1 float x2 float y1 float y2
Class GTK2.Gnome2CanvasRichText
- Description
Properties: int anchor int cursor-blink int cursor-visible int direction int editable int grow-height float height int indent int justification int left-margin int pixels-above-lines int pixels-below-lines int pixels-inside-wrap int right-margin string text int visible float width int wrap-mode float x float y
Signals: tag_changed
Class GTK2.Gnome2CanvasShape
- Description
Properties: int cap-style string dash string fill-color GDK2.Color fill-color-gdk int fill-color-rgba GDK2.Drawable fill-stipple int join-style float miterlimit string outline-color GDK2.Color outline-color-gdk int outline-color-rgba GDK2.Drawable outline-stipple int width-pixels float width-units int wind
Class GTK2.Gnome2CanvasText
- Description
Properties: int anchor Pango.AttrList attributes int clip float clip-height float clip-width string family int family-set string fill-color GDK2.Color fill-color-gdk int fill-color-rgba GDK2.Drawable fill-stipple string font Pango.FontDescription font-dest int justification string markup int rise int rise-set float scale int scale-set int size float size-points int size-set Pango.Stretch stretch int stretch-set int strikethrough int strikethrough-set Pango.Style style int style-set string text float text-height float text-width Pango.Underline underline int underline-set Pango.Variant variant int variant-set int weight float x float x-offset float y float y-offset
Class GTK2.Gnome2CanvasWidget
- Description
Properties: int anchor float height int size-pixels GTK2.Widget widget float width float x float y
Class GTK2.Gnome2Client
- Description
Signals: connect Called once the client has been connected to the signal manager. int arg1, mixed user_data
die Called when the session manager wants the client to shut down. mixed user_data
disconnect Called when the client is disconnected from the session manager. mixed user_data
save_complete Called when the session manager has finished checkpointing all of the clients. Clients are then free to change their state. mixed user_data
save_yourself Called when either a "SaveYourself" or a "SaveYourselfPhase2" call is made by the session manager. int arg1: the phase of the "SaveYourself" command ('1' or '2'). int arg2: the data which should be saved (local, global, or both). int arg3: true if the session manager is shutting down. int arg4: how the client is allowed to interact with the user while saving. int arg5: true if this is to be a "fast" shutdown. mixed user_data
shutdown_cancelled Called if the session manager had sent a "SaveYourself" to all clients in preparation for shutting down and the shutdown was then cancelled. A client can then continue running and change its state. mixed user_data
- Methodcreate
GTK2.Gnome2ClientGTK2.Gnome2Client()- Description
Gets the master session management client.
- Methodflush
Gnome2.Clientflush()- Description
This will force the underlying connection to the session manager to be flushed. This is useful if you have some pending changes that you want to make sure get committed.
- Methodget_config_prefix
stringget_config_prefix()- Description
Get the config prefix. This config prefix provides a suitable place to store any details about the state of the client which can not be described using the app's command line arguments (as set in the restart command).
- Methodget_desktop_id
stringget_desktop_id()- Description
Get the client ID of the desktop's current instance, i.e. if you consider the desktop as a whole as a session managed app, this returns its session ID using a gnome extension to session management. May return empty for apps not running under a recent version of gnome-session; apps should handle that case.
- Methodget_global_config_prefix
stringget_global_config_prefix()- Description
Get the config prefix that will be returned by get_config_prefix() for clients which have NOT been restarted or cloned (i.e. for clients started by the user without '--sm-' options). This config prefix may be used to write the user's preferred config for these "new"clients".
You could also use this prefix as a place to store and retrieve config details that you wish to apply to ALL instances of the app. However, this practice limits the users freedom to configure each instance in a different way so it should be used with caution.
- Methodget_previous_id
stringget_previous_id()- Description
Get the session management ID from the previous session.
- Methodrequest_phase_2
Gnome2.Clientrequest_phase_2()- Description
Request the session manager to emit the "save-yourself" signal for a second time after all the clients in the session have ceased interacting with the user and entered an idle state. This might be useful if your app managers other apps and requires that they are in an idle state before saving its final data.
- Methodrequest_save
Gnome2.Clientrequest_save(intsave_style,intshutdown,intinteract_style,intfast,intglobal)- Description
Request the session manager to save the session in some way. The arguments correspond with the arguments passed to the "save-yourself" signal handler.
The save_style (
GNOME_SAVE_BOTH,GNOME_SAVE_GLOBALandGNOME_SAVE_LOCAL) indicates whether the save should affect data accessible to other users (GTK2.GNOME_SAVE_GLOBAL) or only the state visible to the current user (GTK2.GNOME_SAVE_LOCAL), or both. Setting shutdown to true will initiate a logout. The interact_style (GNOME_INTERACT_ANY,GNOME_INTERACT_ERRORSandGNOME_INTERACT_NONE) specifies which kinds of interaction will be available. Setting fast to true will limit the save to setting the session manager properties plus any essential data. Setting the value of global to true will request that all the other apps in the session do a save as well. A global save is mandatory when doing a shutdown.
- Methodsave_any_dialog
Gnome2.Clientsave_any_dialog(GTK2.Dialogdialog)- Description
May be called during a "save-yourself" handler to request that a (modal) dialog is presented to the user. The session manager decides when the dialog is shown, but it will not be shown it unless the session manager is sending an interaction style of GTK2.GNOME_INTERACT_ANY. "Cancel" and "Log out" buttons will be added during a shutdown.
- Methodsave_error_dialog
Gnome2.Clientsave_error_dialog(GTK2.Dialogdialog)- Description
May be called during a "save-yourself" handler when an error has occurred during the save.
- Methodset_clone_command
Gnome2.Clientset_clone_command(arrayargv)- Description
Set a command the session manager can use to create a new instance of the application. Not implemented yet.
- Methodset_current_directory
Gnome2.Clientset_current_directory(stringdir)- Description
Set the directory to be in when running shutdown, discard, restart, etc. commands.
- Methodset_discard_command
Gnome2.Clientset_discard_command(arrayargv)- Description
Provides a command to run when a client is removed from the session. It might delete session-specific config files, for example. Executing the discard command on the local host should delete the information saved as part of the session save that was in progress when the discard command was set. For example: string prefix=client->get_config_prefix(); array argv=({ "rm","-r" }); argv+=({ Gnome2.Config->get_real_path(prefix) }); client->set_discard_command(argv); Not implemented yet.
- Methodset_environment
Gnome2.Clientset_environment(stringname,stringvalue)- Description
Set an environment variable to be placed in the client's environment prior to running restart, shutdown, discard, etc. commands.
- Methodset_global_config_prefix
Gnome2.Clientset_global_config_prefix(stringprefix)- Description
Set the value used for the global config prefix. The global config prefix defaults to a name based on the name of the executable. This function allows you to set it to a different value. It should be called BEFORE retrieving the config prefix for the first time. Later calls will be ignored.
- Methodset_priority
Gnome2.Clientset_priority(intpriority)- Description
The gnome-session manager restarts clients in order of their priorities in a similar way to the start up ordering in SysV. This function allows the app to suggest a position in this ordering. The value should be between 0 and 99. A default value of 50 is assigned to apps that do not provide a value. The user may assign a different priority.
- Methodset_resign_command
Gnome2.Clientset_resign_command(arrayargv)- Description
Some clients can be "undone", removing their effects and deleting any saved state. For example, xmodmap could register a resign command to undo the keymap changes it saved.
Used by clients that use the GTK2.GNOME_RESTART_ANYWAY restart style to undo their effects (these clients usually perform initialization functions and leave effects behind after they die). The resign command combines the effects of a shutdown command and a discard command. It is executed when the user decides that the client should cease to be restarted. Not implemented yet.
- Methodset_restart_command
Gnome2.Clientset_restart_command(arrayargv)- Description
When clients crash or the user logs out and back in, they are restarted. This command should perform the restart. Executing the restart command on the local host should reproduce the state of the client at the time of the session save as closely as possible. Saving config info under the get_config_prefix() is generally useful. Not implemented yet.
- Methodset_restart_style
Gnome2.Clientset_restart_style(intstyle)- Description
Tells the session manager how the client should be restarted in future sessions. One of
GNOME_RESTART_ANYWAY,GNOME_RESTART_IF_RUNNING,GNOME_RESTART_IMMEDIATELYandGNOME_RESTART_NEVER
- Methodset_shutdown_command
Gnome2.Clientset_shutdown_command(arrayargv)- Description
GTK2.GNOME_RESTART_ANYWAY clients can set this command to run when the user logs out but the client is no longer running.
Used by clients that use the GTK2.GNOME_RESTART_ANYWAY restart style to undo their effects (these clients usually perform initialization functions and leave effects behind after they die). The shutdown command simply undoes the effects of the client. It is executed during a normal logout. Not implemented yet.
Class GTK2.Gnome2DateEdit
- Description
The GnomeDateEdit widget provides a way to enter dates and times with a helper calendar to let the user select the date.
GTK2.Gnome2DateEdit(time(),1,1);
GTK2.Gnome2DateEdit(time(),0,1);
Properties: int dateedit-flags int initial-time int lower-hour int time int upper-hour
Signals: date_changed
time_changed
- Methodcreate
GTK2.Gnome2DateEditGTK2.Gnome2DateEdit(intthe_time,intshow_time,intuse_24_format)- Description
Creates a new GnomeDateEdit widget which can be used to provide an easy to use way for entering dates and times.
- Methodget_initial_time
intget_initial_time()- Description
Queries the initial time that was set using set_time() or during creation.
- Methodset_flags
Gnome2.DateEditset_flags(intflags)- Description
Bitwise or of
GNOME_DATE_EDIT_24_HR,GNOME_DATE_EDIT_SHOW_TIMEandGNOME_DATE_EDIT_WEEK_STARTS_ON_MONDAY.
- Methodset_popup_range
Gnome2.DateEditset_popup_range(intlow_hour,intup_hour)- Description
Sets the range of times that will be provide by the time popup selectors.
Class GTK2.Gnome2Druid
- Description
The GNOME druid is a system for assisting the user with installing a service. It is roughly equivalent in functionality to the "Wizards" available in Windows.
There are two major parts of the druid, the Gnome2.Druid widget, and the set of W(Gnome2.DruidPage) widgets. The Gnome2.Druid widget is the main widget that interacts with the user. It has a Next, a Prev, and a Cancel button, and acts as a container for the pages. It is not a top-level window, so it needs to be put in a W(GTK2.Window) in almost all cases. The W(Gnome2.DruidPage) is a virtual widget, from which all of the actual content of the page inherits from. There are currently three of these available within gnome-libs.
GNOME druids are fairly simple to program with. You start by creating a GnomeDruid into which you put all of your pages. This widget will handle the presentation of the W(GnomeDruidPage) widgets.
You then create all appropriate W(GnomeDruidPage) widgets. There are three implementations of these, although there is no reason why more couldn't be written. They are the W(GnomeDruidPageStart), the W(GnomeDruidPageStandard), and the W(GnomeDruidPageFinish). The W(GnomeDruidPageStandard) acts as a W(Container), and is probably the most commonly used druid page. The other ones, as their names might suggest, are used at the endpoints of the druid. More information on the specific properties of these widgets can be found on their respective pages.
You will need to add the pages to the druid in order for them to appear. The druid itself keeps an internal list of all pages, and using the prepend_page(), append_page(), and insert_page() functions will place them into it.
Properties: int show-finish int show-help
Signals: cancel This signal is emitted when the "cancel" button has been pressed. Note that the current druid page has the option to trap the signal and use it, if need be, preventing this signal from being emitted.
help
- Methodappend_page
Gnome2.Druidappend_page(GTK2.Gnome2DruidPagepage)- Description
This will append a GnomeDruidPage into the internal list of pages that the druid has.
- Methodinsert_page
Gnome2.Druidinsert_page(GTK2.Gnome2DruidPageback_page,GTK2.Gnome2DruidPagepage)- Description
This will insert page after back_page into the list of internal pages that the druid has. If back_page is not present in the list or is 0, page will be prepended to the list.
- Methodprepend_page
Gnome2.Druidprepend_page(GTK2.Gnome2DruidPagepage)- Description
This will prepend a GnomeDruidPage into the internal list of pages that the druid has.
- Methodset_buttons_sensitive
Gnome2.Druidset_buttons_sensitive(intback_sensitive,intnext_sensitive,intcancel_sensitive,inthelp_sensitive)- Description
Sets the sensitivity of the druid's control-buttons. If the variables are TRUE, then they will be clickable. This function is used primarily by the actual W(GnomeDruidPage) widgets.
- Methodset_page
Gnome2.Druidset_page(GTK2.Gnome2DruidPagepage)- Description
This will make page the currently showing page in the druid. page must already be in the druid.
- Methodset_show_finish
Gnome2.Druidset_show_finish(intshow_finish)- Description
Sets the text on the last button on the druid. If show_finish is TRUE, then the text becomes "Finish". If show_finish is FALSE, then the text becomes "Cancel".
Class GTK2.Gnome2DruidPage
- Description
This widget is a virtual widget to define the interface to a druid page. It's descendants are placed in a W(Gnome2.Druid) widget.
Signals: back
cancel
finish
next
prepare
- Methodnext
intnext()- Description
This will emit the "next" signal for that particular page. It is called by gnome-druid exclusviely. It is expected that non-linear Druid's will override this signal and return true if it handles changing pages.
Class GTK2.Gnome2DruidPageEdge
- Methodcreate
GTK2.Gnome2DruidPageEdgeGTK2.Gnome2DruidPageEdge(intposition,int|voidanti_alias)- Description
Create a new Gnome2.DruidPageEdge, with optional anti-aliasing.
- Methodset_bg_color
Gnome2.DruidPageEdgeset_bg_color(GTK2.GdkColorcolor)- Description
This will set the background color.
- Methodset_logo
Gnome2.DruidPageEdgeset_logo(GTK2.GdkPixbuflogo)- Description
Sets a GDK2.Pixbuf as the logo in the top right corner. If omitted, then no logo will be displayed.
- Methodset_logo_bg_color
Gnome2.DruidPageEdgeset_logo_bg_color(GTK2.GdkColorcolor)- Description
Sets the color behind the druid page's logo.
- Methodset_text
Gnome2.DruidPageEdgeset_text(sprintf_formattext,sprintf_args...fmt)- Description
Sets the contents of the text portion.
- Methodset_text_color
Gnome2.DruidPageEdgeset_text_color(GTK2.GdkColorcolor)- Description
Sets the color of the text in the body of the page.
- Methodset_textbox_color
Gnome2.DruidPageEdgeset_textbox_color(GTK2.GdkColorcolor)- Description
Sets the color of the background in the main text area of the page.
- Methodset_title
Gnome2.DruidPageEdgeset_title(stringtitle)- Description
Sets the contents of the page's title text.
- Methodset_title_color
Gnome2.DruidPageEdgeset_title_color(GTK2.GdkColorcolor)- Description
Sets the color of the title text.
- Methodset_top_watermark
Gnome2.DruidPageEdgeset_top_watermark(GTK2.GdkPixbufwatermark)- Description
Sets a GDK2.Pixbuf as the watermark on top of the top strip on the druid. If watermark is omitted, it is reset to the normal color.
- Methodcreate
Class GTK2.Gnome2DruidPageStandard
- Description
Properties: string background GDK2.Color background-gdk int background-set string contents-background GDK2.Color contents-background-gdk int contents-background-set GDK2.Pixbuf logo string logo-background GDK2.Color logo-background-gdk int logo-background-set string title string title-foreground GDK2.Color title-foreground-gdk int title-foreground-set GDK2.Pixbuf top-watermark
- Methodappend_item
Gnome2.DruidPageStandardappend_item(stringquestion,GTK2.Widgetitem,stringadditional_info)- Description
Convenience function to add a GTK2.Widget to the vbox. This function creates a new contents section that has the question text followed by the item widget and then the additional_info text, all stacked vertically from top to bottom.
The item widget could be something like a set of radio checkbuttons requesting a choice from the user.
- Methodcreate
GTK2.Gnome2DruidPageStandardGTK2.Gnome2DruidPageStandard(string|voidtitle,GTK2.GdkPixbuflogo,GTK2.GdkPixbuftop_watermark)- Description
Construct a new Gnome2.DruidPageStandard.
- Methodset_background
Gnome2.DruidPageStandardset_background(GTK2.GdkColorcolor)- Description
Sets the background color of the top section.
- Methodset_contents_background
Gnome2.DruidPageStandardset_contents_background(GTK2.GdkColorcolor)- Description
Sets the color of the main contents section's background.
- Methodset_logo
Gnome2.DruidPageStandardset_logo(GTK2.GdkPixbuflogo)- Description
Sets a GDK2.Pixbuf as the logo in the top right corner. If omitted, then no logo will be displayed.
- Methodset_logo_background
Gnome2.DruidPageStandardset_logo_background(GTK2.GdkColorcolor)- Description
Sets the background color of the logo.
- Methodset_title_foreground
Gnome2.DruidPageStandardset_title_foreground(GTK2.GdkColorcolor)- Description
Sets the title text to the specified color.
Class GTK2.Gnome2Href
- Description
This widget is a GtkButton button that contains a URL. When clicked it invokes the configured browser for the URL you provided.
GTK2.Gnome2Href( "http://www.gnome.org", "GNOME Web Site" )
GTK2.Gnome2Href( "http://www.gnome.org" )
Properties: string text string url
Style properties: GDK.Color link-color
- Methodcreate
GTK2.Gnome2HrefGTK2.Gnome2Href(stringurl,string|voidlabel)- Description
Created a GNOME href object, a label widget with a clickable action and an associated URL. If label is set to 0, url is used as the label.
- Methodget_text
stringget_text()- Description
Returns the contents of the label widget used to display the link text.
- Methodset_text
Gnome2.Hrefset_text(sprintf_formattext,sprintf_args...fmt)- Description
Sets the internal label widget text (used to display a URL's link text) to the given value.
Class GTK2.Gnome2IconEntry
- Description
This widget provides the facilities to select an icon. An icon is displayed inside a button, when the button is pressed, an Icon selector (a dialog with a W(GnomeIconSelection) widget) pops up to let the user choose an icon. It also allows one to Drag and Drop the images to and from the preview button. Properties: string browse-dialog-title string filename string history-id GTK2.Dialog pick-dialog string pixmap-subdir
Signals: browse
changed
- Methodcreate
GTK2.Gnome2IconEntryGTK2.Gnome2IconEntry(stringhistory_id,stringtitle)- Description
Creates a new icon entry widget
- Methodget_filename
stringget_filename()- Description
Gets the file name of the image if it was possible to load it into the preview. That is, it will only return a filename if the image exists and it was possible to load it as an image.
- Methodpick_dialog
GTK2.Widgetpick_dialog()- Description
If a pick dialog exists, returns it. This is if you need to do something with all dialogs. You would use the browse signal with connect_after to get the pick dialog when it is displayed.
- Methodset_browse_dialog_title
Gnome2.IconEntryset_browse_dialog_title(stringtitle)- Description
Set the title of the browse dialog.
- Methodset_filename
intset_filename(stringfilename)- Description
Sets the icon of Gnome2.IconEntry to be the one pointed to by filename.
- Methodset_history_id
Gnome2.IconEntryset_history_id(stringhistory_id)- Description
Set the history_id of the entry in the browse dialog and reload the history.
Class GTK2.Gnome2IconSelection
- Description
An icon listing/chooser display.
- Methodadd_defaults
Gnome2.IconSelectionadd_defaults()- Description
Adds the default pixmap directory into the selection widget.
- Methodadd_directory
Gnome2.IconSelectionadd_directory(stringdir)- Description
Adds the icons from the directory dir to the selection widget.
- Methodclear
Gnome2.IconSelectionclear(int|voidnot_shown)- Description
Clear the currently shown icons, the ones that weren't shown yet are not cleared unless the not_shown parameter is given, in which case even those are cleared.
- Methodcreate
GTK2.Gnome2IconSelectionGTK2.Gnome2IconSelection()- Description
Creates a new icon selection widget, it uses a W(GnomeIconList) for the listing of icons
- Methodget_icon
stringget_icon(intfull_path)- Description
Gets the currently selected icon name, if full_path is true, it returns the full path to the icon, if none is selected it returns 0.
- Methodadd_builtin_icon