17. 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
- Method
add_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.
- Method
flush
voidflush()- Description
Flush GDK. Not normally needed, can be useful while doing calculations.
- Method
get_default_icon_list
arrayget_default_icon_list()- Description
Gets the value set by set_default_icon_list().
- Method
get_file_info
mappingget_file_info(stringfilename)- Description
Parses an image file far enough to determine its format and size.
- Method
gnome_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)
- Method
gtk_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).
- Method
list_toplevels
arraylist_toplevels()- Description
Returns a list of all existing toplevel windows.
- Method
main
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.
- Method
main_iteration_do
intmain_iteration_do(intblock)- Description
Run one iteration in the mainloop. If block is true, wait for an event before returning.
- Method
move_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.
- Method
move_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.
- Method
root_window
GTK2.GdkWindowroot_window()- Description
Returns the root window of the current display
- Method
saver_disable
voidsaver_disable()- Description
Disable the screensaver. This is a low-level X11 function, and thus only works when GDK uses X11
- Method
saver_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.
- Method
set_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.
- Method
set_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.
- Method
set_default_icon_from_file
voidset_default_icon_from_file(stringfilename)- Description
Sets an icon to be used as fallback from a file on disk.
- Method
set_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.
- Method
set_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.
- Method
setup_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
- Method
create
GTK2.AboutDialogGTK2.AboutDialog(mapping|voidprops)- Description
Create a new GTK2.AboutDialog.
- Method
get_artists
arrayget_artists()- Description
Returns the strings which are displayed in the artists tab of the secondary credits dialog.
- Method
get_authors
arrayget_authors()- Description
Returns the strings which are displayed in the authors tab of the secondary credits dialog.
- Method
get_documenters
arrayget_documenters()- Description
Returns the strings which are displayed in the documenters tab of the secondary credits dialog.
- Method
get_translator_credits
stringget_translator_credits()- Description
Returns the translator credis.
- Method
get_website_label
stringget_website_label()- Description
Returns the label used for the website link.
- Method
get_wrap_license
intget_wrap_license()- Description
Returns whether the license text is automatically wrapped.
- Method
set_artists
GTK2.AboutDialogset_artists(arrayart)- Description
Sets the strings which are displayed in the artists tab of the secondary credits dialog.
- Method
set_authors
GTK2.AboutDialogset_authors(arrayauth)- Description
Sets the strings which are displayed in the authors tab of the secondary credits dialog.
- Method
set_copyright
GTK2.AboutDialogset_copyright(stringcopyright)- Description
Sets the copyright string.
- Method
set_documenters
GTK2.AboutDialogset_documenters(arraydoc)- Description
Sets the strings which are displayed in the documenters tab of the secondary credits dialog.
- Method
set_license
GTK2.AboutDialogset_license(stringlicense)- Description
Sets the license information.
- Method
set_logo
GTK2.AboutDialogset_logo(GTK2.GdkPixbuflogo)- Description
Sets the pixbuf to be displayed as the logo.
- Method
set_logo_icon_name
GTK2.AboutDialogset_logo_icon_name(stringname)- Description
Sets the icon name.
- Method
set_program_name
GTK2.AboutDialogset_program_name(stringname)- Description
Sets the name to display in the dialog.
- Method
set_translator_credits
GTK2.AboutDialogset_translator_credits(stringcredits)- Description
Sets the translator credits.
- Method
set_website
GTK2.AboutDialogset_website(stringwebsite)- Description
Sets the URL to use for the website link.
- Method
set_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
- Method
connect
GTK2.AccelGroupconnect(intaccel_key,intaccel_mods,intaccel_flags,function(:void)cb,mixeduser_data)- Description
Installs an accelerator in this group.
- Method
connect_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.
- Method
disconnect
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
- Method
create
GTK2.AccelLabelGTK2.AccelLabel(string|mappingtext_or_props)- Description
Creates a new W(AccelLabel).
- Method
get_accel_widget
GTK2.Widgetget_accel_widget()- Description
Fetches the widget monitored by this accelerator label.
- Method
get_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).
- Method
refetch
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
- Method
activate
GTK2.Actionactivate()- Description
Emits the "activate" signal, if it isn't insensitive.
- Method
block_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.
- Method
connect_accelerator
GTK2.Actionconnect_accelerator()- Description
Installs the accelerator if this action widget has an accel path and group.
- Method
connect_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.
- Method
create
GTK2.ActionGTK2.Action(string|mappingname_or_props,string|voidlabel,string|voidtooltip,string|voidstock_id)- Description
Creates a new object.
- Method
create_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.
- Method
create_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.
- Method
create_menu_item
GTK2.Widgetcreate_menu_item()- Description
Creates a menu item widget that proxies for the action.
- Method
create_tool_item
GTK2.Widgetcreate_tool_item()- Description
Creates a toolbar item widget that proxies for the action.
- Method
disconnect_accelerator
GTK2.Actiondisconnect_accelerator()- Description
Undoes the effect of one call to connect_accelerator().
- Method
disconnect_proxy
GTK2.Actiondisconnect_proxy(GTK2.Widgetproxy)- Description
Disconnects a proxy widget. Does not destroy the widget.
- Method
get_sensitive
intget_sensitive()- Description
Returns whether the action itself is sensitive. Note that this doesn't necessarily mean effective sensitivity.
- Method
set_accel_group
GTK2.Actionset_accel_group(GTK2.AccelGroupgroup)- Description
Sets the GTK2.AccelGroup in which the accelerator for this action will be installed.
- Method
set_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
- Method
add_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.
- Method
add_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 ]);
- Method
add_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 ]);
- Method
add_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 ]);
- Method
create
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.
- Method
get_action
GTK2.Actionget_action(stringname)- Description
Looks up an action in the action group by name.
- Method
get_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.
- Method
get_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.
- Method
remove_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
- Method
get_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.
- Method
set_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
- Method
clamp_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.
- Method
create
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.
- Method
set_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
- Method
create
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.
- Method
set
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
- Method
create
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
- Method
create
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'.
- Method
set
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.
- Method
add_action_widget
GTK2.Assistantadd_action_widget(GTK2.Widgetchild)- Description
Adds a widget to the action area.
- Method
get_current_page
intget_current_page()- Description
Returns the page number of the current page. Returns -1 if there are no pages.
- Method
get_nth_page
GTK2.Widgetget_nth_page(intpage_num)- Description
Returnss the child widget contained in page number page_num.
- Method
get_page_complete
intget_page_complete(GTK2.Widgetpage)- Description
Gets whether page is complete.
- Method
get_page_header_image
GTK2.GdkPixbufget_page_header_image(GTK2.Widgetpage)- Description
Gets the header image for page.
- Method
get_page_side_image
GTK2.GdkPixbufget_page_side_image(GTK2.Widgetpage)- Description
Gets the side image for page.
- Method
insert_page
intinsert_page(GTK2.Widgetpage,intpos)- Description
Inserts a page at a given position. If pos equals -1 it will append the page.
- Method
remove_action_widget
GTK2.Assistantremove_action_widget(GTK2.Widgetchild)- Description
Removes a widget from the action area.
- Method
set_current_page
GTK2.Assistantset_current_page(intpage_num)- Description
Switches the page to page_num.
- Method
set_forward_page_func
GTK2.Assistantset_forward_page_func(function(:void)f,mixeddata)- Description
Set the forward page function.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_page_type
GTK2.Assistantset_page_type(GTK2.Widgetpage,inttype)- Description
Sets the page type for page. The page type determines the page behavior.
- Method
update_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
- Method
pack_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
- Method
pack_end_defaults
GTK2.Boxpack_end_defaults(GTK2.Widgetwidget)- Description
The argument is the widget to add.
- Method
pack_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'
- Method
pack_start_defaults
GTK2.Boxpack_start_defaults(GTK2.Widgetwidget)- Description
The argument is the widget to add. This function is equivalent to 'add'
- Method
query_child_packing
mappingquery_child_packing(GTK2.Widgetchild)- Description
Return a mapping: ([ "expand":expandp, "fill":fillp, "padding":paddingp, "type":type ])
- Method
reorder_child
GTK2.Boxreorder_child(GTK2.Widgetchild,intnew_position)- Description
Move widget to pos, pos is an integer, between 0 and sizeof(box->children())-1
- Method
set_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.
- Method
set_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
- Method
create
GTK2.ButtonGTK2.Button(string|mappinglabel_or_props)- Description
If a string is supplied, a W(Label) is created and added to the button.
- Method
get_focus_on_click
intget_focus_on_click()- Description
Returns whether the button grabs focus when it is clicked.
- Method
get_image
GTK2.Widgetget_image()- Description
Gets the widget that is currently set as the image of the button.
- Method
get_image_position
intget_image_position()- Description
Gets the position of the image relative to the text inside the button.
- Method
get_relief
intget_relief()- Description
One of
RELIEF_HALF,RELIEF_NONEandRELIEF_NORMAL, set with set_relief()
- Method
get_use_underline
intget_use_underline()- Description
Returns whether an embedded underline in the button indicates a mnemonic.
- Method
set_alignment
GTK2.Buttonset_alignment(floatxalign,floatyalign)- Description
Sets the alignment of the child.
- Method
set_focus_on_click
GTK2.Buttonset_focus_on_click(intfocus_on_click)- Description
Sets whether the button will grab focus when it is clicked.
- Method
set_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.
- Method
set_image_position
GTK2.Buttonset_image_position(intposition)- Description
Sets the position of the image relative to the text inside the button.
- Method
set_relief
GTK2.Buttonset_relief(intnewstyle)- Description
One of
RELIEF_HALF,RELIEF_NONEandRELIEF_NORMAL
- Method
set_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
- Method
get_child_secondary
intget_child_secondary(GTK2.Widgetchild)- Description
Returns whether child should appear in a secondary group of children.
- Method
get_layout
intget_layout()- Description
Returns the currently configured layout. One of
BUTTONBOX_DEFAULT_STYLE,BUTTONBOX_EDGE,BUTTONBOX_END,BUTTONBOX_SPREADandBUTTONBOX_START
- Method
set_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
- Method
get_date
mappingget_date()- Description
returns a mapping: ([ "year":year, "month":month, "day":day ])
- Method
get_marked_dates
arrayget_marked_dates()- Description
Returns an array (with 31 elements) with 1es and 0es.
- Method
select_day
GTK2.Calendarselect_day(intday_of_month)- Description
Select a certain day of the currently selected month
- Method
set_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
- Method
editing_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.
- Method
remove_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.
- Method
add_attribute
GTK2.CellLayoutadd_attribute(GTK2.CellRenderercell,stringattribute,intcolumn)- Description
Adds an attribute mapping.
- Method
clear
GTK2.CellLayoutclear()- Description
Unsets all the mappings on all renderers and removes all renderers.
- Method
clear_attributes
GTK2.CellLayoutclear_attributes(GTK2.CellRenderercell)- Description
Clears all existing attributes.
- Method
pack_end
GTK2.CellLayoutpack_end(GTK2.CellRenderercell,intexpand)- Description
See pack_start().
- Method
pack_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.
- Method
reorder
GTK2.CellLayoutreorder(GTK2.CellRenderercell,intposition)- Description
Re-inserts cell at position.
- Method
set_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
- Method
activate
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.
- Method
get_fixed_size
mappingget_fixed_size()- Description
Fills in width and height with the appropriate size of the cell.
- Method
get_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.
- Method
render
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.
- Method
set_fixed_size
GTK2.CellRendererset_fixed_size(intwidth,intheight)- Description
Sets the renderer size to be explicit, independent of the properties set.
- Method
start_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.
- Method
stop_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
- Method
create
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
- Method
create
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).
- Method
set_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
- Method
create
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().
- Method
get_radio
intget_radio()- Description
Returns whether we're rendering radio toggles rather than checkboxes.
- Method
set_active
GTK2.CellRendererToggleset_active(intsetting)- Description
Activates or deactivates a cell renderer.
- Method
set_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
- Method
create
GTK2.CellViewGTK2.CellView(string|GdkPixbuf|mappingtext,int|voidmarkup)- Description
Create a new W(CellView) widget.
- Method
get_cell_renderers
arrayget_cell_renderers()- Description
Returns the cell renderers which have been added to this view.
- Method
get_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.
- Method
get_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.
- Method
set_background_color
GTK2.CellViewset_background_color(GTK2.GdkColorcolor)- Description
Sets the background color.
- Method
set_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
- Method
create
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)
- Method
get_draw_as_radio
intget_draw_as_radio()- Description
Get whether check menu item is drawn like a radio button.
- Method
get_inconsistent
intget_inconsistent()- Description
Retrieves the value set by set_inconsistent().
- Method
set_active
GTK2.CheckMenuItemset_active(intnew_state)- Description
State is either 1 or 0. If 1, the button will be 'pressed'.
- Method
set_draw_as_radio
GTK2.CheckMenuItemset_draw_as_radio(intdraw_as_radio)- Description
Set whether check menu item is drawn like a radio button.
- Method
set_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.
- Method
get
GTK2.Clipboardget(GDK2.Atomselection)- Description
Returns the clipboard object for the given selection.
- Method
get_display
GTK2.GdkDisplayget_display()- Description
Gets the GDK2.Display associated with this clipboard.
- Method
get_for_display
GTK2.Clipboardget_for_display(GTK2.GdkDisplaydisplay,GDK2.Atomselection)- Description
Returns the clipboard object for the given selection.
- Method
set_image
GTK2.Clipboardset_image(GTK2.GdkPixbufpixbuf)- Description
Sets the contents of the clipboard to the given GDK2(Pixbuf).
- Method
set_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.
- Method
wait_for_image
GTK2.GdkPixbufwait_for_image()- Description
Requests the contents of the clipboard as image and converts the result to a GDK2.Pixbuf.
- Method
wait_for_rich_text
stringwait_for_rich_text(GTK2.TextBufferbuffer)- Description
Requests the contents of the clipboard as rich text.
- Method
wait_is_image_available
intwait_is_image_available()- Description
Test to see if tehre is an image available to be pasted.
- Method
wait_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.
- Method
create
GTK2.ColorButtonGTK2.ColorButton(GTK2.GdkColorred_or_props,int|voidgreen,int|voidblue)- Description
Create a new W(ColorButton).
- Method
get_use_alpha
intget_use_alpha()- Description
Gets whether the color button uses the alpha channel.
- Method
set_color
GTK2.ColorButtonset_color(int|GdkColorred,int|voidgreen,int|voidblue)- Description
Sets the current color.
- Method
set_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
- Method
create
GTK2.ColorSelectionGTK2.ColorSelection(mapping|voidprops)- Description
Create a new color selection.
- Method
get_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.
- Method
get_has_opacity_control
intget_has_opacity_control()- Description
Determines whether the colorsel has an opacity control.
- Method
get_has_palette
intget_has_palette()- Description
Determines whether the color selector has a color palette.
- Method
set_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.
- Method
set_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
- Method
set_has_opacity_control
GTK2.ColorSelectionset_has_opacity_control(intsetting)- Description
Sets whether or not to use opacity.
- Method
set_has_palette
GTK2.ColorSelectionset_has_palette(inthas_palette)- Description
Shows and hides the palette based upon the value of has_palette
- Method
set_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
- Method
create
GTK2.ColorSelectionDialogGTK2.ColorSelectionDialog(string|mappingtitle_or_props)- Description
Create a new Color Selection Dialog
- Method
get_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
- Method
append_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").
- Method
create
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().
- Method
get_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.
- Method
get_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").
- Method
get_add_tearoffs
intget_add_tearoffs()- Description
Gets whether the popup menu has tearoff items.
- Method
get_column_span_column
intget_column_span_column()- Description
Returns the column with column span information.
- Method
get_focus_on_click
intget_focus_on_click()- Description
Returns whether the combo box grabs focus when it is clicked with the mouse.
- Method
get_model
GTK2.TreeModelget_model()- Description
Get the GTK2.TreeModel which is acting as a data source.
- Method
get_row_span_column
intget_row_span_column()- Description
Returns the column with row span information.
- Method
get_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.
- Method
insert_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").
- Method
prepend_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").
- Method
remove_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").
- Method
set_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.
- Method
set_add_tearoffs
GTK2.ComboBoxset_add_tearoffs(intsetting)- Description
Sets whether the popup menu should have a tearoff menu item.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_title
GTK2.ComboBoxset_title(stringtitle)- Description
Sets the menu's title in tearoff mode.
Class GTK2.ComboBoxEntry
- Description
Properties: int text-column
- Method
create
GTK2.ComboBoxEntryGTK2.ComboBoxEntry(string|TreeModel|mappingmodel,int|voidtext_column)- Description
Create a new ComboBoxEntry, either empty or with a model.
- Method
get_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
- Method
add
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.
- Method
get_children
arrayget_children()- Description
This function returns all children of the container as an array.
- Method
get_focus_hadjustment
GTK2.Adjustmentget_focus_hadjustment()- Description
Retrieves the horizontal focus adjustment.
- Method
get_focus_vadjustment
GTK2.Adjustmentget_focus_vadjustment()- Description
Retrieves the vertical focus adjustment.
- Method
remove
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.
- Method
set_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.
- Method
set_focus_child
GTK2.Containerset_focus_child(GTK2.Widgetchild)- Description
Emulate a set_focus_child signal. Focus on the specified child.
- Method
set_focus_hadjustment
GTK2.Containerset_focus_hadjustment(GTK2.Adjustmentadj)- Description
Set the hadjustment used to focus children.
- Method
set_focus_vadjustment
GTK2.Containerset_focus_vadjustment(GTK2.Adjustmentadj)- Description
Set the vadjustment used to focus children.
- Method
set_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
- Method
data_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
- Method
data_get_value
mappingdata_get_value(intx,inty)- Description
Get the value at the given coordinates.
- Method
data_get_visible_extrema
arraydata_get_visible_extrema()- Description
Get the positions of the edges of the display.
- Method
data_set_color
intdata_set_color(intindex,GTK2.GdkColorcolor)- Description
Set the color at index.
- Method
data_set_grid_config
intdata_set_grid_config(intindex,inthlines,intvlines)- Description
Not useful unless the data type is GTK2.DATABOX_GRID.
- Method
data_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
- Method
get_rulers_enable
GTK2.Databoxget_rulers_enable()- Description
Get whether rulers will be displayed.
- Method
get_scrollbars_enable
GTK2.Databoxget_scrollbars_enable()- Description
Get whether scrollbars will be displayed.
- Method
get_selection_fill_enable
intget_selection_fill_enable()- Description
Get whether the selection will be filled.
- Method
rescale_inverted
GTK2.Databoxrescale_inverted(intinvertX,intinvertY)- Description
Rescale with an inverted x and/or y direction.
- Method
rescale_with_values
GTK2.Databoxrescale_with_values(floatminx,floatminy,floatmaxx,floatmaxy)- Description
Rescale with specific data extrema.
- Method
set_background_color
GTK2.Databoxset_background_color(GTK2.GdkColorcolor)- Description
Set the background color.
- Method
set_rulers_enable
GTK2.Databoxset_rulers_enable(intsetting)- Description
Set whether rulers will be displayed.
- Method
set_scrollbars_enable
GTK2.Databoxset_scrollbars_enable(intsetting)- Description
Set whether scrollbars will be displayed.
- Method
set_selection_enable
GTK2.Databoxset_selection_enable(intsetting)- Description
Set whether selection is enabled.
- Method
set_selection_fill_enable
GTK2.Databoxset_selection_fill_enable(intsetting)- Description
Set whether the selection will be filled.
- Method
set_zoom_enable
GTK2.Databoxset_zoom_enable(intsetting)- Description
Set whether zoom is enabled.
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
- Method
add_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.
- Method
add_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.
- Method
get_action_area
GTK2.HbuttonBoxget_action_area()- Description
The action area, this is where the buttons (ok, cancel etc) go
- Method
get_has_separator
intget_has_separator()- Description
Accessor for whether the dialog has a separator.
- Method
get_response_for_widget
intget_response_for_widget(GTK2.Widgetwidget)- Description
Gets the response id of a widget in the action area.
- Method
get_vbox
GTK2.Vboxget_vbox()- Description
The vertical box that should contain the contents of the dialog
- Method
response
GTK2.Dialogresponse(intresponse_id)- Description
Emits the "response" signal with the given response ID.
- Method
set_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.
- Method
set_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)
- Method
clear
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.
- Method
copy_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.
- Method
create
GTK2.DrawingAreaGTK2.DrawingArea(mapping|voidprops)- Description
Create a new drawing area.
- Method
draw_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.
- Method
draw_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
- Method
draw_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
- Method
draw_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
- Method
draw_pixbuf
GTK2.DrawingAreadraw_pixbuf(GTK2.GdkGCgc,GTK2.GdkPixbufpixbuf,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw a GDK2(Pixbuf) in this drawable.
- Method
draw_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
- Method
draw_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
- Method
draw_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
- Method
draw_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
- Method
copy_clipboard
GTK2.Editablecopy_clipboard()- Description
Causes the characters in the current selection to be copied to the clipboard.
- Method
cut_clipboard
GTK2.Editablecut_clipboard()- Description
Causes the characters in the current selection to be copied to the clipboard and then deleted.
- Method
delete_selection
GTK2.Editabledelete_selection()- Description
Deletes the current contents of the selection.
- Method
delete_text
GTK2.Editabledelete_text(intstart,intend)- Description
Deletes a sequence of characters.
- Method
insert_text
intinsert_text(stringtext,intlength,intpos)- Description
Inserts text at a given position. Returns the position after the new text.
- Method
paste_clipboard
GTK2.Editablepaste_clipboard()- Description
Causes the contents of the clipboard to be pasted into the given widget at the current cursor position.
- Method
select_region
GTK2.Editableselect_region(intstart,intend)- Description
Selects a region of text.
- Method
set_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
- Method
create
GTK2.EntryGTK2.Entry(int|mappingmaxlen_or_props)- Description
Create a new W(Entry) widget.
- Method
get_activates_default
intget_activates_default()- Description
Retrieves the value set by set_activates_default().
- Method
get_cursor_hadjustment
GTK2.Adjustmentget_cursor_hadjustment()- Description
Retrieves the horizontal cursor adjustment
- Method
get_inner_border
arrayget_inner_border()- Description
This function returns the entry's inner-border property.
- Method
get_invisible_char
intget_invisible_char()- Description
Retrieves the character displayed in place of the real characters for entries with visibility set to false.
- Method
get_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.
- Method
get_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.
- Method
get_max_length
intget_max_length()- Description
Retrieves the maximum allowed length of the text.
- Method
layout_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().
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_has_frame
GTK2.Entryset_has_frame(intsetting)- Description
Sets whether the entry has a beveled frame around it.
- Method
set_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.
- Method
set_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().
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_text
GTK2.Entryset_text(sprintf_formattext,sprintf_args...fmt)- Description
Set the text to the specified string, replacing the current contents.
- Method
set_visibility
GTK2.Entryset_visibility(intvisiblep)- Description
0 indicates invisible text (password boxes, as an example)
- Method
set_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
- Method
complete
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.
- Method
create
GTK2.EntryCompletionGTK2.EntryCompletion(mapping|voidprops)- Description
Creates a new widget.
- Method
delete_action
GTK2.EntryCompletiondelete_action(intindex)- Description
Deletes the action at index.
- Method
get_inline_completion
intget_inline_completion()- Description
Returns whether the common prefix of the possible completions should be automatically inserted in the entry.
- Method
get_model
GTK2.TreeModelget_model()- Description
Returns the model being used as the data source.
- Method
get_popup_completion
intget_popup_completion()- Description
Returns whether completions should be presented in a popup window.
- Method
get_popup_set_width
intget_popup_set_width()- Description
Returns whether the completion popup window will be resized to the width of the entry.
- Method
get_popup_single_match
intget_popup_single_match()- Description
Returns whether the completion popup window will appear even if there is only a single match.
- Method
get_text_column
intget_text_column()- Description
Returns the column in the model to get strings from.
- Method
insert_action_markup
GTK2.EntryCompletioninsert_action_markup(intindex,stringmarkup)- Description
Inserts an action in the action item list at position index with the specified markup.
- Method
insert_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().
- Method
set_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.
- Method
set_inline_selection
GTK2.EntryCompletionset_inline_selection(intinline_selection)- Description
Sets whether it is possible to cycle through the possible completions inside the entry.
- Method
set_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.
- Method
set_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).
- Method
set_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.
- Method
set_popup_completion
GTK2.EntryCompletionset_popup_completion(intsetting)- Description
Sets whether the completions should be presented in a popup window.
- Method
set_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.
- Method
set_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.
- Method
set_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
- Method
get_above_child
intget_above_child()- Description
Returns whether the event box window is above or below the windows of its child.
- Method
get_visible_window
intget_visible_window()- Description
Returns whether the event box has a visible window.
- Method
set_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
- Method
create
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.
- Method
get_label_widget
GTK2.Widgetget_label_widget()- Description
Retrieves the label widget for the frame.
- Method
get_use_markup
intget_use_markup()- Description
Returns whether the label's text is interpreted as marked up with the Pango text markup language.
- Method
get_use_underline
intget_use_underline()- Description
Returns whether an embedded underline in the label indicates a mnemonic.
- Method
set_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.
- Method
set_label
GTK2.Expanderset_label(stringlabel)- Description
Sets the text of the label of the expander.
- Method
set_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.
- Method
set_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.
- Method
set_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
- Method
add_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.
- Method
add_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.
- Method
add_shortcut_folder_uri
intadd_shortcut_folder_uri(stringuri)- Description
Adds a folder URI to be displayed with the shortcut folders.
- Method
get_current_folder
stringget_current_folder()- Description
Gets the current folder as a local filename.
- Method
get_current_folder_uri
stringget_current_folder_uri()- Description
Gets the current folder as a URI.
- Method
get_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.
- Method
get_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.
- Method
get_local_only
intget_local_only()- Description
Gets whether only local files can be selected in the file selector.
- Method
get_preview_filename
stringget_preview_filename()- Description
Gets the filename that should be previewed in a custom preview widget.
- Method
get_preview_uri
stringget_preview_uri()- Description
Gets the URI that should be previewed in a custom preview widget.
- Method
get_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.
- Method
get_select_multiple
intget_select_multiple()- Description
Gets whether multiple files can be selected.
- Method
get_show_hidden
intget_show_hidden()- Description
Gets whether hidden files and folders are displayed.
- Method
get_uris
arrayget_uris()- Description
List all the selected files and subfolders in the current folder. The returned names are full absolute URIs.
- Method
get_use_preview_label
intget_use_preview_label()- Description
Gets whether a stock label should be drawn with the name of the previewed file.
- Method
list_shortcut_folder_uris
arraylist_shortcut_folder_uris()- Description
Queries the list of shortcut folders.
- Method
list_shortcut_folders
arraylist_shortcut_folders()- Description
Queries the list of shortcut folders.
- Method
remove_filter
GTK2.FileChooserremove_filter(GTK2.FileFilterfilter)- Description
Removes filter from the list of filters that the user can select between.
- Method
remove_shortcut_folder
GTK2.FileChooserremove_shortcut_folder(stringfolder)- Description
Removes a folder from the list of shortcut folders.
- Method
remove_shortcut_folder_uri
GTK2.FileChooserremove_shortcut_folder_uri(stringuri)- Description
Removes a folder URI.
- Method
set_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
- Method
set_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.
- Method
set_current_folder_uri
intset_current_folder_uri(stringuri)- Description
Sets the current folder from a URI.
- Method
set_current_name
GTK2.FileChooserset_current_name(stringfilename)- Description
Sets current name.
- Method
set_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.
- Method
set_extra_widget
GTK2.FileChooserset_extra_widget(GTK2.Widgetwidget)- Description
Sets an application-supplied widget to provide extra options to the user.
- Method
set_filename
intset_filename(stringfilename)- Description
Sets filename as the current filename. Same as unselect_all() followed by select_filename();
- Method
set_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.
- Method
set_local_only
GTK2.FileChooserset_local_only(intlocal_only)- Description
Sets whether on local files can be selected.
- Method
set_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.
- Method
set_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.
- Method
set_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
- Method
set_show_hidden
GTK2.FileChooserset_show_hidden(intsetting)- Description
Sets whether hidden files and folders are displayed.
- Method
set_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.
- Method
unselect_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
- Method
create
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
- Method
get_focus_on_click
intget_focus_on_click()- Description
Returns whether the button grabs focus when it is clicked.
- Method
get_width_chars
intget_width_chars()- Description
Retrieves the width in characters of the button widget's entry and/or label.
- Method
set_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.
- Method
set_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])}))
- Method
create
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.
- Method
add_mime_type
GTK2.FileFilteradd_mime_type(stringmime_type)- Description
Adds a rule allowing a given mime type.
- Method
add_pattern
GTK2.FileFilteradd_pattern(stringpattern)- Description
Adds a rule allowing a shell style glob.
- Method
add_pixbuf_formats
GTK2.FileFilteradd_pixbuf_formats()- Description
Adds a rule allowing image files in the formats support by W(Pixbuf).
- Method
create
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
- Method
complete
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.
- Method
create
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.
- Method
get_fileop_c_dir
GTK2.Buttonget_fileop_c_dir()- Description
The create directory button in the file operation button group
- Method
get_fileop_del_file
GTK2.Buttonget_fileop_del_file()- Description
The delete file button in the file operation button group
- Method
get_fileop_ren_file
GTK2.Buttonget_fileop_ren_file()- Description
The rename file button in the file operation button group
- Method
get_select_multiple
intget_select_multiple()- Description
Gets whether the user is allowed to select multiple files.
- Method
get_selection
arrayget_selection()- Description
Retrieves the list of selections the user has made.
- Method
hide_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.
- Method
set_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.
- Method
set_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
- Method
get_children
arrayget_children()- Description
Get a list of the children and their x,y positions.
- Method
move
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
- Method
create
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.
- Method
get_font_name
stringget_font_name()- Description
Retrieves the name of the currently selected font.
- Method
get_show_size
intget_show_size()- Description
Returns whether the font size will be shown in the label.
- Method
get_show_style
intget_show_style()- Description
Returns whether the name of the font style will be shown in the label.
- Method
get_use_font
intget_use_font()- Description
Returns whether the selected font is used in the label.
- Method
get_use_size
intget_use_size()- Description
Returns whether the selected size is used in the label.
- Method
set_font_name
intset_font_name(stringfont)- Description
Sets or updates the currently-displayed font.
- Method
set_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.
- Method
set_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.
- Method
set_title
GTK2.FontButtonset_title(stringtitle)- Description
Sets the title for the font selection dialog.
- Method
set_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
- Method
create
GTK2.FontSelectionGTK2.FontSelection(mapping|voidprops)- Description
Create a new GTK2.FontSelection widget.
- Method
get_preview_text
stringget_preview_text()- Description
Gets the text displayed in the preview area.
- Method
set_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")
- Method
create
GTK2.FontSelectionDialogGTK2.FontSelectionDialog(stringtitle)- Description
Create a new font selection dialog with the specified window title
- Method
get_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
- Method
create
GTK2.FrameGTK2.Frame(string|mappinglabel_or_props)- Description
Create a new W(Frame) widget.
- Method
get_label_align
arrayget_label_align()- Description
Retrieves the x and y alignment of the label.
- Method
set_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.
- Method
set_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
- Method
create
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.
- Method
create
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.
- Method
image_color_object
Image.Color.Colorimage_color_object()- Description
Return a Image.Color.Color instance. This gives better precision than the rgb function.
- Method
pixel
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.
- Method
alloc_color
intalloc_color(GTK2.GdkColorcolor,intwriteable,intbest_match)- Description
Alocates a single color from a colormap.
- Method
alloc_colors
intalloc_colors(arraycolors,intwriteable,intbest_match)- Description
Allocates colors from a colormap.
- Method
create
GTK2.GdkColormapGTK2.GdkColormap(GTK2.GdkVisualvisual,int|voidallocate,int|voidsystem)- Description
Creates a new colormap.
- Method
query_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
- Method
close
GDK2.Displayclose()- Description
Closes the connection to the window system for the given display, and cleans up associated resources.
- Method
flush
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.
- Method
get_default_cursor_size
intget_default_cursor_size()- Description
Returns the default size to use for cursors.
- Method
get_default_group
GTK2.GdkWindowget_default_group()- Description
Returns the default group leader window for all toplevel windows. This window is implicitly create by GDK.
- Method
get_event
GTK2.GdkEventget_event()- Description
Gets the next GDK2.Event to be processed, fetching events from the windowing system if necessary.
- Method
get_maximal_cursor_size
mappingget_maximal_cursor_size()- Description
Returns the maximal size to use for cursors.
- Method
get_pointer
mappingget_pointer()- Description
Gets the current location of the pointer and the current modifier mask.
- Method
get_screen
GTK2.GdkScreenget_screen(intscreen_num)- Description
Returns a screen for one of the screens.
- Method
get_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).
- Method
peek_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.)
- Method
put_event
GDK2.Displayput_event(GTK2.GdkEventevent)- Description
Appends a copy of the given event onto the front of the event queue.
- Method
request_selection_notification
intrequest_selection_notification(GDK2.Atomselection)- Description
Request GdkEventOwnerChange events for ownership changes of the selection named by the given atom.
- Method
set_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().
- Method
set_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.
- Method
store_clipboard
GDK2.Displaystore_clipboard(GTK2.GdkWindowclipboard_window,arraytargets)- Description
Issues a request to the clipboard manager to store the clipboard data.
- Method
supports_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.
- Method
supports_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).
- Method
supports_cursor_color
intsupports_cursor_color()- Description
Returns true if multicolored cursors are supported. Otherwise, cursors have only a foreground and a background color.
- Method
supports_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.
- Method
supports_selection_notification
intsupports_selection_notification()- Description
Returns whether GdkEventOwnerChange events will be sent when the owner of a selection changes.
- Method
supports_shapes
intsupports_shapes()- Description
Returns true if GDK2.Window->shape_combine_mask() can be used to create shaped windows.
- Method
sync
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.
- Method
warp_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
- Method
drag_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.
- Method
drag_set_icon_default
GDK2.DragContextdrag_set_icon_default()- Description
Use the default drag icon associated with the source widget.
- Method
drag_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.
- Method
drag_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.
- Method
drag_status
GDK2.DragContextdrag_status(intaction)- Description
Setting action to -1 means use the suggested action
- Method
get_action
intget_action()- Description
One of
GDK_ACTION_ASK,GDK_ACTION_COPY,GDK_ACTION_DEFAULT,GDK_ACTION_LINK,GDK_ACTION_MOVEandGDK_ACTION_PRIVATE;
- Method
get_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;
- Method
get_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
- Method
get_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)
- Method
clear
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.
- Method
copy_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.
- Method
draw_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.
- Method
draw_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
- Method
draw_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
- Method
draw_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
- Method
draw_pixbuf
GDK2.Drawabledraw_pixbuf(GTK2.GdkGCgc,GTK2.GdkPixbufpixbuf,intxsrc,intysrc,intxdest,intydest,intwidth,intheight)- Description
Draw a GDK2(Pixbuf) in this drawable.
- Method
draw_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
- Method
draw_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
- Method
draw_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
- Method
draw_text
GDK2.Drawabledraw_text(GTK2.GdkGCgc,intx,inty,string|PangoLayouttext)- Description
y is used as the baseline for the text.
- Method
get_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 ])
- Method
set_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
- Method
create
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.
- Method
get_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.
- Method
set_background
GDK2.GCset_background(GTK2.GdkColorcolor)- Description
Set the background to the specified GDK2.Color.
- Method
set_clip_mask
GDK2.GCset_clip_mask(GTK2.GdkBitmapmask)- Description
Set the clip mask to the specified GDK2.Bitmap
- Method
set_clip_origin
GDK2.GCset_clip_origin(intx,inty)- Description
Set the clip mask origin to the specified point.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_foreground
GDK2.GCset_foreground(GTK2.GdkColorcolor)- Description
Set the foreground to the specified GDK2.Color.
- Method
set_function
GDK2.GCset_function(intfun)- Description
Set the function to the specified one. One of GDK2.Xor, GDK2.Invert and GDK2.Copy.
- Method
set_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.
- Method
set_stipple
GDK2.GCset_stipple(GTK2.GdkBitmapstipple)- Description
Set the background type. Fill must be GDK_STIPPLED or GDK_OPAQUE_STIPPLED.
- Method
set_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.
- Method
set_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
- Method
create
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.
- Method
get_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.
- Method
get_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() )'
- Method
grab
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().
- Method
set
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
- Method
add_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.
- Method
composite
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.
- Method
composite_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.
- Method
composite_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.
- Method
copy_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.
- Method
create
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.
- Method
flip
GTK2.GdkPixbufflip(inthorizontal)- Description
Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf.
- Method
get_bits_per_sample
intget_bits_per_sample()- Description
Queries the number of bits per color sample.
- Method
get_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.
- Method
get_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.
- Method
new_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.
- Method
render_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.
- Method
rotate_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.
- Method
saturate_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.
- Method
save
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.
- Method
scale
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.
- Method
scale_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.
- Method
create
GTK2.GdkPixbufAnimationGTK2.GdkPixbufAnimation(stringfilename)- Description
Create a new PixbufAnimation.
- Method
get_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().
- Method
get_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.
- Method
get_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.
- Method
get_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
- Method
close
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.
- Method
get_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.
- Method
set_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
- Method
add_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.
- Method
get_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
- Method
create
GTK2.GdkPixmapGTK2.GdkPixmap(int|objectimage)- Description
Create a new GDK2.Pixmap object. Argument is a GDK2.Image object or a Image.Image object
- Method
set
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.
- Method
cast
(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.
- Method
create
GTK2.GdkRectangleGTK2.GdkRectangle(intx,inty,intwidth,intheight)- Description
Create a new rectangle
NOIMG
Class GTK2.GdkRegion
- Description
Region information.
- Method
equal
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.
- Method
intersect
GTK2.GdkRegionintersect(GTK2.GdkRegionvictim)- Description
Computes the intersection of the given region and the region. Also available as region & region
- Method
point_in
intpoint_in(intx,inty)- Description
Returns true if the given point resides in the given region
- Method
rect_in
intrect_in(GTK2.GdkRectangler)- Description
Returns true if the given rectangle resides inside the given region
- Method
shrink
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.
- Method
subtract
GTK2.GdkRegionsubtract(GTK2.GdkRegionvictim)- Description
Computes the difference of the given region and the region. Also available as region - region
- Method
union
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
- Method
get_active_window
GTK2.GdkWindowget_active_window()- Description
Returns the currently active window.
- Method
get_default_colormap
GTK2.GdkColormapget_default_colormap()- Description
Gets the default colormap.
- Method
get_display
GTK2.GdkDisplayget_display()- Description
Gets the display to which this screen belongs.
- Method
get_monitor_at_point
intget_monitor_at_point(intx,inty)- Description
Returns the monitor number in which x,y is located.
- Method
get_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.
- Method
get_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.
- Method
get_n_monitors
intget_n_monitors()- Description
Returns the number of monitors which this screen consists of.
- Method
get_number
intget_number()- Description
Gets the index of this screen among the screens in the display to which it belongs.
- Method
get_rgb_colormap
GTK2.GdkColormapget_rgb_colormap()- Description
Gets the preferred colormap for rendering image data.
- Method
get_rgb_visual
GTK2.GdkVisualget_rgb_visual()- Description
Get a "preferred visual" chosen by GdkRGB for rendering image data.
- Method
get_rgba_colormap
GTK2.GdkColormapget_rgba_colormap()- Description
Gets a colormap to use for creating windows or pixmaps with an alpha channel.
- Method
get_rgba_visual
GTK2.GdkVisualget_rgba_visual()- Description
Gets a visual to use for creating windows or pixmaps with an alpha channel.
- Method
get_system_colormap
GTK2.GdkColormapget_system_colormap()- Description
Gets the system default colormap.
- Method
get_toplevel_windows
arrayget_toplevel_windows()- Description
Returns a list of all toplevel windows known to GDK on the screen.
- Method
is_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.
- Method
list_visuals
arraylist_visuals(int|voiddef)- Description
List the available visuals. If def is true, return the available visuals for the default screen.
- Method
make_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.
- Method
set_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.
- Method
create
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
- Method
change_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
- Method
create
GTK2.GdkWindowGTK2.GdkWindow(GTK2.GdkWindowparent,mapping|voidattributes)- Description
Not for non-experts. I promise.
- Method
get_geometry
mappingget_geometry()- Description
Returns ([ "x":xpos, "y":ypos, "width":width, "height":height, "depth":bits_per_pixel ])
- Method
get_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] );
- Method
grab_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.
- Method
is_visible
intis_visible()- Description
Return 1 if the window, or a part of the window, is visible right now.
- Method
move_resize
GDK2.Windowmove_resize(intx,inty,intw,inth)- Description
Move and resize the window in one call.
- Method
set_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.
- Method
set_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.
- Method
set_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>
- Method
set_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
- Method
set_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.
- Method
set_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).
- Method
create
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.
- Method
create
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.
- Method
get_signal_id
intget_signal_id(GTK2.Widgetwidget)- Description
Used to get the signal id attached to a GladeXML object.
- Method
get_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.
- Method
get_widget_name
stringget_widget_name(GTK2.Widgetwidget)- Description
Used to get the name of a widget that was generated by a GladeXML object.
- Method
get_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.
- Method
signal_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
- Method
add_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.
- Method
add_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.
- Method
create
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.
- Method
enable_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.
- Method
set_contents
Gnome2.Appset_contents(GTK2.Widgetcontents)- Description
Sets the status bar of the application window.
- Method
set_menus
Gnome2.Appset_menus(GTK2.MenuBarmenu_bar)- Description
Sets the menu bar of the application window.
- Method
set_statusbar
Gnome2.Appset_statusbar(GTK2.Widgetstatusbar)- Description
Sets the status bar of the application window.
- Method
set_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
- Method
clear_stack
Gnome2.Appbarclear_stack()- Description
Remove all status messages from appbar, and display default status message (if present).
- Method
create
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.
- Method
get_progress
GTK2.ProgressBarget_progress()- Description
Returns GTK2.ProgressBar widget pointer, so that the progress bar may be manipulated further.
- Method
pop
Gnome2.Appbarpop()- Description
Remove current status message, and display previous status message, if any. It is OK to call this with an empty stack.
- Method
push
Gnome2.Appbarpush(stringwhat)- Description
Push a new status message onto the status bar stack, and display it.
- Method
refresh
Gnome2.Appbarrefresh()- Description
Reflect the current state of stack/default. Useful to force a set_status to disappear.
- Method
set_default
Gnome2.Appbarset_default(stringdefault_status)- Description
What to show when showing nothing else; defaults to "".
- Method
set_progress_percentage
Gnome2.Appbarset_progress_percentage(floatpercentage)- Description
Sets progress bar to the given percentage.
- Method
set_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
- Method
create
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.
- Method
get_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.
- Method
get_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.
- Method
get_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.
- Method
get_dither
intget_dither()- Description
Returns the type of dithering used to render an antialiased canvas.
- Method
get_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.
- Method
get_scroll_offsets
arrayget_scroll_offsets()- Description
Queries the scrolling offsets of a canvas. The values are returned in canvas pixel units.
- Method
get_scroll_region
mappingget_scroll_region()- Description
Queries the scrolling region of a canvas.
- Method
scroll_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
w2c
arrayw2c(floatwx,floatwy)- Description
Converts world coordinates into canvas pixel coordinates.
- Method
w2c_affine
arrayw2c_affine()- Description
Gets the affine transform that converts from world coordinates to canvas pixel coordinates.
- Method
w2c_d
arrayw2c_d(floatwx,floatwy)- Description
Converts world coordinates into canvas pixel coordinates. This version returns coordinates in floating point coordinates, for greater precision.
- Method
window_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
- Method
create
GTK2.Gnome2ClientGTK2.Gnome2Client()- Description
Gets the master session management client.
- Method
disconnect
Gnome2.Clientdisconnect()- Description
Disconnect the client from the session manager.
- Method
flush
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.
- Method
get_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).
- Method
get_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.
- Method
get_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.
- Method
get_previous_id
stringget_previous_id()- Description
Get the session management ID from the previous session.
- Method
request_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.
- Method
request_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.
- Method
save_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.
- Method
save_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.
- Method
set_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.
- Method
set_current_directory
Gnome2.Clientset_current_directory(stringdir)- Description
Set the directory to be in when running shutdown, discard, restart, etc. commands.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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.
- Method
set_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
- Method
set_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
- Method
create
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.
- Method
get_initial_time
intget_initial_time()- Description
Queries the initial time that was set using set_time() or during creation.
- Method
set_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.
- Method
set_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
- Method
append_page
Gnome2.Druidappend_page(GTK2.Gnome2DruidPagepage)- Description
This will append a GnomeDruidPage into the internal list of pages that the druid has.
- Method
insert_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.
- Method
prepend_page
Gnome2.Druidprepend_page(GTK2.Gnome2DruidPagepage)- Description
This will prepend a GnomeDruidPage into the internal list of pages that the druid has.
- Method
set_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.
- Method
set_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.
- Method
set_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
- Method
next
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
- Method
create
GTK2.Gnome2DruidPageEdgeGTK2.Gnome2DruidPageEdge(intposition,int|voidanti_alias)- Description
Create a new Gnome2.DruidPageEdge, with optional anti-aliasing.
- Method
set_bg_color
Gnome2.DruidPageEdgeset_bg_color(GTK2.GdkColorcolor)- Description
This will set the background color.
- Method
set_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.
- Method
set_logo_bg_color
Gnome2.DruidPageEdgeset_logo_bg_color(GTK2.GdkColorcolor)- Description
Sets the color behind the druid page's logo.
- Method
set_text
Gnome2.DruidPageEdgeset_text(sprintf_formattext,sprintf_args...fmt)- Description
Sets the contents of the text portion.
- Method
set_text_color
Gnome2.DruidPageEdgeset_text_color(GTK2.GdkColorcolor)- Description
Sets the color of the text in the body of the page.
- Method
set_textbox_color
Gnome2.DruidPageEdgeset_textbox_color(GTK2.GdkColorcolor)- Description
Sets the color of the background in the main text area of the page.
- Method
set_title
Gnome2.DruidPageEdgeset_title(stringtitle)- Description
Sets the contents of the page's title text.
- Method
set_title_color
Gnome2.DruidPageEdgeset_title_color(GTK2.GdkColorcolor)- Description
Sets the color of the title text.
- Method
set_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.
- Method
create
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
- Method
append_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.
- Method
create
GTK2.Gnome2DruidPageStandardGTK2.Gnome2DruidPageStandard(string|voidtitle,GTK2.GdkPixbuflogo,GTK2.GdkPixbuftop_watermark)- Description
Construct a new Gnome2.DruidPageStandard.
- Method
set_background
Gnome2.DruidPageStandardset_background(GTK2.GdkColorcolor)- Description
Sets the background color of the top section.
- Method
set_contents_background
Gnome2.DruidPageStandardset_contents_background(GTK2.GdkColorcolor)- Description
Sets the color of the main contents section's background.
- Method
set_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.
- Method
set_logo_background
Gnome2.DruidPageStandardset_logo_background(GTK2.GdkColorcolor)- Description
Sets the background color of the logo.
- Method
set_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
- Method
create
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.
- Method
get_text
stringget_text()- Description
Returns the contents of the label widget used to display the link text.
- Method
set_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
- Method
create
GTK2.Gnome2IconEntryGTK2.Gnome2IconEntry(stringhistory_id,stringtitle)- Description
Creates a new icon entry widget
- Method
get_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.
- Method
pick_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.
- Method
set_browse_dialog_title
Gnome2.IconEntryset_browse_dialog_title(stringtitle)- Description
Set the title of the browse dialog.
- Method
set_filename
intset_filename(stringfilename)- Description
Sets the icon of Gnome2.IconEntry to be the one pointed to by filename.
- Method
set_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.
- Method
add_defaults
Gnome2.IconSelectionadd_defaults()- Description
Adds the default pixmap directory into the selection widget.
- Method
add_directory
Gnome2.IconSelectionadd_directory(stringdir)- Description
Adds the icons from the directory dir to the selection widget.
- Method
clear
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.
- Method
create
GTK2.Gnome2IconSelectionGTK2.Gnome2IconSelection()- Description
Creates a new icon selection widget, it uses a W(GnomeIconList) for the listing of icons
- Method
get_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.
- Method
select_icon
Gnome2.IconSelectionselect_icon(stringfilename)- Description
Selects the icon filename. This icon must have already been added and shown
- Method
show_icons
Gnome2.IconSelectionshow_icons()- Description
Shows the icons inside the widget that were added with add_defaults and add_directory. Before this function isf called the icons aren't actually added to the listing and can't be picked by the user.
Class GTK2.HScrollbar
- Description
A horizontal scrollbar. General documentation: See W(Scrollbar)
 GTK2.HScrollbar(GTK2.Adjustment())->set_size_request(300,15)
Class GTK2.HandleBox
- Description
The contents of a handle box can be 'dragged' out of the box by the user. The contents will then be placed in a separate window.
 GTK2.HandleBox()->add(GTK2.Label("The contents"))
Properties: int handle-position int shadow int shadow-type int snap-edge int snap-edge-set
Signals: child_attached Called when a new child is added to the box
child_detached Called when a child is removed from the box
- Method
create
GTK2.HandleBoxGTK2.HandleBox(mapping|voidprops)- Description
Create a new handle box widget.
- Method
set_handle_position
GTK2.HandleBoxset_handle_position(intpos)- Description
The position of the handle. One of
POS_BOTTOM,POS_LEFT,POS_RIGHTandPOS_TOP
- Method
set_shadow_type
GTK2.HandleBoxset_shadow_type(intshadow_type)- Description
One of
SHADOW_ETCHED_IN,SHADOW_ETCHED_OUT,SHADOW_IN,SHADOW_NONEandSHADOW_OUT
Class GTK2.Hbox
- Description
Most packing is done by creating boxes. These are invisible widget containers that we can pack our widgets into which come in two forms, a horizontal box, and a vertical box. This is the horizontal one. When packing widgets into a horizontal box, the objects are inserted horizontally from left to right or right to left depending on the call used.
 GTK2.Hbox(0,0)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))
 GTK2.Hbox(1,0)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))
 GTK2.Hbox(1,40)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))
Class GTK2.HbuttonBox
- Description
A HbuttonBox is very similar to a Hbox. The major diffference is that the button box is made to pack buttons in, and has a few convenience function for normal button layouts.
 GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_size_request(400,30)
 GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_SPREAD)->set_size_request(400,30)
 GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_EDGE)->set_size_request(400,30)
 GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_START)->set_size_request(400,30)
 GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_END)->set_size_request(400,30)
Class GTK2.Hpaned
- Description
The paned window widgets are useful when you want to divide an area into two parts, with the relative size of the two parts controlled by the user. A groove is drawn between the two portions with a handle that the user can drag to change the ratio. This widgets makes a horizontal division
See W(Paned) for details.
 GTK2.Hpaned()->add1(GTK2.Label("Left\nSide\nOf\nPane"))->add2(GTK2.Label("Right\nSide\nOf\nPane"))->set_size_request(100,100)
Class GTK2.Hscale
- Description
The GTK2.HScale widget is used to allow the user to select a value using a horizontal slider. A GTK2.Adjustment is used to set the initial value, the lower and upper bounds, and the step and page increments.
See W(Scale) for details
The position to show the current value, and the number of decimal places shown can be set using the parent W(Scale) class's functions.
 GTK2.Hscale(GTK2.Adjustment())->set_size_request(300,30)
Class GTK2.Hseparator
- Description
Simply creates a horizontal separator. No bells or whistles.
 GTK2.Hseparator()->set_size_request(300,3)
Class GTK2.IconFactory
- Description
Icon factory, for holding icon sets.
- Method
add
GTK2.IconFactoryadd(stringstock_id,GTK2.IconSeticon_set)- Description
Adds the given icon_set to the icon factory, under the name of stock_id. stock_id should be namespaced for your application, e.g. "myapp-whatever-icon". Normally applications create a GTK2.IconFactory, then add it to the list of default factories with add_default(). Then they pass the stock_id to widgets such as GTK2.Image to display the icon. Themes can provide an icon with the same name (such as "myapp-whatever-icon") to override your application's default icons. If an icon already existed in this factory for stock_id, it is unreferenced and replaced with the new icon_set.
- Method
add_default
GTK2.IconFactoryadd_default()- Description
Adds an icon factory to the list of icon factories search by GTK2.Style->lookup_icon_set(). This means that, for example, GTK2.Image->create("stock-id") will be able to find icons in factory. There will normally be an icon factory added for each library or application that comes with icons. The default icon factories can be overridden by themes.
- Method
create
GTK2.IconFactoryGTK2.IconFactory()- Description
Creates a new GTK2.IconFactory. An icon factory manages a collection of GTK2.IconSets; a GTK2.IconSet manages a set of variants of a particular icon (i.e. a GTK2.IconSet contains variants for different sizes and widget states). Icons in an icon factory are named by a stock ID, which is a simple string identifying the icon. Each GTK2.Style has a list of GTK2.IconFactorys derived from the current theme; those icon factories are consulted first when searching for an icon. If the theme doesn't set a particular icon, GTK2+ looks for the icon in a list of default icon factories, maintained by add_default() and remove_default(). Applications with icons should add a default icon factory with their icons, which will allow themes to override the icons for the application.
- Method
lookup
GTK2.IconSetlookup(stringstock_id)- Description
Looks up stock_id in the icon factory, returning an icon set if found, otherwise 0. For display to the user, you should use GTK2.Style->lookup_icon_set() on the GTK2.Style for the widget that will display the icon, instead of using this function directly, so that themes are taken into account.
- Method
lookup_default
GTK2.IconSetlookup_default(stringstock_id)- Description
Looks for an icon in the list of default icon factories. For display to the user, you should use GTK2.Style->lookup_icon_set() on the GTK2.Style for the widget that will display the icon, instead of using this function directly, so that themes are taken into account.
Class GTK2.IconInfo
- Description
Contains information found when looking up an icon in an icon theme.
- Method
get_base_size
intget_base_size()- Description
Gets the base size for the icon. The base size is a size for the icon that was specified by the icon theme creator. This may be different than the actual size of image; an example of this is small emblem icons that can be attached to a larger icon. These icons will be given the same base size as the larger icons to which they are attached.
- Method
get_builtin_pixbuf
GTK2.GdkPixbufget_builtin_pixbuf()- Description
Gets the built-in image for this icon, if any. To allow GTK2+ to use built-in icon images, you must pass the GTK2.ICON_LOOKUP_USE_BUILTIN to GTK2.IconTheme->lookup_icon().
- Method
get_filename
stringget_filename()- Description
Gets the filename for the icon. If the GTK2.ICON_LOOKUP_USE_BUILTIN flag was passed to GTK2.IconTheme->lookup_icon(), there may be no filename if a builtin icon is returned; in this case, you should use get_builtin_pixbuf().
- Method
load_icon
GTK2.GdkPixbufload_icon()- Description
Renders an icon previously looked up in an icon theme using GTK2.IconTheme->lookup_icon(); the size will be based on the size passed to GTK2.IconTheme->lookup_icon(). Note that the resulting pixbuf may not be exactly this size; an icon theme may have icons that differe slightly from their nominal sizes, and in addition GTK2+ will avoid scaling icons that it considers sufficiently close to the requested size or for which the source image would have to be scaled up too far. (This maintains sharpness.)
Class GTK2.IconSet
- Description
Iconset. A single icon.
- Method
add_source
GTK2.IconSetadd_source(GTK2.IconSourcesource)- Description
Icon sets have a list of GTK2.IconSource, which they use as base icons for rendering icons in different states and sizes. Icons are scaled, made to look insensitive, etc. in render_icon(), but GTK2.IconSet needs base images to work with. The base images and when to use them are described by a GTK2.IconSource.
This function copies source, so you can reuse the same source immediately without affecting the icon set.
An example of when you'd use this function: a web browser's "Back to Previous Page" icon might point in a different direciton in Hebrew and in English; it might look different when insensitive; and it might change size depending on toolbar mode (small/large icons). So a single icon set would contain all those variants of the icon, and you might add a separate source for each one.
You should nearly always add a "default" icon source with all fields wildcarded, which will be used as a fallback if no more specific source matches. GTK2.IconSet always prefers more specific icon sources to more generic icon sources. The order in which you add the sources to the icon set does not matter.
- Method
create
GTK2.IconSetGTK2.IconSet(GTK2.GdkPixbufpixbuf)- Description
Create a new GTK2.IconSet. A GTK2.IconSet represents a single icon in various sizes and widget states. It can provide a GDK2.Pixbuf for a given size and state on request, and automatically caches some of the rendered GDK2.Pixbuf objects.
Normally you would use GTK2.Widget->render_icon() instead of using GTK2.IconSet directly. The one case where you'd use GTK2.IconSet is to create application-specific icon sets to place in a GTK2.IconFactory.
Class GTK2.IconSize
- Description
Iconsize.
- Method
register
intregister(stringname,intwidth,intheight)- Description
Registers a new icon size, along the same lines as GTK2.ICON_SIZE_MENU, etc. Returns the integer value for the size.
Class GTK2.IconSource
- Description
Iconsource.
- Method
create
GTK2.IconSourceGTK2.IconSource()- Description
Creates a new GTK2.IconSource. A GTK2.IconSource contains a GDK2.Pixbuf (or image filename) that serves as the base image for one or more of the icons in a GTK2.IconSet, along with a specification for which icons in the icon set will be based on that pixbuf or image file. An icon set contains a set of icons that represent "the same" logical concept in different states, different global text directions, and different sizes.
So for example a web browser's "Back to Previous Page" icon might point in a different direction in Hebrew and in English; it might look different when insensitive; and it might change size depending on toolbar mode small/large icons). So a single icon set would contain all those variants of the icon. GTK2.IconSet contains a list of GTK2.IconSource from which it can derive specific icon variants in the set.
In the simplest case, GTK2.IconSet contains one source pixbuf from which it derives all variants. The convenience function GTK2.IconSet->create(pixbuf) handles this case; if you only have one source pixbuf, just use that function.
If you want to use a different base pixbuf for different icon variants, you create multiple icon sources, mark which variants they'll be used to create, and add them to the icon set with GTK2.IconSet->add_source().
By default, the icon source has all parameters wildcarded. That is, the icon source will be used as the base icon for any desired text direction, widget state, or icon size.
- Method
get_direction
intget_direction()- Description
Obtains the text direction this icon source applies to. The return value is only useful/meaningful if the text direction is not wildcarded.
- Method
get_direction_wildcarded
intget_direction_wildcarded()- Description
Gets the value set by set_direction_wildcarded().
- Method
get_pixbuf
GTK2.GdkPixbufget_pixbuf()- Description
Retrieves the source pixbuf, or 0. In addition, if a filename source is in use, this function in some cases will return the pixbuf loaded from the filename. This is, for example, true for the GTK2.IconSource passed to the GTK2.Style->render_icon() virtual function.
- Method
get_size
intget_size()- Description
Obtains the icon size this source applies to. The return value is only useful/meaningful if the icon size is not wildcarded.
- Method
get_size_wildcarded
intget_size_wildcarded()- Description
Gets the value set by set_size_wildcarded().
- Method
get_state
intget_state()- Description
Obtains the widget state this icon source applies to. The return value is only useful/meaningful if the widget state is not wildcarded.
- Method
get_state_wildcarded
intget_state_wildcarded()- Description
Gets the value set by set_state_wildcarded().
- Method
set_direction
GTK2.IconSourceset_direction(intdir)- Description
Sets the text direction this icon source is intended to be used with.
Setting the text direction on an icon source makes no difference if the text direction is wildcarded. Therefore, you should usually call set_direction_wildcarded() to un-wildcard it in addition to calling this function.
- Method
set_direction_wildcarded
GTK2.IconSourceset_direction_wildcarded(intsetting)- Description
If the text direction is wildcarded, this source can be used as the base image for an icon in any text direction. If the text direction is not wildcarded, then the text direction the icon source applies to should be set with set_direction(), and the icon source will only be used with that text direction.
GTK2.IconSet prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible.
- Method
set_filename
GTK2.IconSourceset_filename(stringfilename)- Description
Sets the name of an image file to use as a base image when creating icon variants for GTK2.IconSet. The filename must be absolute.
- Method
set_icon_name
GTK2.IconSourceset_icon_name(stringname)- Description
Sets the name of an icon to look up in the current icon theme to use as a base image.
- Method
set_pixbuf
GTK2.IconSourceset_pixbuf(GTK2.GdkPixbufpixbuf)- Description
Sets a pixbuf to use as a base image.
- Method
set_size
GTK2.IconSourceset_size(intsize)- Description
Sets the icon size this icon source is intended to be with.
- Method
set_size_wildcarded
GTK2.IconSourceset_size_wildcarded(intsetting)- Description
If the icon size is wildcarded, this source can be used as the base image for an icon of any size. If the size is not wildcarded, then the size the source applies to should be set with set_size() and the icon source will only be used with that specific size.
- Method
set_state
GTK2.IconSourceset_state(intstate)- Description
Sets the widget state this icon source is intended to be used with.
- Method
set_state_wildcarded
GTK2.IconSourceset_state_wildcarded(intsetting)- Description
If the widget state is wildcarded, this source can be used as the base image for an icon in any state. If the widget state is not wildcarded, then the state the source applies to should be set with set_state() and the icon source will only be used with that specific state.
Class GTK2.IconTheme
- Description
Looking up icons by name.
Signals: changed
- Method
append_search_path
GTK2.IconThemeappend_search_path(stringpath)- Description
Appends a directory to the search path.
- Method
create
GTK2.IconThemeGTK2.IconTheme()- Description
Creates a new icon theme object. Icon theme objects are used to lookup an icon by name in a particular icon theme. Usually you'll want to use get_default() rather than creating a new icon theme object from scratch.
- Method
get_example_icon_name
stringget_example_icon_name()- Description
Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user.)
- Method
get_icon_sizes
arrayget_icon_sizes(stringname)- Description
Returns an array of integers describing the sizes at which the icon is available without scaling. A size of -1 means that the icon is available in a scalable format.
- Method
has_icon
inthas_icon(stringicon_name)- Description
Checks whether this icon theme includes an icon for a particular name.
- Method
list_icons
arraylist_icons(string|voidcontext)- Description
Lists the icons in the current icon theme. Only a subset of the icons can be listed by providing a context string. The set of values for the context string is system dependent, but will typically include such values as 'apps' and 'mimetypes'.
- Method
load_icon
GTK2.GdkPixbufload_icon(stringname,intsize,intflags)- Description
Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf.
- Method
lookup_icon
GTK2.IconInfolookup_icon(stringname,intsize,intflags)- Description
Looks up a named icon and returns an object containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using GTK2.IconInfo->load_icon().
- Method
prepend_search_path
GTK2.IconThemeprepend_search_path(stringpath)- Description
Prepends a directory to the search path.
- Method
rescan_if_needed
intrescan_if_needed()- Description
Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time this theme is accessed.
- Method
set_custom_theme
GTK2.IconThemeset_custom_theme(stringtheme_name)- Description
Sets the name of the icon theme that the GTK2.IconTheme object uses overriding system configuration. This function cannot be called on the icon theme objects return from get_default().
- Method
set_search_path
GTK2.IconThemeset_search_path(arraypath)- Description
Sets the search path for the icon theme object. When looking for an icon theme, GTK2+ will search for a subdirectory of one or more of the directories in path with the same name as the icon theme. (Themes from multiple of the path elemets are combined to allow themes to be extended by adding icons in the user's home directory.)
In addition if an icon found isn't found either in the current icon theme or the default icon theme, and an image file with the right name is found directly in one of the elements of path, then that image will be used for the icon name. (This is a legacy feature, and new icons should be put into the default icon theme, which is called DEFAULT_THEME_NAME, rather than directly on the icon path.)
Class GTK2.IconView
- Description
GTK2.IconView provides an alternative view on a list model. It displays the model as a grid of icons with labels. Like GTK2.TreeView, it allows to select one or multiple items (depending on the selection mode). In addition to seleciton with the arrow keys, GTK2.IconView supports rubberband selections, which is controlled by dragging the pointer. Properties: int column-spacing int columns int item-width int margin int markup-column GTK2.TreeModel model int orientation int pixbuf-column int row-spacing int selection-mode int spacing int text-column
Style properties: int selection-box-alpha GDK2.Color selection-box-color
Signals: activate_cursor_item
item_activated
move_cursor
select_all
select_cursor_item
selection_changed
set_scroll_adjustments
toggle_cursor_item
unselect_all
- Method
create
GTK2.IconViewGTK2.IconView(GTK2.TreeModelmodel_or_props)- Description
Creates a new GTK2.IconView widget Not implemented yet.
- Method
get_column_spacing
intget_column_spacing()- Description
Returns the value of the column-spacing property.
- Method
get_cursor
arrayget_cursor()- Description
Returns the GTK2.TreePath and GTK2.CellRenderer of the current cursor path and cell. If the cursor isn't currently set, then path will be 0. If no cell currently has focus, then cell will be 0.
- Method
get_item_at_pos
arrayget_item_at_pos(intx,inty)- Description
Finds the path at the point (x,y) relative to widget coordinates. In contrast to get_path_at_pos(), this function also obtains the cell at the specified position.
- Method
get_path_at_pos
GTK2.TreePathget_path_at_pos(intx,inty)- Description
Finds the path at the point(x,y) relative to widget coordinates.
- Method
get_reorderable
intget_reorderable()- Description
Retrieves whether the user can reorder the list via drag-and-drop.
- Method
get_selected_items
arrayget_selected_items()- Description
Creates a list of paths of all selected items. Not implemented yet.
- Method
get_visible_range
arrayget_visible_range()- Description
Returns the first and last visible path. Note that there may be invisible paths in between.
- Method
item_activated
GTK2.IconViewitem_activated(GTK2.TreePathpath)- Description
Activates the item determined by path.
- Method
path_is_selected
intpath_is_selected(GTK2.TreePathpath)- Description
Returns true if the icon pointed to by path is currently selected. If icon does not point to a valid location, false is returned.
- Method
scroll_to_path
GTK2.IconViewscroll_to_path(GTK2.TreePathpath,intuse_align,floatrow_align,floatcol_align)- Description
Moves the alignments to the position specified by path. row_align determines where the row is placed, and col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.
If use_align is FALSE, then the alignment arguments are ignored, and the tree does the minimum amount of work to scroll the item onto the screen. This means that the item will be scrolled to the edge closest to its current position. If the item is currently visible on the screen, nothing is done.
This funciton only works if the model is set, and path is a valid row on the model. If the model changes before this icon view is realized, the centered path will be modified to reflect this change.
- Method
select_all
GTK2.IconViewselect_all()- Description
Selects all the icons. This widget must have its selection mode set to GTK2.SELECTION_MULTIPLE.
- Method
set_column_spacing
GTK2.IconViewset_column_spacing(intcolumn_spacing)- Description
Sets the column-spacing property which specifies the space which is inserted between the columns of the icon view.
- Method
set_columns
GTK2.IconViewset_columns(intcolumns)- Description
Sets the columns property which determines in how many columns the icons are arranged. If columns is -1, the number of columns will be chosen automatically to fill the available area.
- Method
set_cursor
GTK2.IconViewset_cursor(GTK2.TreePathpath,GTK2.CellRenderercell,int|voidstart_editing)- Description
Sets the current keyboard focus to be at path, and selects it. This is usefull when you want to focus the user's attention on a particular item. If cell is not 0, then focus is given to the cell speicified by it. Additionally, if start_editing is TRUE, then editing should be started in the specified cell.
This function is often followed by grab_focus() in order to give keyboard focus to the widget.
- Method
set_item_width
GTK2.IconViewset_item_width(intitem_width)- Description
Sets the item-width property which specifies the width to use for each item. If it is set to -1, the icon view will automatically determine a suitable item size.
- Method
set_markup_column
GTK2.IconViewset_markup_column(intcolumn)- Description
Sets the column with markup information to be column.
- Method
set_orientation
GTK2.IconViewset_orientation(intorientation)- Description
Sets the orientation property which determines whether the labels are drawn beside the icons instead of below. One of
ORIENTATION_HORIZONTALandORIENTATION_VERTICAL
- Method
set_pixbuf_column
GTK2.IconViewset_pixbuf_column(intcolumn)- Description
Sets the column with pixbufs to be column.
- Method
set_reorderable
GTK2.IconViewset_reorderable(intsetting)- Description
This function is a convenience function to allow you to reorder models. Both GTK2.TreeStore and GTK2.ListStore support this. If setting is TRUE, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model's "row-inserted" and "row-deleted" signals.
- Method
set_row_spacing
GTK2.IconViewset_row_spacing(introw_spacing)- Description
Sets the row-spacing property which specifies the space which is inserted between the rows of the icon view.
- Method
set_selection_mode
GTK2.IconViewset_selection_mode(intmode)- Description
Sets the selection mode. One of
SELECTION_BROWSE,SELECTION_MULTIPLE,SELECTION_NONEandSELECTION_SINGLE
- Method
set_spacing
GTK2.IconViewset_spacing(intspacing)- Description
Sets the spacing property which specifies the space which is inserted between the cells (i.e. the icon and the text) of an item.
- Method
set_text_column
GTK2.IconViewset_text_column(intcolumn)- Description
Sets the column with text to be column.
Class GTK2.Image
- Description
An image is a image object stored in client, not X server, memory. A pixmap, on the other hand, is a image object stored in the X-server. See GDK2.Image and GDK2.Pixmap.
 GTK2.Image("tornado_nguyen_big.jpg");
Properties: string file string icon-name icon-set int icon-size GDK2.Image image GDK2.Pixmap mask GDK2.Pixbuf pixbuf GDK2.PixbufAnimation pixbuf-animation int pixel-size GDK2.Pixmap pixmap string stock int storage-type
IMAGE_ANIMATION,IMAGE_EMPTY,IMAGE_ICON_NAME,IMAGE_ICON_SET,IMAGE_IMAGE,IMAGE_PIXBUF,IMAGE_PIXMAPandIMAGE_STOCK
- Method
create
GTK2.ImageGTK2.Image(string|GdkPixbuf|GdkPixbufAnimation|GdkImage|GdkPixmap|mappingfile_or_props,GTK2.GdkBitmapmask_or_size)- Description
Create a new W(Image) from either a file or a GDK2.Pixbuf.
- Method
get_animation
GTK2.GdkPixbufAnimationget_animation()- Description
Gets the GDK2.PixbufAnimation being displayed.
- Method
get_image
mappingget_image()- Description
Returns ([ "image":GDK2.Image img, "mask":GDK2.Bitmap mask ])
- Method
get_pixbuf
GTK2.GdkPixbufget_pixbuf()- Description
Gets the GDK2.Pixbuf being displayed. The storage type of the image must be GTK2.IMAGE_EMPTY or GTK2.IMAGE_PIXBUF).
- Method
get_storage_type
intget_storage_type()- Description
Gets the type of representation being used to store data. If it has no image data, the return value will be GTK2.IMAGE_EMPTY. One of
IMAGE_ANIMATION,IMAGE_EMPTY,IMAGE_ICON_NAME,IMAGE_ICON_SET,IMAGE_IMAGE,IMAGE_PIXBUF,IMAGE_PIXMAPandIMAGE_STOCK
- Method
set_from_animation
GTK2.Imageset_from_animation(GTK2.GdkPixbufAnimationanim)- Description
Causes the W(Image) to display the given animation.
- Method
set_from_icon_name
GTK2.Imageset_from_icon_name(stringicon_name,intsize)- Description
Sets from an icon name.
- Method
set_from_icon_set
GTK2.Imageset_from_icon_set(GTK2.IconSeticon_set,intsize)- Description
Set this image from an icon set.
- Method
set_from_image
GTK2.Imageset_from_image(GTK2.GdkImagegdk_image,GTK2.GdkBitmapmask)- Description
Set this image from a GDK2.Image plus optional mask.
- Method
set_from_pixbuf
GTK2.Imageset_from_pixbuf(GTK2.GdkPixbufpixbuf)- Description
Set image from a pixbuf
- Method
set_from_pixmap
GTK2.Imageset_from_pixmap(GTK2.GdkPixmappixmap,GTK2.GdkBitmapmask)- Description
Set this image from a GDK2.Pixmap plus optional mask.
- Method
set_from_stock
GTK2.Imageset_from_stock(stringstock_id,intsize)- Description
Sets from a stock icon. Sample icon names are GTK2.STOCK_OPEN, GTK2.STOCK_EXIT. Sample stock sizes are GTK2.ICON_SIZE_MENU, GTK2.ICON_SIZE_SMALL_TOOLBAR. If the stock name isn't known, the image will be empty.
Class GTK2.ImageMenuItem
- Description
Properties: GTK2.Widget image
- Method
create
GTK2.ImageMenuItemGTK2.ImageMenuItem(string|mappinglabel)- Description
Create a new ImageMenuItem.
- Method
get_image
GTK2.Widgetget_image()- Description
Gets the widget that is currently set as the image.
Class GTK2.Invisible
- Description
An invisible container, useful, eh? :) Properties: GDK2.Screen screen
- Method
create
GTK2.InvisibleGTK2.Invisible(mapping|voidprops)- Description
Create a new invisible widget
Class GTK2.Item
- Description
This class is inherited by all 'item' type of widgets.
Signals: deselect
select
toggle
Class GTK2.KeywordListTag
Class GTK2.Label
- Description
A simple text label.
 GTK2.Label("A simple text label")
 GTK2.Label("Multi\nline text\nlabel here")
 GTK2.Label("Multi\nline text\nlabel here")->set_justify(GTK2.JUSTIFY_LEFT)
 GTK2.Label("Multi\nline text\nlabel here")->set_justify(GTK2.JUSTIFY_RIGHT)
Properties: float angle Pango.AttrList attributes int cursor-position int ellipsize
PANGO_ELLIPSIZE_END,PANGO_ELLIPSIZE_MIDDLE,PANGO_ELLIPSIZE_NONEandPANGO_ELLIPSIZE_STARTint justfyJUSTIFY_CENTER,JUSTIFY_FILL,JUSTIFY_LEFTandJUSTIFY_RIGHTstring label int max-width-chars int mnemonic-keyval int mnemonic-widget string pattern int selectable int single-line-mode int use-markup int use-underline int width-chars int wrapSignals: copy_clipboard
move_cursor
populate_popup
- Method
get_label
stringget_label()- Description
Fetches the text from a label widget including any underlines indicating mnemonics and Pango markup.
- Method
get_layout
GTK2.Pango.Layoutget_layout()- Description
Gets the Pango.Layout used to display the label. The layout is useful to e.g. convert text positions to pixel positions, in combination with get_layout_offsets().
- Method
get_layout_offsets
mappingget_layout_offsets()- Description
Obtains the coordinates where the label will draw the Pango.Layout representing the text in the label; useful to convert mouse events into coordinates inside the Pango.Layout, e.g. to take some action if some part of the label is clicked. Of course, you will need to create a GTK2.EventBox to receive the events, and pack the label inside it, since labels are a GTK2.NO_WINDOW widget. Remember when using the Pango.Layout functions you need to convert to and from pixels using GTK2.PANGO_SCALE.
- Method
get_line_wrap
intget_line_wrap()- Description
Returns whether lines in the label are automatically wrapped.
- Method
get_line_wrap_mode
intget_line_wrap_mode()- Description
Returns line wrap mode used by the label.
- Method
get_max_width_chars
intget_max_width_chars()- Description
Retrieves the desired maximum width, in characters.
- Method
get_mnemonic_keyval
intget_mnemonic_keyval()- Description
If the label has been set so that is has a mnemonic key, this function returns the keyval used for the mnemonic accelerator. If there is no mnemonic set up it returns GDK_VoidSymbol.
- Method
get_mnemonic_widget
GTK2.Widgetget_mnemonic_widget()- Description
Retrieves the target of the mnemonic (keyboard shortcut).
- Method
get_selection_bounds
mappingget_selection_bounds()- Description
Gets the selected range of characters in the label. If there isn't a selection, returns -1 for both start and end.
- Method
get_single_line_mode
intget_single_line_mode()- Description
Returns whether the label is in single line mode.
- Method
get_text
stringget_text()- Description
Fetches the text from a label widget, as displayed on the screen. This does not include any embedded underlines indicating mnemonics or Pango markup. (see get_label()).
- Method
get_use_markup
intget_use_markup()- Description
Returns whether the label's text is interpreted as marked up with the Pango text markup language.
- Method
get_use_underline
intget_use_underline()- Description
Returns whether an embedded underline in the label indicates a mnemonic.
- Method
select_region
GTK2.Labelselect_region(intstart_offset,intend_offset)- Description
Selects a range of characters in the label, if the label is selectable. See set_selectable(). If the label is not selectable, this function has no effect. If start_offset or end_offset are -1, then the end of the label will be substituted.
- Method
set_angle
GTK2.Labelset_angle(int|floatangle)- Description
Sets the angle of rotation for the label. An angle of 90 reads from bottom to top, and angle of 270, from top to bottom. The angle setting for the label is igrnored if the lable is selectable, wrapped, or ellipsized.
- Method
set_ellipsize
GTK2.Labelset_ellipsize(intmode)- Description
Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there is not enough space to render the entire string. One of
PANGO_ELLIPSIZE_END,PANGO_ELLIPSIZE_MIDDLE,PANGO_ELLIPSIZE_NONEandPANGO_ELLIPSIZE_START.
- Method
set_justify
GTK2.Labelset_justify(intjtype)- Description
Sets the alignment of the lines in the text of the label relative to each other. GTK2.JUSTIFY_LEFT is the default value when the widget is first created. If you instead want to set the alignment of the label as a whole, use set_alignment() instead. set_justify() has no efect on labels containing only a single line. One of
JUSTIFY_CENTER,JUSTIFY_FILL,JUSTIFY_LEFTandJUSTIFY_RIGHT.
- Method
set_label
GTK2.Labelset_label(stringtext)- Description
Sets the text of the label. The label is interpreted as including embedded underlines and/or Pango markup depending on the values of use-underline and use-markup.
- Method
set_line_wrap
GTK2.Labelset_line_wrap(intwrap)- Description
Toggles line wrapping within the widget. True makes it break lines if text exceeds the widget's size. False lets the text get cut off by the edge of the widget if it exceeds the widget size.
- Method
set_line_wrap_mode
GTK2.Labelset_line_wrap_mode(intwrap_mode)- Description
If line wrapping is on, this controls how the line wrapping is done. The Default is Pango.WRAP_WORD, which means wrap on word boundaries.
- Method
set_markup
GTK2.Labelset_markup(stringtext)- Description
Parses text which is marked up with the Pango text markup language, setting the label's text and attribute list based on the parse results.
- Method
set_markup_with_mnemonic
GTK2.Labelset_markup_with_mnemonic(stringtext)- Description
Parses text which is marked up with the Pango text markup language, setting the label's text and attribute list based on the parse results. If characters in text are preceded by an underscore, they are underline indicating that they represent a keyboard accelerator called a mnemonic.
The mnemonic key can be used to activate another widget, chosen automatically, or explicitly using set_mnemonic_widget().
- Method
set_max_width_chars
GTK2.Labelset_max_width_chars(intn_chars)- Description
Sets the desired maximum width in characters to n_chars.
- Method
set_mnemonic_widget
GTK2.Labelset_mnemonic_widget(GTK2.Widgetwidget)- Description
If the label has been set so that it has a mnemonic key (using i.e. set_markup_with_mnemonic(), set_text_with_mnemonic(), or the "use_underline" property) the label can be associated with a widget that is the target of the mnemonic. When the label is inside a widget (like a GTK2.Button or GTK2.Notebook tab) it is automatically associated with the correct widget, but sometimes (i.e. when the target is a GTK2.Entry next to the label) you need to set it explicitly using this function.
The target widget will be accelerated by emitting "mnemonic_activate" on it. The default handler for this signal will activate the widget if there are no mnemonic collisions and toggle focus between the colliding widgets otherwise.
- Method
set_pattern
GTK2.Labelset_pattern(stringpattern_string)- Description
A string with either spaces or underscores. It should be of the same length as the text.
When a character in the text has a matching _ in the pattern, the character in the label will be underlined.
- Method
set_selectable
GTK2.Labelset_selectable(intsetting)- Description
Selectable labels allow the user to select text from the label, for copy and past.
- Method
set_single_line_mode
GTK2.Labelset_single_line_mode(intmode)- Description
Sets whether the label is in single line mode.
- Method
set_text
GTK2.Labelset_text(sprintf_formattext,sprintf_args...fmt)- Description
Set the text in the label
- Method
set_text_with_mnemonic
GTK2.Labelset_text_with_mnemonic(sprintf_formattext,sprintf_args...fmt)- Description
Sets the label's text from the string text. If characters in text are preceded by an underscore, they are underlined indicating that they represent a keyboard accelerator called a mnemonic. The mnemonic key can be used to activate another widget, chose automatically, or explicitly using set_mnemonic_widget().
- Method
set_use_markup
GTK2.Labelset_use_markup(intsetting)- Description
Sets whether the text of the label contains markup in Pango's text markup language.
- Method
set_use_underline
GTK2.Labelset_use_underline(intsetting)- Description
If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
Class GTK2.Layout
- Description
Properties: GTK2.Adjustment hadjustment int height GTK2.Adjustment vadjustment int width
Child properties: int x int y
Signals: set_scroll_adjustments
- Method
create
GTK2.LayoutGTK2.Layout(GTK2.Adjustmenthadjustment_or_props,GTK2.Adjustmentvadjustment)- Description
Creates a new GTK2.Layout.
- Method
get_hadjustment
GTK2.Adjustmentget_hadjustment()- Description
Gets the GTK2.Adjustment used for communicaiton between the horizontal scrollbar and this layout. This should only be called after the layout has been placed in a GTK2.ScrolledWindow or otherwise configured for scrolling.
- Method
move
GTK2.Layoutmove(GTK2.Widgetwidget,intx,inty)- Description
Moves a current child to a new position.
- Method
put
GTK2.Layoutput(GTK2.Widgetwidget,intx,inty)- Description
Adds widget to the layout at position (x,y). The layout becomes the new parent.
- Method
set_hadjustment
GTK2.Layoutset_hadjustment(GTK2.Adjustmentadj)- Description
Sets the horizontal scroll adjustment for the layout.
- Method
set_size
GTK2.Layoutset_size(intxsize,intysize)- Description
Sets the size of the scrollable area of the layout.
Class GTK2.LineCommentTag
Class GTK2.LinkButton
- Description
Properties:
string uri A GTK2.LinkButton is a GTK2.Button with a hyperlink, similar to the one used by web browsers, which triggers an action when clicked. It is useful to show quick links to resources.
- Method
create
GTK2.LinkButtonGTK2.LinkButton(string|mappinguri_or_props,string|voidlabel)- Description
Creates a new LinkButton.
Class GTK2.ListStore
- Description
A list-like data structure that can be used with W(TreeView).
- Method
create
GTK2.ListStoreGTK2.ListStore(arraytypes)- Description
Create a new list store with as many columns as there are items in the array. A type is either a string representing a type name, such as "int" or "float", or an actual widget. If it is a widget, the column in question should be a widget of the same type that you would like this column to represent.
- Method
insert
GTK2.TreeIterinsert(intposition)- Description
Insert a row at position. If parent is valid, will create as child, otherwise at top level. If position is larger than then number of rows at that level, it will be added to the end of the list. iter will be changed to point to the new row.
- Method
insert_after
GTK2.TreeIterinsert_after(GTK2.TreeItersibling)- Description
Insert a new row after sibling. If sibling is 0, then the row will be prepended to parent's children. If parent and sibling are both 0, then the row will be prepended to the toplevel.
- Method
insert_before
GTK2.TreeIterinsert_before(GTK2.TreeItersibling)- Description
Insert a row before sibling. If sibling is 0, then the row will be appended to parent's children. If parent and sibling are 0, then the row will be appended to the toplevel.
- Method
move_after
GTK2.ListStoremove_after(GTK2.TreeIteriter,GTK2.TreeIterposition)- Description
Moves iter to after position. These should be at the same level. This only works if the store is unsorted. If position is omitted, iter will be moved to the start of the level.
- Method
move_before
GTK2.ListStoremove_before(GTK2.TreeIteriter,GTK2.TreeIterposition)- Description
Moves iter to before position. These should be at the same level. This only works if the store is unsorted. If position is omitted, iter will be moved to the end of the level.
- Method
remove
GTK2.ListStoreremove(GTK2.TreeIteriter)- Description
Remove iter. iter is set to the next valid row at that level, or invalidated if it was the last one.
- Method
set_row
GTK2.ListStoreset_row(GTK2.TreeIteriter,arrayvalues)- Description
Set the data in an entire row.
- Method
set_value
GTK2.ListStoreset_value(GTK2.TreeIteriter,intcolumn,mixedvalue)- Description
Set the data in the cell specified by iter and column.
Class GTK2.Menu
- Description
A GTK2.Menu is a W(MenuShell) that implements a drop down menu consisting of a list of W(MenuItem) objects which can be navigated and activated by the user to perform application functions.
A GTK2.Menu is most commonly dropped down by activating a W(MenuItem) in a W(MenuBar) or popped up by activating a W(MenuItem) in another GTK2.Menu.
A GTK2.Menu can also be popped up by activating a W(OptionMenu). Other composite widgets such as the W(Notebook) can pop up a GTK2.Menu as well.
Applications can display a GTK2.Menu as a popup menu by calling the popup() function. The example below shows how an application can pop up a menu when the 3rd mouse button is pressed.
GTK2.Menu menu = create_menu(); GTK2.Window window = create_window(); window->signal_connect( "button_press_event", lambda(GTK2.Menu m, GTK2.Window w, mapping e ) { if( e->button == 3 ) menu->popup(); }, menu );Properties: int tearoff-state string tearoff-titleChild properties: int bottom-attach int left-attach int right-attach int top-attach
Style properties: int horizontal-offset int vertical-offset int vertical-padding
Signals: move_scroll
- Method
attach
GTK2.Menuattach(GTK2.Widgetchild,intleft_attach,intright_attach,inttop_attach,intbottom_attach)- Description
Adds a new W(MenuItem) to a (table) menu. The number of 'cells' that an item will occupy is specified by left_attach, right_attach, top_attach, and bottom_attach. These each represent the leftmost, rightmost, uppermost and lower column row numbers of the table.
- Method
detach
GTK2.Menudetach()- Description
Detaches the menu from the widget to which it had been attached.
- Method
get_accel_group
GTK2.AccelGroupget_accel_group()- Description
Gets the W(AccelGroup) which holds global accelerators for the menu.
- Method
get_active
GTK2.Widgetget_active()- Description
Returns the selected menu item from the menu. This is used by the W(OptionMenu).
- Method
get_attach_widget
GTK2.Widgetget_attach_widget()- Description
Returns the W(Widget) that the menu is attached to.
- Method
get_for_attach_widget
arrayget_for_attach_widget()- Description
Returns a list of the menus which are attached to this widget.
- Method
reorder_child
GTK2.Menureorder_child(GTK2.Widgetchild,intposition)- Description
Moves a W(MenuItem) to a new position within the GTK2.Menu.
- Method
reposition
GTK2.Menureposition()- Description
Repositions the menu according to its position function.
- Method
set_accel_group
GTK2.Menuset_accel_group(GTK2.AccelGroupaccelerators)- Description
Set the W(AccelGroup) which holds global accelerators for the menu.
- Method
set_accel_path
GTK2.Menuset_accel_path(stringaccel_path)- Description
Sets an accelerator path for this menu.
- Method
set_active
GTK2.Menuset_active(intactivep)- Description
Selects the specified menu item within the menu. This is used by the W(OptionMenu).
- Method
set_screen
GTK2.Menuset_screen(GTK2.GdkScreenscreen)- Description
Sets the screen on which the menu is displayed.
- Method
set_tearoff_state
GTK2.Menuset_tearoff_state(inttorn_off)- Description
Changes the tearoff state of the menu. A menu is normally displayed as a drop down menu which persists as long as the menu is active. It can also be displayed as a tearoff menu which persists until it is closed or reattached.
Class GTK2.MenuBar
- Description
Basically a horizontal W(Menu). The menu image cannot be grabbed automatically, but this is how you would create a menu all in one line. This is not the recommended coding style.
 GTK2.MenuBar()->add(GTK2.MenuItem("Menu")->set_submenu(GTK2.Menu()->add(GTK2.MenuItem("Sub")))->select()->activate())->add(GTK2.MenuItem("Bar"))
Properties: int child-pack-direction int pack-direction
Style properties: int internal-padding int shadow-type
- Method
get_child_pack_direction
intget_child_pack_direction()- Description
Retrieves the current child pack direction.
- Method
get_pack_direction
intget_pack_direction()- Description
Retrieves the current pack direction of the menubar.
- Method
set_child_pack_direction
GTK2.MenuBarset_child_pack_direction(intsetting)- Description
Sets how widgets should be packed inside the children of a menubar.
Class GTK2.MenuItem
- Description
Menu items, to be added to menus. Properties GTK2.Menu submenu
Style properties: int arrow-spacing int horizontal-padding int selected-shadow-type int toggle-spacing
Signals: activate
activate_item
toggle_size_allocate
toggle_size_request
- Method
create
GTK2.MenuItemGTK2.MenuItem(string|mappinglabel_or_props)- Description
If a string is supplied, a W(Label) widget is created using that string and added to the item. Otherwise, you should add another widget to the list item with ->add().
- Method
get_right_justified
intget_right_justified()- Description
Gets whether the menu item appears justified at the right side of the menu bar.
- Method
set_right_justified
GTK2.MenuItemset_right_justified(intsetting)- Description
Make the menu item stick to the right edge of it's container.
- Method
set_submenu
GTK2.MenuItemset_submenu(GTK2.Widgetmenu)- Description
Set the submenu for this menu button.
- Method
toggle_size_allocate
GTK2.MenuItemtoggle_size_allocate(intallocation)- Description
Emits the "toggle-size-allocate" signal on the given item.
Class GTK2.MenuShell
- Description
A GTK2.MenuShell is the abstract base class used to derive the W(Menu) and W(MenuBar) subclasses.
A GTK2.MenuShell is a container of W(MenuItem) objects arranged in a list which can be navigated, selected, and activated by the user to perform application functions. A W(MenuItem) can have a submenu associated with it, allowing for nested hierarchical menus.
Signals: activate_current An action signal that activates the current menu item within the menu shell.
cancel An action signal which cancels the selection within the menu shell. Causes the selection-done signal to be emitted.
cycle_focus
deactivate This signal is emitted when a menu shell is deactivated.
move_current An action signal which moves the current menu item in the direction specified.
move_selected
selection_done This signal is emitted when a selection has been completed within a menu shell.
- Method
activate_item
GTK2.MenuShellactivate_item(GTK2.Widgetmenu_item,intforce_deactivate)- Description
Activates the menu item within the menu shell.
- Method
append
GTK2.MenuShellappend(GTK2.Widgetwhat)- Description
Adds a new W(MenuItem) to the end of the menu shell's item list. Same as 'add'.
- Method
deactivate
GTK2.MenuShelldeactivate()- Description
Deactivates the menu shell. Typically this results in the menu shell being erased from the screen.
- Method
deselect
GTK2.MenuShelldeselect()- Description
Deselects the currently selected item from the menu shell, if any.
- Method
get_children
arrayget_children()- Description
This function returns all children of the menushell as an array.
- Method
get_take_focus
intget_take_focus()- Description
Returns TRUE if the menu shell will take the keyboard focus on popup.
- Method
insert
GTK2.MenuShellinsert(GTK2.Widgetwhat,intwhere)- Description
Add a widget after the specified location
- Method
prepend
GTK2.MenuShellprepend(GTK2.Widgetwhat)- Description
Add a menu item to the start of the widget (for a menu: top, for a bar: left)
- Method
select_first
GTK2.MenuShellselect_first(intsearch_sensitive)- Description
Select the first visible or selectable child of the menu shell; don't select tearoff items unless the only item is a tearoff item.
- Method
select_item
GTK2.MenuShellselect_item(GTK2.Widgetmenuitem)- Description
Selects the menu item from the menu shell.
Class GTK2.MenuToolButton
- Description
Properties to be notified. GTK2.Menu menu
Signals: show_menu
- Method
create
GTK2.MenuToolButtonGTK2.MenuToolButton(GTK2.Widgeticon,string|voidlabel)- Description
Create a new GTK2.MenuToolButton. If icon is a string, label should be omitted. If it isn't, it will be igrnored. The result will be a button from a stock item, one of
STOCK_ABOUT,STOCK_ADD,STOCK_APPLY,STOCK_BOLD,STOCK_CANCEL,STOCK_CDROM,STOCK_CLEAR,STOCK_CLOSE,STOCK_COLOR_PICKER,STOCK_CONNECT,STOCK_CONVERT,STOCK_COPY,STOCK_CUT,STOCK_DELETE,STOCK_DIALOG_AUTHENTICATION,STOCK_DIALOG_ERROR,STOCK_DIALOG_INFO,STOCK_DIALOG_QUESTION,STOCK_DIALOG_WARNING,STOCK_DIRECTORY,STOCK_DISCONNECT,STOCK_DND,STOCK_DND_MULTIPLE,STOCK_EDIT,STOCK_EXECUTE,STOCK_FILE,STOCK_FIND,STOCK_FIND_AND_REPLACE,STOCK_FLOPPY,STOCK_FULLSCREEN,STOCK_GOTO_BOTTOM,STOCK_GOTO_FIRST,STOCK_GOTO_LAST,STOCK_GOTO_TOP,STOCK_GO_BACK,STOCK_GO_DOWN,STOCK_GO_FORWARD,STOCK_GO_UP,STOCK_HARDDISK,STOCK_HELP,STOCK_HOME,STOCK_INDENT,STOCK_INDEX,STOCK_INFO,STOCK_ITALIC,STOCK_JUMP_TO,STOCK_JUSTIFY_CENTER,STOCK_JUSTIFY_FILL,STOCK_JUSTIFY_LEFT,STOCK_JUSTIFY_RIGHT,STOCK_LEAVE_FULLSCREEN,STOCK_MEDIA_FORWARD,STOCK_MEDIA_NEXT,STOCK_MEDIA_PAUSE,STOCK_MEDIA_PLAY,STOCK_MEDIA_PREVIOUS,STOCK_MEDIA_RECORD,STOCK_MEDIA_REWIND,STOCK_MEDIA_STOP,STOCK_MISSING_IMAGE,STOCK_NETWORK,STOCK_NEW,STOCK_NO,STOCK_OK,STOCK_OPEN,STOCK_PASTE,STOCK_PREFERENCES,STOCK_PRINT,STOCK_PRINT_PREVIEW,STOCK_PROPERTIES,STOCK_QUIT,STOCK_REDO,STOCK_REFRESH,STOCK_REMOVE,STOCK_REVERT_TO_SAVED,STOCK_SAVE,STOCK_SAVE_AS,STOCK_SELECT_COLOR,STOCK_SELECT_FONT,STOCK_SORT_ASCENDING,STOCK_SORT_DESCENDING,STOCK_SPELL_CHECK,STOCK_STOP,STOCK_STRIKETHROUGH,STOCK_UNDELETE,STOCK_UNDERLINE,STOCK_UNDO,STOCK_UNINDENT,STOCK_YES,STOCK_ZOOM_100,STOCK_ZOOM_FIT,STOCK_ZOOM_INandSTOCK_ZOOM_OUT. If icon is a GTK2.Widget, it will be used as the icon, and label will be the label. The label must exist if that is the case.
- Method
set_arrow_tooltip
GTK2.MenuToolButtonset_arrow_tooltip(GTK2.Tooltipstooltips,stringtip_text,stringtip_private)- Description
Sets the GTK2.Tooltips object to be used for the arrow button which pops up the menu.
Class GTK2.MessageDialog
- Description
A dialog with an image representing the type of message (Error, Question). alongside some message text. It's simply a convenience widget; you could construct the equivalent of GTK2.MessageDialog from GTK2.Dialog without too much effort, but GTK2.MessageDialog saves typing. Properties: int buttons GTK2.Widget image int message-type string secondary-text
Style properties: int message-border int use-separator
- Method
create
GTK2.MessageDialogGTK2.MessageDialog(mapping|intflags,int|voidtype,int|voidbuttons,string|voidmessage,GTK2.Windowparent)- Description
Creates a new message dialog, which is a simple dialog with an icon indicating the dialog type (error, warning, etc) and some text the user may want to see. When the user clicks a button a "response" signal is emitted with response IDs from
RESPONSE_ACCEPT,RESPONSE_APPLY,RESPONSE_CANCEL,RESPONSE_CLOSE,RESPONSE_DELETE_EVENT,RESPONSE_HELP,RESPONSE_NO,RESPONSE_NONE,RESPONSE_OK,RESPONSE_REJECTandRESPONSE_YES. See GTK2.Dialog for more details.
- Method
format_secondary_markup
GTK2.MessageDialogformat_secondary_markup(stringtext)- Description
Sets the secondary text of the message dialog to be text, which is marked up with the Pango text markup language.
Note tha tsetting a secondary text makes the primary text become bold, unless you have provided explicit markup.
- Method
format_secondary_text
GTK2.MessageDialogformat_secondary_text(stringtext)- Description
Sets the secondary text of the message dialog to be text.
Note that setting a secondary text makes the primary text become bold, unless you have provided explicit markup.
- Method
set_image
GTK2.MessageDialogset_image(GTK2.Widgetimage)- Description
Sets the dialog's image to image.
Class GTK2.Misc
- Description
The GTK2.Misc widget is an abstract widget which is not useful itself, but is used to derive subclasses which have alignment and padding attributes.
The horizontal and vertical padding attributes allows extra space to be added around the widget.
The horizontal and vertical alignment attributes enable the widget to be positioned within its allocated area. Note that if the widget is added to a container in such a way that it expands automatically to fill its allocated area, the alignment settings will not alter the widgets position.
 GTK2.Vbox(0,0)->add(GTK2.Label("Label"))->set_size_request(100,20)
 GTK2.Vbox(0,0)->add(GTK2.Label("Label")->set_alignment(1.0,0.0))->set_size_request(100,20)
 GTK2.Vbox(0,0)->add(GTK2.Label("Label")->set_alignment(0.0,0.0))->set_size_request(100,20)
Properties: float xalign The horizontal alignment, from 0 (left) to 1 (right). int xpad The amount of space to add on the left and right of the widget, in pixels. float yalign The vertical alignment, from 0 (top) to 1 (bottom). int ypad The amount of space to add on the top and bottom of the widget, in pixels.
- Method
set_alignment
GTK2.Miscset_alignment(floatxalign,floatyalign)- Description
Sets the alignment of the widget. 0.0 is left or topmost, 1.0 is right or bottommost.
Class GTK2.Notebook
- Description
The NoteBook Widget is a collection of 'pages' that overlap each other, each page contains different information. This widget has become more common lately in GUI programming, and it is a good way to show blocks similar information that warrant separation in their display.
 GTK2.Notebook()->set_tab_pos(GTK2.POS_LEFT)->append_page(GTK2.Label("Page 1\nContents"),GTK2.Label("Page 1"))->append_page(GTK2.Label(""),GTK2.Label("Page 2"))->append_page(GTK2.Label("Page 3 contents\nare here!"),GTK2.Label("Page 3"))
 GTK2.Notebook()->set_tab_pos(GTK2.POS_TOP)->append_page(GTK2.Label("Page 1\nContents"),GTK2.Label("Page 1"))->append_page(GTK2.Label(""),GTK2.Label("Page 2"))->append_page(GTK2.Label("Page 3 contents\nare here!"),GTK2.Label("Page 3"))
 GTK2.Notebook()->set_tab_pos(GTK2.POS_RIGHT)->append_page(GTK2.Label("Page 1\nContents"),GTK2.Label("Page 1"))->append_page(GTK2.Label(""),GTK2.Label("Page 2"))->append_page(GTK2.Label("Page 3 contents\nare here!"),GTK2.Label("Page 3"))->next_page()->next_page()
Properties: int enable-popup int homogeneous int page int scrollable int show-border int show-tabs int tab-border int tab-hborder int tab-pos int tab-vborder
Child properties: string menu-label int position int tab-expand int tab-fill string tab-label int tab-pack
Style properties: int has-backward-stepper int has-forward-stepper int has-secondary-backward-stepper int has-secondary-forward-stepper int tab-curvature int tab-overlap
Signals: change_current_page
focus_tab
move_focus_out
select_page
switch_page Called when a different page is selected
- Method
append_page
GTK2.Notebookappend_page(GTK2.Widgetcontents,GTK2.Widgetlabel)- Description
Add a new 'page' to the notebook. The first argument is the contents of the page, the second argument is the label.
- Method
append_page_menu
GTK2.Notebookappend_page_menu(GTK2.Widgetcontents,GTK2.Widgetlabel,GTK2.Widgetmenu)- Description
Add a new 'page' to the notebook. The first argument is the contents of the page, the second argument is the label, the third argument is a menu label widget.
- Method
create
GTK2.NotebookGTK2.Notebook(mapping|voidprops)- Description
Create a W(Notebook) widget with no pages.
- Method
get_current_page
intget_current_page()- Description
Returns the index of the currently selected page
- Method
get_menu_label
GTK2.Widgetget_menu_label(GTK2.Widgetpage)- Description
Return the menu label widget.
- Method
get_menu_label_text
stringget_menu_label_text(GTK2.Widgetchild)- Description
Retrieves the text of the menu label for the page containing child.
- Method
get_nth_page
GTK2.Widgetget_nth_page(intindex)- Description
Returns the page for the specified index
- Method
get_scrollable
intget_scrollable()- Description
Returns whether the tab label area has arrows for scrolling.
- Method
get_show_border
intget_show_border()- Description
Returns whether a bevel will be drawn around the pages.
- Method
get_show_tabs
intget_show_tabs()- Description
Returns whether the tabs of the notebook are shown.
- Method
get_tab_detachable
intget_tab_detachable(GTK2.Widgetchild)- Description
Returns whether the tab contents can be detached.
- Method
get_tab_label
GTK2.Widgetget_tab_label(GTK2.Widgetpage)- Description
Returns the tab label widget.
- Method
get_tab_label_text
stringget_tab_label_text(GTK2.Widgetchild)- Description
Retrieves the text of the tab label for the page containing child.
- Method
get_tab_reorderable
intget_tab_reorderable(GTK2.Widgetchild)- Description
Gets whether the tab can be reordered via drag and drop or not.
- Method
insert_page
GTK2.Notebookinsert_page(GTK2.Widgetcontents,GTK2.Widgetlabel,intpos)- Description
Insert a page at the specified location, arguments as for append_page, but an aditional integer specifies the location.
- Method
insert_page_menu
GTK2.Notebookinsert_page_menu(GTK2.Widgetcontents,GTK2.Widgetlabel,GTK2.Widgetmenu,intpos)- Description
Insert a page at the specified location, arguments as for append_page_menu, but an additional integer specifies the location.
- Method
popup_disable
GTK2.Notebookpopup_disable()- Description
Disable the popup menu (set with insert_page_menu).
- Method
popup_enable
GTK2.Notebookpopup_enable()- Description
Enable the popup menu (set with insert_page_menu).
- Method
prepend_page
GTK2.Notebookprepend_page(GTK2.Widgetcontents,GTK2.Widgetlabel)- Description
Add a page at the end of the list of pages. The first argument is the contents of the page, the second argument is the label.
- Method
prepend_page_menu
GTK2.Notebookprepend_page_menu(GTK2.Widgetcontents,GTK2.Widgetlabel,GTK2.Widgetmenu)- Description
Add a new 'page' at the end of the list of pages. The first argument is the contents of the page, the second argument is the label, the third argument is a menu label widget.
- Method
query_tab_label_packing
mappingquery_tab_label_packing(GTK2.Widgetpage)- Description
Returns ([ "expand":expandp, "fill":fillp, "pack_type":type ])
- Method
reorder_child
GTK2.Notebookreorder_child(GTK2.Widgetchild,intposition)- Description
Reorders the page containing child, so that it appears at position.
- Method
set_group_id
GTK2.Notebookset_group_id(intid)- Description
Sets an group identifier for notebook; notebooks sharing the same group identifier will be able to exchange tabs via drag and drop. A notebook with group identifier -1 will not be able to exchange tabs with any other notebook.
- Method
set_menu_label
GTK2.Notebookset_menu_label(GTK2.Widgetchild,GTK2.Widgetlabel)- Description
Changes the menu label for the page containing child.
- Method
set_menu_label_text
GTK2.Notebookset_menu_label_text(GTK2.Widgetchild,stringlabel_text)- Description
Creates a new label with label_text sets it as the menu label.
- Method
set_scrollable
GTK2.Notebookset_scrollable(intscrollablep)- Description
If true, add scrollbars if necessary.
- Method
set_show_border
GTK2.Notebookset_show_border(intshowborderp)- Description
If true, show the borders around the contents and tabs.
- Method
set_show_tabs
GTK2.Notebookset_show_tabs(intshowtabsp)- Description
If supplied with a true value, the tabs will be shown. Otherwise they will not be shown. The user will not be able to select the pages without them, but you can add 'next' and 'previous' buttons to create a wizard-line interface.
- Method
set_tab_label
GTK2.Notebookset_tab_label(GTK2.Widgetchild,GTK2.Widgetlabel)- Description
Changes the tab label for child.
- Method
set_tab_label_packing
GTK2.Notebookset_tab_label_packing(GTK2.Widgetchild,intexpand,intfill,inttype)- Description
Sets the packing parameters for the tab label of the page child.
- Method
set_tab_label_text
GTK2.Notebookset_tab_label_text(GTK2.Widgetchild,stringtitle)- Description
Creates a new label and sets it as the tab label for the page containing child.
Class GTK2.Object
- Description
The basic GTK class. All other GTK classes inherit this class. The only user-callable functions are the signal related ones. Properties: gpointer user-data
Signals: destroy
Class GTK2.PageSetup
- Description
A GtkPageSetup object stores the page size, orientation and margins. The idea is that you can get one of these from the page setup dialog and then pass it to the GTK2.PrintOperation when printing. The benefit of splitting this out of the GTK2.PrintSettings is that these affect the actual layout of the page, and thus need to be set long before user prints.
- Method
get_bottom_margin
floatget_bottom_margin(intunit)- Description
Gets the bottom margin in units of unit.
- Method
get_left_margin
floatget_left_margin(intunit)- Description
Gets the left margin in units of unit.
- Method
get_page_height
floatget_page_height(intunit)- Description
Returns the page height in units of unit.
- Method
get_page_width
floatget_page_width(intunit)- Description
Returns the page width in units of unit.
- Method
get_paper_height
floatget_paper_height(intunit)- Description
Returns the paper height in units of unit.
- Method
get_paper_width
floatget_paper_width(intunit)- Description
Returns the paper width in units of unit.
- Method
get_right_margin
floatget_right_margin(intunit)- Description
Gets the right margin in units of unit.
- Method
set_bottom_margin
GTK2.PageSetupset_bottom_margin(floatmargin,intunit)- Description
Sets the bottom margin.
- Method
set_left_margin
GTK2.PageSetupset_left_margin(floatmargin,intunit)- Description
Sets the left margin.
- Method
set_orientation
GTK2.PageSetupset_orientation(intorientation)- Description
Sets the page orientation.
- Method
set_paper_size
GTK2.PageSetupset_paper_size(GTK2.PaperSizesize)- Description
Sets the paper size without changing the margins.
- Method
set_paper_size_and_default_margins
GTK2.PageSetupset_paper_size_and_default_margins(GTK2.PaperSizesize)- Description
Sets the paper size and modifies the margins.
- Method
set_right_margin
GTK2.PageSetupset_right_margin(floatmargin,intunit)- Description
Sets the right margin.
Class GTK2.Paned
- Description
GTK2.Paned is the base class for widgets with two panes, arranged either horizontally (W(HPaned)) or vertically (W(VPaned)). Child widgets are added to the panes of the widget with pack1() and pack2(). The division beween the two children is set by default from the size requests of the children, but it can be adjusted by the user.
A paned widget draws a separator between the two child widgets and a small handle that the user can drag to adjust the division. It does not draw any relief around the children or around the separator. (The space in which the separator is called the gutter). Often, it is useful to put each child inside a W(Frame) with the shadow type set to GTK2.ShadowIn so that the gutter appears as a ridge.
Each child has two options that can be set, resize and shrink. If resize is true, then when the GTK2.Paned is resized, that child will expand or shrink along with the paned widget. If shrink is true, then when that child can be made smaller than it's requisition by the user. Setting shrink to 0 allows the application to set a minimum size. If resize is false for both children, then this is treated as if resize is true for both children.
The application can set the position of the slider as if it were set by the user, by calling set_position().
Properties: int max-position int min-position int position int position-set
Child properties: int resize int shrink
Style properties: int handle-size
Signals: accept_position
cancel_position
cycle_child_focus
cycle_handle_focus
move_handle
toggle_handle_focus
- Method
add1
GTK2.Panedadd1(GTK2.Widgetleft_or_top)- Description
Set the left or topmost item. This is equivalent to pack1(left_or_top,0,1)
- Method
add2
GTK2.Panedadd2(GTK2.Widgetright_or_bottom)- Description
Set the right or bottommost item This is equivalent to pack2(left_or_top,0,1)
- Method
get_position
intget_position()- Description
Obtains the position of the divider between the two panes.
- Method
pack1
GTK2.Panedpack1(GTK2.Widgetwidget,intresize,intshrink)- Description
Add a child to the top or left pane.
- Method
pack2
GTK2.Panedpack2(GTK2.Widgetwidget,intresize,intshrink)- Description
Add a child to the bottom or right pane.
Class GTK2.PaperSize
- Description
A Paper Size.
- Method
create
GTK2.PaperSizeGTK2.PaperSize(string|voidname,string|voidppd_display_name,float|voidwidth,float|voidheight,int|voidunit)- Description
Create a new GTK2.PaperSize object by parsing a PWG 5101.1-2002 PWG paper name.
- Method
get_default_bottom_margin
floatget_default_bottom_margin(intunit)- Description
Gets the default bottom margin.
- Method
get_default_left_margin
floatget_default_left_margin(intunit)- Description
Gets the default left margin.
- Method
get_default_right_margin
floatget_default_right_margin(intunit)- Description
Gets the default right margin.
- Method
get_default_top_margin
floatget_default_top_margin(intunit)- Description
Gets the default top margin.
Class GTK2.PatternTag
Class GTK2.Plug
- Description
Together with W(Socket), GTK2.Plug provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a W(Socket) widget and, passes the XID of that widgets window to the other process, which then creates a GTK2.Plug window with that XID. Any widgets contained in the GTK2.Plug then will appear inside the first applications window. Properties int embedded
Signals: embedded
- Method
create
GTK2.PlugGTK2.Plug(int|mappingsocket_id_or_props)- Description
Create a new plug, the socket_id is the window into which this plug will be plugged.
Class GTK2.PrintContext
- Method
create_pango_context
GTK2.Pango.Contextcreate_pango_context()- Description
Creates a new Pango.Context that can be used with this PrintContext.
- Method
create_pango_layout
GTK2.Pango.Layoutcreate_pango_layout()- Description
Creates a new Pango.Layout that is suitable for use with this PrintContext.
- Method
get_page_setup
GTK2.PageSetupget_page_setup()- Description
Obtains the GTK2.PageSetup that determines the page dimensions.
- Method
create_pango_context
Class GTK2.Progress
- Description
Properties: int activity-mode int show-text float text-xalign float text-yalign
Class GTK2.ProgressBar
- Description
A simple progress bar. Useful when you are doing things that take a long time. Try to always have an 'abort' button whenever it makes sence.
 GTK2.ProgressBar()->set_fraction(0.1)
 GTK2.ProgressBar()->set_property("show_text", 1)->set_fraction(0.3)
 GTK2.ProgressBar()->set_fraction(0.6)
 GTK2.ProgressBar()->set_fraction(1.0)
Properties: int discrete-blocks int ellipsize
PANGO_ELLIPSIZE_END,PANGO_ELLIPSIZE_MIDDLE,PANGO_ELLIPSIZE_NONEandPANGO_ELLIPSIZE_STARTfloat fraction int orientationPROGRESS_BOTTOM_TO_TOP,PROGRESS_CONTINUOUS,PROGRESS_DISCRETE,PROGRESS_LEFT_TO_RIGHT,PROGRESS_RIGHT_TO_LEFTandPROGRESS_TOP_TO_BOTTOMfloat pulse-step string text
- Method
create
GTK2.ProgressBarGTK2.ProgressBar(mapping|voidprops)- Description
Create a new progress bar. The default values are: Min 0.0, max 1.0, current 0.0
- Method
get_ellipsize
intget_ellipsize()- Description
Returns the ellipsizing position of the progressbar.
- Method
get_fraction
floatget_fraction()- Description
Returns the current fraction of the task that's been completed.
- Method
get_orientation
intget_orientation()- Description
Retrieves the current progress bar orientation.
- Method
get_text
stringget_text()- Description
Retrieves the text displayed superimposed on the progress bar, if any.
- Method
pulse
GTK2.ProgressBarpulse()- Description
Indicates that some progress is made, but you don't know how much. Causes the progress bar to enter "activity mode", where a block bounces back and forth. Each call to pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by set_pulse_step()).
- Method
set_ellipsize
GTK2.ProgressBarset_ellipsize(intmode)- Description
Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string. One of
PANGO_ELLIPSIZE_END,PANGO_ELLIPSIZE_MIDDLE,PANGO_ELLIPSIZE_NONEandPANGO_ELLIPSIZE_START.
- Method
set_fraction
GTK2.ProgressBarset_fraction(floatfraction)- Description
Causes the progress bar to "fill in" the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.
- Method
set_orientation
GTK2.ProgressBarset_orientation(intstyle)- Description
Causes the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top). One of
PROGRESS_BOTTOM_TO_TOP,PROGRESS_CONTINUOUS,PROGRESS_DISCRETE,PROGRESS_LEFT_TO_RIGHT,PROGRESS_RIGHT_TO_LEFTandPROGRESS_TOP_TO_BOTTOM.
- Method
set_pulse_step
GTK2.ProgressBarset_pulse_step(floatfraction)- Description
Sets the fraction of total progress bar length to move the bouncing block for each call to pulse().
Class GTK2.RadioAction
- Description
Properties int current-value GTK2.RadioAction group int value
Signals: changed
- Method
create
GTK2.RadioActionGTK2.RadioAction(string|mappingname_or_props,string|voidlabel,string|voidtooltip,string|voidstock_id,int|voidvalue)- Description
Creates a new GTK2.ToggleAction object.
- Method
get_current_value
intget_current_value()- Description
Obtains the value property of the currently active member.
- Method
set_current_value
GTK2.RadioActionset_current_value(intvalue)- Description
Sets the currently active group member to the member with value property value.
Class GTK2.RadioButton
- Description
Radio buttons are similar to check buttons except they are grouped so that only one may be selected/depressed at a time. This is good for places in your application where you need to select from a short list of options. To connect the buttons, use another button in the desired group as the second argument to GTK2.RadioButton().
 GTK2.RadioButton("Button");
Properties: GTK2.RadioButton group
Signals: group_changed
- Method
create
GTK2.RadioButtonGTK2.RadioButton(string|mappingtitle,GTK2.RadioButtongroupmember,int|voidmnemonic)- Description
Normal creation: object GTK2.RadioButton(string title) - First button (with label) object GTK2.RadioButton()->add(widget) - First button (with widget) object GTK2.RadioButton(title, another_radio_button) - Second to n:th button (with title) object GTK2.RadioButton(0,another_radio_button)->add(widget) - Second to n:th button (with widget)
- Method
set_group
GTK2.RadioButtonset_group(GTK2.RadioButtongroupmember)- Description
the argument is another radio button to whose group this button should be added to. It is prefereable to use the second argument to the constructor instead, but if you for some reason want to move the button to another group, use this function.
Class GTK2.RadioMenuItem
- Description
Exactly like W(RadioButton), but it is an menu item.
 GTK2.RadioMenuItem("Menu item")
Properties:
GTK2.RadioMenuItem group
Signals: group_changed
- Method
create
GTK2.RadioMenuItemGTK2.RadioMenuItem(string|mappingtitle,GTK2.RadioMenuItemgroupmember)- Description
object GTK2.RadioMenuItem(string title) - First button (with label) object GTK2.RadioMenuItem()->add(widget) - First button (with widget) object GTK2.RadioMenuItem(title, another_radio_button) - Second to n:th button (with title) object GTK2.RadioMenuItem(0,another_radio_button)->add(widget) - Second to n:th button (with widget)
- Method
set_group
GTK2.RadioMenuItemset_group(GTK2.RadioMenuItemgroupmember)- Description
The argument is another radio menu item to whose group this button should be added to. It is prefereable to use the second argument to the constructor instead, but if you for some reason want to move the button to another group, use this function.
Class GTK2.RadioToolButton
- Description
Properties: GTK2.RadioToolButton group
- Method
create
GTK2.RadioToolButtonGTK2.RadioToolButton(GTK2.RadioToolButtongroupmember)- Description
Create a GTK2.RadioToolButton. Use without a parameter for a new group. Use with another GTK2.RadioToolButton to add another button to the same group as a previous button.
Class GTK2.Range
- Description
The category of range widgets includes the ubiquitous scrollbar widget and the less common "scale" widget. Though these two types of widgets are generally used for different purposes, they are quite similar in function and implementation. All range widgets share a set of common graphic elements, each of which has its own X window and receives events. They all contain a "trough" and a "slider" (what is sometimes called a "thumbwheel" in other GUI environments). Dragging the slider with the pointer moves it back and forth within the trough, while clicking in the trough advances the slider towards the location of the click, either completely, or by a designated amount, depending on which mouse button is used.
As mentioned in the W(Adjustment) page, all range widgets are associated with an adjustment object, from which they calculate the length of the slider and its position within the trough. When the user manipulates the slider, the range widget will change the value of the adjustment.
All of the GTK range widgets react to mouse clicks in more or less the same way. Clicking button-1 in the trough will cause its adjustment's page_increment to be added or subtracted from its value, and the slider to be moved accordingly. Clicking mouse button-2 in the trough will jump the slider to the point at which the button was clicked. Clicking any button on a scrollbar's arrows will cause its adjustment's value to change step_increment at a time.
It may take a little while to get used to, but by default, scrollbars as well as scale widgets can take the keyboard focus in GTK. If you think your users will find this too confusing, you can always disable this by unsetting the GTK2.CanFocus flag on the scrollbar, like this:
scrollbar->unset_flag(GTK2.CanFocus);
The key bindings (which are, of course, only active when the widget has focus) are slightly different between horizontal and vertical range widgets, for obvious reasons. They are also not quite the same for scale widgets as they are for scrollbars, for somewhat less obvious reasons (possibly to avoid confusion between the keys for horizontal and vertical scrollbars in scrolled windows, where both operate on the same area).
Properties: GTK2.Adjustment adjustment float fill-level int inverted int restrict-to-fill-level int show-fill-level int update-policy
Style properties: int arrow-displacement-x int arrow-displacement-y int slider-width int stepper-size int stepper-spacing int trough-border int trough-side-details int trough-under-steppers
Signals: adjust_bounds
change_value
move_slider
value_changed
- Method
get_adjustment
GTK2.Adjustmentget_adjustment()- Description
Gets the W(Adjustment) which is the "model" object for W(Range).
- Method
get_fill_level
floatget_fill_level()- Description
Gets the current position of the fill level indicator.
- Method
get_lower_stepper_sensitivity
GTK2.Rangeget_lower_stepper_sensitivity()- Description
Gets the sensitivity policy for the stepper that points to the 'lower' end of the GTK2.Range's adjustment.
- Method
get_restrict_to_fill_level
intget_restrict_to_fill_level()- Description
Gets whether the range is restricted to the fill level.
- Method
get_show_fill_level
intget_show_fill_level()- Description
Gets whether the range displays the fill level graphically.
- Method
get_upper_stepper_sensitivity
GTK2.Rangeget_upper_stepper_sensitivity()- Description
Gets the sensitivity policy for the stepper that points to the 'upper' end of the GTK2.Range's adjustment.
- Method
set_adjustment
GTK2.Rangeset_adjustment(GTK2.Adjustmentpos)- Description
set_adjustment() does absolutely nothing if you pass it the adjustment that range is already using, regardless of whether you changed any of its fields or not. If you pass it a new Adjustment, it will unreference the old one if it exists (possibly destroying it), connect the appropriate signals to the new one, and call the private function gtk_range_adjustment_changed(), which will (or at least, is supposed to...) recalculate the size and/or position of the slider and redraw if necessary.
- Method
set_fill_level
GTK2.Rangeset_fill_level(floatfill)- Description
Set the new position of the fill level indicator.
- Method
set_increments
GTK2.Rangeset_increments(floatstep,floatpage)- Description
Sets the step and page sizes. The step size is used when the user clicks the W(Scrollbar) arrows or moves W(Scale) via arrow keys. The page size is used for example when moving via Page Up or Page Down keys.
- Method
set_inverted
GTK2.Rangeset_inverted(intsetting)- Description
Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right. Inverted ranges have higher values at the top or on the right rather than on the bottom or left.
- Method
set_lower_stepper_sensitivity
GTK2.Rangeset_lower_stepper_sensitivity(intsensitivity)- Description
Sets the sensitivity policy for the stepper that points to the 'lower' end of the GTK2.Range's adjustment.
- Method
set_range
GTK2.Rangeset_range(floatmin,floatmax)- Description
Sets the allowable values, and clamps the range value to be between min and max.
- Method
set_restrict_to_fill_level
GTK2.Rangeset_restrict_to_fill_level(intrest)- Description
Sets whether the slider is restricted to the fill level
- Method
set_show_fill_level
GTK2.Rangeset_show_fill_level(intshow)- Description
Sets whether a graphical fill level is show on the trough.
- Method
set_update_policy
GTK2.Rangeset_update_policy(intwhen)- Description
The "update policy" of a range widget defines at what points during user interaction it will change the value field of its Adjustment and emit the "value_changed" signal on this Adjustment. The update policies are:
- GTK2.UpdatePolicyContinuous
This is the default. The "value_changed" signal is emitted continuously, i.e., whenever the slider is moved by even the tiniest amount.
- GTK2.UpdatePolicyDiscontinuous
The "value_changed" signal is only emitted once the slider has stopped moving and the user has released the mouse button.
- GTK2.UpdatePolicyDelayed
The "value_changed" signal is emitted when the user releases the mouse button, or if the slider stops moving for a short period of time.
- Method
set_upper_stepper_sensitivity
GTK2.Rangeset_upper_stepper_sensitivity(intsensitivity)- Description
Sets the sensitivity policy for the stepper that points to the 'upper' end of the GTK2.Range's adjustment.
Class GTK2.RcStyle
- Description
RC settings.
Class GTK2.RecentChooser
- Method
add_filter
GTK2.RecentChooseradd_filter(GTK2.RecentFilterfilter)- Description
Adds filter to the list of GTK2.RecentFilter objects held by chooser.
- Method
get_current_item
GTK2.RecentInfoget_current_item()- Description
Gets the GTK2.RecentInfo currently selected.
- Method
get_items
arrayget_items()- Description
Gets the list of recently used resources in form of GTK2.RecentInfo objects.
The return value of this function is affected by the "sort-type" and "limit" properties of chooser
- Method
get_limit
intget_limit()- Description
Gets the number of items returned by get_items() and get_uris().
- Method
get_local_only
intget_local_only()- Description
Gets whether only local resources should be shown in the recently used resources selector.
- Method
get_select_multiple
intget_select_multiple()- Description
Gets whether chooser can select multiple items.
- Method
get_show_icons
intget_show_icons()- Description
Retrieves whether chooser should show an icon near the resource.
- Method
get_show_not_found
intget_show_not_found()- Description
Retrieves whether chooser should show the recently used resources that were not found.
- Method
get_show_numbers
intget_show_numbers()- Description
Returns whether chooser should display recently used resources prepended by a unique number.
- Method
get_show_private
intget_show_private()- Description
Returns whether chooser should display recently used resources registered as private.
- Method
get_uris
arrayget_uris()- Description
Gets the URI of the recently used resources.
The return value of this function is affected by the "sort-type" and "limit" properties.
- Method
remove_filter
GTK2.RecentChooserremove_filter(GTK2.RecentFilterfilter)- Description
Removes filter.
- Method
select_all
GTK2.RecentChooserselect_all()- Description
Selects all the items inside chooser, if the chooser supports multiple selection.
- Method
set_filter
GTK2.RecentChooserset_filter(GTK2.RecentFilterfilter)- Description
Sets filter as the current GTK2.RecentFilter object to affect the displayed recently used resources.
- Method
set_limit
GTK2.RecentChooserset_limit(intlimit)- Description
Sets the number of items that should be returned by get_items() and get_uris().
- Method
set_local_only
GTK2.RecentChooserset_local_only(intlocal_only)- Description
Sets whether only local resources, that is resources using the file:// URI scheme, should be shown in the recently used resources selector. If local_only is TRUE (the default) then the shown resources are guaranteed to be accessible through the operating system native file system.
- Method
set_select_multiple
GTK2.RecentChooserset_select_multiple(intselect_multiple)- Description
Sets whether chooser can select multiple items.
- Method
set_show_icons
GTK2.RecentChooserset_show_icons(intshow_icons)- Description
Sets whether chooser should show an icon near the resource when displaying it.
- Method
set_show_not_found
GTK2.RecentChooserset_show_not_found(intshow_not_found)- Description
Sets whether chooser should display the recently used resources that it didn't find. This only applies to local resources.
- Method
set_show_numbers
GTK2.RecentChooserset_show_numbers(intshow_numbers)- Description
Whether to show recently used resources prepended by a unique number.
- Method
set_show_private
GTK2.RecentChooserset_show_private(intshow_private)- Description
Whether to show recently used resources marked registered as private.
- Method
set_show_tips
GTK2.RecentChooserset_show_tips(intshow_tips)- Description
Sets whether to show a tooltips on the widget.
- Method
set_sort_type
GTK2.RecentChooserset_sort_type(intsort_type)- Description
Changes the sorting order of the recently used resources list displayed by chooser.
- Method
add_filter
Class GTK2.RecentChooserDialog
Class GTK2.RecentChooserMenu
- Method
create
GTK2.RecentChooserMenuGTK2.RecentChooserMenu(mapping|RecentManagerprops)- Description
Create a new GTK2.RecentChooserMenu.
- Method
set_show_numbers
GTK2.RecentChooserMenuset_show_numbers(intshow_numbers)- Description
Sets whether a number should be added to the items of menu. The numbers are shown to provide a unique character for a mnemonic to be used inside the menu item's label. Only the first items get a number to avoid clashes.
- Method
create
Class GTK2.RecentChooserWidget
Class GTK2.RecentFilter
- Description
A filter for selecting a subset of recently used files.
- Method
add_age
GTK2.RecentFilteradd_age(intdays)- Description
Adds a rule that allows resources based on their age - that is, the number of days elapsed since they were last modified.
- Method
add_application
GTK2.RecentFilteradd_application(stringapplication)- Description
Adds a rule that allows resources based on the name of the application that has registered them.
- Method
add_group
GTK2.RecentFilteradd_group(stringgroup)- Description
Adds a rule that allows resources based on the name of the group to which they belong.
- Method
add_mime_type
GTK2.RecentFilteradd_mime_type(stringmime_type)- Description
Adds a rule that allows resources based on their registered MIME type.
- Method
add_pattern
GTK2.RecentFilteradd_pattern(stringpattern)- Description
Adds a rule that allows resources based on a pattern matching their display name.
- Method
add_pixbuf_formats
GTK2.RecentFilteradd_pixbuf_formats()- Description
Adds a rule allowing image files in the formats supported by GdkPixbuf.
- Method
create
GTK2.RecentFilterGTK2.RecentFilter(mapping|voidprops)- Description
Create a new GTK2.RecentFilter.
Class GTK2.RecentInfo
- Method
exists
intexists()- Description
Checks whether the resource pointed by info still exists. At the moment this check is done only on resources pointing to local files.
- Method
get_added
intget_added()- Description
Gets the timestamp (seconds from system's Epoch) when the resource was added to the recently used resources list.
- Method
get_age
intget_age()- Description
Gets the number of days elapsed since the last update of the resource pointed by info.
- Method
get_description
stringget_description()- Description
Gets the (short) description of the resource. Gets the (short) description of the resource.
- Method
get_display_name
stringget_display_name()- Description
Gets the name of the resource. If none has been defined, the basename of the resource is obtained.
- Method
get_groups
arrayget_groups()- Description
Returns all groups registered for the recently used item.
- Method
get_icon
GTK2.GdkPixbufget_icon(intsize)- Description
Retrieves the icon of size size associated to the resource MIME type.
- Method
get_modified
intget_modified()- Description
Gets the timestamp (seconds from system's Epoch) when the resource was last modified.
- Method
get_private_hint
intget_private_hint()- Description
Gets the value of the "private" flag. Resources in the recently used list that have this flag set to TRUE should only be displayed by the applications that have registered them.
- Method
get_short_name
stringget_short_name()- Description
Computes a string that can be used as the name of the item in a menu or list. For example, calling this function on an item that refers to "file:///foo/bar.txt" will yield "bar.txt".
- Method
get_uri_display
stringget_uri_display()- Description
Gets a displayable version of the resource's URI.
- Method
get_visited
intget_visited()- Description
Gets the timestamp (seconds from system's Epoch) when the resource was last visited.
- Method
has_application
inthas_application()- Description
Checks whether an application registered this resource using app_name.
- Method
has_group
inthas_group(stringgroup_name)- Description
Checks whether group_name appears inside the groups registered for the recently used item info.
- Method
is_local
intis_local()- Description
Checks whether the resource is local or not by looking at the scheme of its URI.
- Method
last_application
stringlast_application()- Description
Gets the name of the last application that have registered the recently used resource represented by info.
- Method
exists
Class GTK2.RecentManager
- Method
add_item
intadd_item(stringuri)- Description
Adds a new resource, pointed by uri, into the recently used resources list.
- Method
create
GTK2.RecentManagerGTK2.RecentManager(mapping|int|GdkScreenprops_or_def)- Description
Create a new GTK2.RecentManager.
- Method
get_limit
intget_limit()- Description
Gets the maximum number of items that the get_items() function should return.
- Method
has_item
inthas_item(stringuri)- Description
Checks whether there is a recently used resource registered with uri inside the recent manager.
- Method
lookup_item
mappinglookup_item(stringuri)- Description
Searches for a URI inside the recently used resources list, and returns a structure containing information about the resource like its MIME type, or its display name.
- Method
move_item
intmove_item(stringuri,stringnew_uri)- Description
Changes the location of a recently used resource from uri to new_uri.
- Method
purge_items
intpurge_items()- Description
Purges every item from the recently used resources list.
- Method
remove_item
intremove_item(stringuri)- Description
Removes a resource pointed by uri from the recently used resources list handled by a recent manager.
- Method
set_limit
GTK2.RecentManagerset_limit(intlimit)- Description
Sets the maximum number of item that the get_items() function should return. If limit is set to -1, then return all the items.
- Method
add_item
Class GTK2.Scale
- Description
The GTK2.Scale widget is an abstract class, used only for deriving the subclasses GTK2.Hscale and GTK2.Vscale.
See W(Range) for generic range documentation
Properties: int digits int draw-value int value-pos
Style properties: int slider-length int value-spacing
Signals: format_value
- Method
clear_marks
GTK2.Scaleclear_marks()- Description
Removes any marks that have been added with add_mark().
- Method
get_draw_value
intget_draw_value()- Description
Returns whether the current value is displayed as a string next to the slider.
- Method
get_layout
GTK2.Pango.Layoutget_layout()- Description
Gets the Pango.Layout used to display the scale.
- Method
get_layout_offsets
mappingget_layout_offsets()- Description
Obtains the coordinates where the scale will draw the Pango.Layout representing the text in the scale. Remember when using the Pango.Layout function you need to convert to and from pixels using PANGO_SCALE.
- Method
get_value_pos
intget_value_pos()- Description
Gets the position in which the current value is displayed.
- Method
set_digits
GTK2.Scaleset_digits(intprecision)- Description
Sets the number of decimal places that are displayed in the value.
- Method
set_draw_value
GTK2.Scaleset_draw_value(intdrawp)- Description
Specifies whether the current value is displayed as a string next to the slider.
Class GTK2.ScaleButton
- Description
Properties: GTK2.Adjustment adjustment string icons int size float value
Signals: popdown
popup
value_changed Scale button
- Method
create
GTK2.ScaleButtonGTK2.ScaleButton(int|voidsize_or_props,float|voidmin,float|voidmax,float|voidstep,array|voidicons)- Description
Create a new W(ScaleButton).
- Method
get_adjustment
GTK2.Adjustmentget_adjustment()- Description
Returns the GTK2.Adjustment associated with this scale.
- Method
set_adjustment
GTK2.ScaleButtonset_adjustment(GTK2.Adjustmentadj)- Description
Sets the GTK2.Adjustment to be used as a model.
Class GTK2.Scrollbar
- Description
These are your standard, run-of-the-mill scrollbars. These should be used only for scrolling some other widget, such as a list, a text box, or a viewport (and it's generally easier to use the scrolled window widget in most cases). For other purposes, you should use scale widgets, as they are friendlier and more featureful. Style properties: int fixed-slider-length int has-backward-stepper int has-forward-stepper int has-secondary-backward-stepper int has-secondary-forward-stepper int min-slider-length
Class GTK2.ScrolledWindow
- Description
Scrolled windows are used to create a scrollable area with another widget inside it. You may insert any type of widget into a scrolled window, and it will be accessible regardless of its size by using the scrollbars.
 GTK2.ScrolledWindow(GTK2.Adjustment(),GTK2.Adjustment())->add(GTK2.Label("A small label"))->set_policy(GTK2.POLICY_AUTOMATIC,GTK2.POLICY_AUTOMATIC)
 GTK2.ScrolledWindow(GTK2.Adjustment(),GTK2.Adjustment())->add(GTK2.Label("A small label"))->set_policy(GTK2.POLICY_AUTOMATIC,GTK2.POLICY_AUTOMATIC)
 GTK2.ScrolledWindow(GTK2.Adjustment(),GTK2.Adjustment())->add(GTK2.Label("A small label"))
 GTK2.ScrolledWindow(GTK2.Adjustment(),GTK2.Adjustment())->add(GTK2.Label("a very huge label"))
Properties: GTK2.Adjustment hadjustment int hscrollbar-policy int shadow-type GTK2.Adjustment vadjustment int vscrollbar-policy int window-placement
Style properties: int scrollbar-spacing int scrollbars-within-bevel
Signals: move_focus_out
scroll_child
- Method
add
GTK2.ScrolledWindowadd(GTK2.Widgetvictim)- Description
Add a widget to this container. This is equivalent to the C-GTK function gtk_scrolled_window_add_with_viewport or gtk_container_add, depending on whether or not the child supports the set_scroll_adjustments signal.
What this means in practice is that you do not have to care about this at all, it's all handled automatically.
- Method
create
GTK2.ScrolledWindowGTK2.ScrolledWindow(GTK2.Adjustmenthadjustment_or_props,GTK2.Adjustmentvadjustments)- Description
The two adjustments are most commonly set to 0.
- Method
get_policy
mappingget_policy()- Description
Returns the current policy values for the horizontal and vertical scrollbars. ([ "h-policy": horizontal policy, "v-policy": vertical policy ]);
- Method
set_hadjustment
GTK2.ScrolledWindowset_hadjustment(GTK2.Adjustmenthadjustment)- Description
Set the horizontal adjustment object.
- Method
set_placement
GTK2.ScrolledWindowset_placement(intwindow_placement)- Description
The location of the window relative to the scrollbars. One of
CORNER_BOTTOM_LEFT,CORNER_BOTTOM_RIGHT,CORNER_TOP_LEFTandCORNER_TOP_RIGHT
- Method
set_policy
GTK2.ScrolledWindowset_policy(intxpolicy,intypolicy)- Description
Vertical and horizontal policy. Both are one of
POLICY_ALWAYS,POLICY_AUTOMATICandPOLICY_NEVER
- Method
set_shadow_type
GTK2.ScrolledWindowset_shadow_type(inttype)- Description
Changes the type of shadow drawn around the contents. One of
SHADOW_ETCHED_IN,SHADOW_ETCHED_OUT,SHADOW_IN,SHADOW_NONEandSHADOW_OUT
Class GTK2.SelectionData
- Description
Drag-and-drop selection data transport object. Most commonly accessed from selection handler callbacks.
Class GTK2.Separator
- Description
A generic separator. Basicaly a line, like <hr> in HTML.
Class GTK2.SeparatorMenuItem
- Description
A separator menu item.
Class GTK2.SeparatorToolItem
- Description
Properties: int draw
- Method
create
GTK2.SeparatorToolItemGTK2.SeparatorToolItem(mapping|voidprops)- Description
Create a new GTK2.SeparatorToolItem.
- Method
get_draw
intget_draw()- Description
Returns whether SeparatorToolItem is drawn as a line, or just a blank
Class GTK2.Settings
- Description
Properties: int gtk-alternative-button-order int gtk-button-images int gtk-can-change-accels string gtk-color-palette string gtk-color-scheme int gtk-cursor-blink int gtk-cursor-blink-time string gtk-cursor-theme-name int gtk-cursor-theme-size int gtk-dnd-drag-threshold int gtk-double-click-distance int gtk-double-click-time int gtk-enable-animations int gtk-entry-password-hint-timeout int gtk-entry-select-on-focus string gtk-font-name string gtk-icon-sizes string gtk-icon-theme-name string gtk-key-theme-name string gtk-menu-bar-accel gint gtk-menu-bar-popup-delay int gtk-menu-images int gtk-menu-popdown-delay int gtk-menu-popup-delay string gtk-modules int gtk-split-cursor string gtk-theme-name int gtk-toolbar-icon-size int gtk-toolbar-style int gtk-touchscreen-mode int gtk-xft-antialias int gtk-xft-dpi int gtk-xft-hinting string gtk-xft-hintstyle string gtk-xft-rgba
Class GTK2.SizeGroup
- Description
Provides a mechanism for grouping a number of widgets together so they all request the same amount of space. This is typically usefull when you want a column of widgets to have the same size, but you can't use a W(Table) widget.
In detail, the size requiest for each widget in a GTK2.SizeGroup is the maximum of the sizes that would have been requested for each widget in the size group if they were not in the size group. The mode of the size group (see set_mode() determines whether this applies to the horizontal size, the vertical size, or both sizes.
Note that size groups only affect the amount of space requested, not the size that the widgets finally receive. If you want the widgets in a GTK2.SizeGroup to actually be the same size, you need to pack them in such a way that they get the size they request and not more. For example, if you are packing your widgets into a table, you would not include the GTK2.FILL flag.
GTK2.SizeGroup objects are referenced by each widget in the size group, so one you have added all widgets to a GTK2.SizeGroup, you can drop the initial reference to the size group. If the widgets in the size group are subsequently destroyed, then they will be removed from the size group; when all widgets have been removed, the size group will be freed.
Widgets can be part of multiple size groups; GTK+ will compute the horizontal size of a widget from the horizontal requisition of all widgets that can be reached from the widget by a chain of size groups of type GTK2.SIZE_GROUP_HORIZONTAL or GTK2.SIZE_GROUP_BOTH, and the vertical size from the vertical requisition of all widgets that can be reached from the widget by a chain of size groups of type GTK2.SIZE_GROUP_VERTICAL or GTK2.SIZE_GROUP_BOTH. Properties: int mode The directions in which the size group effects the requested sizes of its componenent widgets.
- Method
add_widget
GTK2.SizeGroupadd_widget(GTK2.Widgetwidget)- Description
Adds a widget to the group. In the future, the requisition of the widget will be determined as the maximum of its requisition and the requisition of the other widgets in the size group. Whether this applies horizontally, vertically, or in both directions depends on the mode.
- Method
get_ignore_hidden
intget_ignore_hidden()- Description
Returns if invisible widgets are ignored when calculating the size.
- Method
get_widgets
arrayget_widgets()- Description
Returns the list of widgets associated with this size group.
- Method
set_ignore_hidden
GTK2.SizeGroupset_ignore_hidden(intsetting)- Description
Sets whether invisible widgets should be ignored when calculating the size.
- Method
set_mode
GTK2.SizeGroupset_mode(intmode)- Description
Sets the mode of the size group. One of
SIZE_GROUP_BOTH,SIZE_GROUP_HORIZONTAL,SIZE_GROUP_NONEandSIZE_GROUP_VERTICAL. The mode of the size group determines whether the widgets in the size group should all have the same horizontal requisition, all have the same vertical requisition, or should all have the same requisition in both directions.
Class GTK2.Socket
- Description
Together with W(Plug), GTK2.Socket provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a GTK2.Socket widget and, passes the XID of that widget's window to the other process, which then creates a W(Plug) window with that XID. Any widgets contained in the W(Plug) then will appear inside the first applications window.
Note that if you pass the XID of the socket to another process that will create a plug in the socket, you must make sure that the socket widget is not destroyed until that plug is created. Violating this rule will cause unpredictable consequences, the most likely consequence being that the plug will appear as a separate toplevel window.
A socket can also be used to swallow arbitrary pre-existing top-level windows using steal(), though the integration when this is done will not be as close as between a W(Plug) and a GTK2.Socket.
Signals: plug_added
plug_removed
- Method
add_id
GTK2.Socketadd_id(intwid)- Description
Adds an XEMBED client, such as a W(Plug), to the W(Socket).
- Method
get_id
intget_id()- Description
Gets the window id of a W(Socket) widget, which can then be used to create a client embedded inside the socket, for instance with GTK2.Plug->create().
Class GTK2.SourceBuffer
- Description
Text buffer object for GTK2.SourceView
Properties: int check-brackets int escape-char int highlight GTK2.SourceLanguage language int max-undo-levels
Signals: highlight_updated
marker_updated
redo
undo
- Method
begin_not_undoable_action
GTK2.SourceBufferbegin_not_undoable_action()- Description
Marks the beginning of a not undoable action on the buffer, disabling the undo manager. Typically you would call this function before initially setting the contents of the buffer (e.g. when loading a file in a text editor).
You may nest begin_no_undoable_action()/end_not_undoable_action() blocks.
- Method
create
GTK2.SourceBufferGTK2.SourceBuffer(GTK2.TextTagTabletable_or_lang)- Description
Create a new SourceBuffer.
- Method
end_not_undoable_action
GTK2.SourceBufferend_not_undoable_action()- Description
Marks the end of a not undoable action on the buffer. When the last not undoable block is closed through a call to this function, the list of undo actions is cleared and the undo manager is re-enabled.
- Method
get_language
GTK2.SourceLanguageget_language()- Description
Determines the GTK2.SourceLanguage used by the buffer.
- Method
get_max_undo_levels
intget_max_undo_levels()- Description
Determines the number of undo levels the buffer will track for buffer edits.
- Method
redo
GTK2.SourceBufferredo()- Description
Redoes the last undo operation. Use can_redo() to check whether a call to this function will have any effect.
- Method
set_language
GTK2.SourceBufferset_language(GTK2.SourceLanguagelang)- Description
Sets the source language the source buffer will use, adding GTK2.SourceTag tags with the language's patterns and setting the escape character with set_escape_char(). Note that this will remove any GTK2.SourceTag tags currently in the buffer's tag table.
- Method
set_max_undo_levels
GTK2.SourceBufferset_max_undo_levels(intsetting)- Description
Sets the number of undo levels for user actions the buffer will track. If the number of user actions exceeds the limit set by this funcction, older actions will be discarded.
A new action is started whenever the function begin_user_action() is called. In general, this happens whenever the user presses any key which modifies the buffer, but the undo manager will try to merge similar consecutive actions, such as multiple character insertions into one action. But, inserting a newline does start a new action.
- Method
undo
GTK2.SourceBufferundo()- Description
Undoes the last user action which modified the buffer. Use can_undo() to check whether a call to this function will have any effect.
Actions are defined as groups of operations between a call to GTK2.TextBuffer->begin_user_action() and GTK2.TextBuffer->end_user_action(), or sequences of similar edits (inserts or deletes) on the same line.
Class GTK2.SourceIter
- Method
backward_search
arraybackward_search(stringstr,intflags,GTK2.TextIterlimit)- Description
Same as GTK2.TextIter->backward_search(), but supports case insensitive searching.
- Method
backward_search
Class GTK2.SourceLanguage
- Description
Signals: tag_style_changed
Class GTK2.SourceLanguagesManager
- Method
create
GTK2.SourceLanguagesManagerGTK2.SourceLanguagesManager()- Description
Create a new language manager.
- Method
get_available_languages
arrayget_available_languages()- Description
Gets a list of available languages.
- Method
get_lang_files_dirs
arrayget_lang_files_dirs()- Description
Gets a list of language files directories.
- Method
get_language_from_mime_type
GTK2.SourceLanguageget_language_from_mime_type(stringtype)- Description
Gets the GTK2.SourceLanguage which is associated with the given type in the language manager.
- Method
create
Class GTK2.SourceMark
- Method
next
GTK2.SourceMarknext(stringcategory)- Description
Gets the next marker of the specified category after this.
- Method
next
Class GTK2.SourceMarker
Class GTK2.SourcePrintJob
- Description
Properties: GTK2.SourceBuffer buffer Gnome.PrintConfig config string font Pango.FontDescription font-desc string header-footer-font Pango.FontDescription header-footer-font-desc int highlight string numbers-font Pango.FontDescript numbers-font-desc int print-footer int print-header int print-numbers int tabs-width int wrap-mode
Signals: begin_page
finished
- Method
cancel
GTK2.SourcePrintJobcancel()- Description
Cancels an asynchronous printing operation. This will remove any pending print idle handler.
- Method
create
GTK2.SourcePrintJobGTK2.SourcePrintJob(GTK2.SourceBufferbuffer)- Description
Creates a new print job object.
- Method
get_buffer
GTK2.SourceBufferget_buffer()- Description
Gets the GTK2.SourceBuffer the print job would print.
- Method
get_highlight
intget_highlight()- Description
Determines if the job is configured to print the text highlighted with colors and font styles. Note that highlighting will happen only if the buffer to print has highlighting activated.
- Method
get_page_count
intget_page_count()- Description
Determines the total number of pages the job will print. The returned value is only meaningful after pagination has finished. In practice, for synchronous printing this means when "begin_page" is emitted, or after print_range_async() has returned.
- Method
get_print_footer
intget_print_footer()- Description
Determines if a footer is set to be printed for each page. A footer will be printed if this function returns true and some format strings have been specified with set_footer_format().
- Method
get_print_header
intget_print_header()- Description
Determines if a header is set to be printed for each page. A header will be printed if this function returns true and some format strings have been specified with set_header_format().
- Method
get_print_numbers
intget_print_numbers()- Description
Determines the interval used for line number printing. If the value is 0, no line numbers will be printed. The default value is 1 (i.e. numbers printed in all lines).
- Method
get_tabs_width
intget_tabs_width()- Description
Determines the configured width (in equivalent spaces) of tabulations. The default value is 8.
- Method
get_text_margins
mappingget_text_margins()- Description
Determines the user set margins for the job. The default for all four margins is 0.0.
- Method
get_wrap_mode
intget_wrap_mode()- Description
Determines the wrapping style for text lines wider than the printable width. The default is no wrapping.
- Method
print_range
GTK2.SourcePrintJobprint_range(GTK2.TextIterstart,GTK2.TextIterend)- Description
Similar to print(), except you can specify a range of text to print. start and end can be in any order.
- Method
print_range_async
GTK2.SourcePrintJobprint_range_async(GTK2.TextIterstart,GTK2.TextIterend)- Description
Starts to print job asynchronously. This function will ready the job for printing and install an idle handler that will render one page at a time.
This function will not return immediately, as only page rendering is done asynchronously. Text retrieval and paginating happens within this function. Also, if highlighting is enabled, the whole buffer needs to be highlighted first.
To get notification when the job has finished, you must connect to the "finished" signal.
- Method
set_buffer
GTK2.SourcePrintJobset_buffer(GTK2.SourceBufferbuffer)- Description
Sets the GTK2.SourceBuffer the print job will print. You need to specify a buffer to print, either by the use of this function or by creating the print job with create().
- Method
set_footer_format
GTK2.SourcePrintJobset_footer_format(string|voidleft,string|voidcenter,string|voidright,intseparator)- Description
Like set_header_format(), but for the footer.
- Method
set_header_format
GTK2.SourcePrintJobset_header_format(string|voidleft,string|voidcenter,string|voidright,intseparator)- Description
Sets strftime like header format strings, to be printed on the left, center and right of the top of each page. The strings may include strftime(3) codes which will be expanded at print time. All strftime() codes are accepted, with the addition of N for the page number and Q for the page count.
separator specifies if a solid line should be drawn to separate the header from the document text.
If 0 is given for any of the three arguments, that particular string will not be printed. For the header to be printed, in addition to specifying format strings, you need to enable header printing with set_print_header().
- Method
set_highlight
GTK2.SourcePrintJobset_highlight(intsetting)- Description
Sets whether the printed text will be highlighted according to the buffer rules. Both color and font style are applied.
- Method
set_print_footer
GTK2.SourcePrintJobset_print_footer(intsetting)- Description
Sets whether you want to print a footer in each page. The default footer consists of three pieces of text and an optional line separator, configurable with set_footer_format().
Note that be default the footer format is unspecified, and if it's empty it will not be printed, regardless of this setting.
- Method
set_print_header
GTK2.SourcePrintJobset_print_header(intsetting)- Description
Sets whether you want to print a header in each page. The default header consists of three pieces of text and an optional line separator, configurable with set_header_format().
Note that by default the header format is unspecified, and if it's empty it will not be printed, regardless of this setting.
- Method
set_print_numbers
GTK2.SourcePrintJobset_print_numbers(intinterval)- Description
Sets the interval for printed line numbers. If interval is 0 no numbers will be printed. If greater than 0, a number will be printed every interval lines (i.e. 1 will print all line numbers).
- Method
set_tabs_width
GTK2.SourcePrintJobset_tabs_width(inttabs_width)- Description
Sets the width (equivalent spaces) of tabulations for the printed text. The width in printing units will be calculated as the width of a string containing tabs_width spaces of the default font. Tabulation stops are set for the full width of printed text.
- Method
set_text_margins
GTK2.SourcePrintJobset_text_margins(floattop,floatbottom,floatleft,floatright)- Description
Sets the four user margins for the print job. These margins are in addition to the document margins provided in the GnomePrintConfig and will not be used for headers, footers, or line numbers (those are calculated separately). You can print in the space allocate by these margins by connecting to the "begin-page" signal. The space is around the printed text, and inside the margins specified in the GnomePrintConfig.
The margin numbers are given in device units. If any of the given values is less than 0, that particular margin is not altered by this function.
- Method
set_wrap_mode
GTK2.SourcePrintJobset_wrap_mode(intsetting)- Description
Sets the wrap mode for lines of text larger than the printable width.
Class GTK2.SourceTag
- Description
Properties: string id GTK2.SourceTagStyle tag-style
Class GTK2.SourceTagTable
- Description
Derived from GTK2.TextTagTable
Signals: changed
- Method
add_tags
GTK2.SourceTagTableadd_tags(arraytags)- Description
Adds a list of tags to the table. The added tags are assigned the highest priority in the table.
If a tag is already present in the table or has the same name as an already added tag, then it is not added to the table.
- Method
create
GTK2.SourceTagTableGTK2.SourceTagTable()- Description
Creates a new table. The table contains no tags be default.
Class GTK2.SourceView
- Description
Properties: int auto-indent int highlight-current-line int insert-spaces-instead-of-tabs int margin int show-line-markers int show-line-numbers int show-margin int smart-home-end int tabs-width
Signals: redo
undo
- Method
create
GTK2.SourceViewGTK2.SourceView(GTK2.SourceBufferbuffer)- Description
Create a new W(SourceView). If a buffer isn't specified, an empty default buffer will be created.
- Method
get_auto_indent
intget_auto_indent()- Description
Returns whether auto indentation of text is enabled.
- Method
get_insert_spaces_instead_of_tabs
intget_insert_spaces_instead_of_tabs()- Description
Returns whether when inserting a tabulator character it should be replaced by a group of space characters.
- Method
get_show_line_numbers
intget_show_line_numbers()- Description
Returns whether line markers are displayed beside the text.
- Method
get_smart_home_end
intget_smart_home_end()- Description
Returns whether HOME and END keys will move to the first/last non-space character of the line before moving to the start/end.
- Method
set_auto_indent
GTK2.SourceViewset_auto_indent(intsetting)- Description
If true, auto indentation of text is enabled.
- Method
set_insert_spaces_instead_of_tabs
GTK2.SourceViewset_insert_spaces_instead_of_tabs(intsetting)- Description
If true, any tabulator character inserted is replaced by a group of space characters.
- Method
set_show_line_numbers
GTK2.SourceViewset_show_line_numbers(intsetting)- Description
If true, line numbers will be displayed beside the text.
Class GTK2.SpinButton
- Description
The Spin Button widget is generally used to allow the user to select a value from a range of numeric values. It consists of a text entry box with up and down arrow buttons attached to the side. Selecting one of the buttons causes the value to "spin" up and down the range of possible values. The entry box may also be edited directly to enter a specific value.
The Spin Button allows the value to have zero or a number of decimal places and to be incremented/decremented in configurable steps. The action of holding down one of the buttons optionally results in an acceleration of change in the value according to how long it is depressed.
The Spin Button uses an W(Adjustment) object to hold information about the range of values that the spin button can take.
The attributes of an W(Adjustment) are used by the Spin Button in the following way: <ul><li>value: initial value for the Spin Button</li> <li>lower: lower range value</li> <li>upper: upper range value</li> <li>step_increment: value to increment/decrement when pressing mouse button 1 on a button</li> <li>page_increment: value to increment/decrement when pressing mouse button 2 on a button</li> <li>page_size: unused</li> </ul>
The argument order for the W(Adjustment) constructor is: value, lower, upper, step_increment, page_increment, page_size
 GTK2.SpinButton(GTK2.Adjustment(),0.1, 1 )->set_size_request(60,20)
Properties: GTK2.Adjustment adjustment float climb-rate int digits int numeric int snap-to-ticks int update-policy float value int wrap
Style properties: int shadow-type
Signals: change_value
input
output
value_changed
- Method
configure
GTK2.SpinButtonconfigure(GTK2.Adjustmentrange,floatclimb_rate,intprecision)- Description
Adjustment (with the lower/upper/increse values), climb_rate and digits
- Method
create
GTK2.SpinButtonGTK2.SpinButton(GTK2.Adjustmentrange_or_min_or_props,floatclimb_rate_or_max,int|floatprecision_or_step)- Description
The climb_rate argument take a value between 0.0 and 1.0 and indicates the amount of acceleration that the Spin Button has. The digits argument specifies the number of decimal places to which the value will be displayed.
- Method
get_adjustment
GTK2.Adjustmentget_adjustment()- Description
Get the adjustment associated with this spinbutton.
- Method
get_snap_to_ticks
intget_snap_to_ticks()- Description
Returns whether the value are corrected to the nearest step.
- Method
get_value_as_int
intget_value_as_int()- Description
The current value of a Spin Button can be retrieved as a int.
- Method
get_wrap
intget_wrap()- Description
Returns whether the value wraps around to the opposite limit when the upper or lower limit of the range is exceeded.
- Method
set_adjustment
GTK2.SpinButtonset_adjustment(GTK2.Adjustmentrange)- Description
Set a new adjustment.
- Method
set_digits
GTK2.SpinButtonset_digits(intprecision)- Description
Set the number of digits to show to the user.
- Method
set_increments
GTK2.SpinButtonset_increments(floatstep,floatpage)- Description
Sets the step and page increments. This affects how quickly the value changes when the arrows are activated.
- Method
set_numeric
GTK2.SpinButtonset_numeric(intnumericp)- Description
If true, it is a numeric value. This prevents a user from typing anything other than numeric values into the text box of a Spin Button
- Method
set_range
GTK2.SpinButtonset_range(floatmin,floatmax)- Description
Sets the minimum and maximum allowable values.
- Method
set_snap_to_ticks
GTK2.SpinButtonset_snap_to_ticks(intsnapp)- Description
Set the Spin Button to round the value to the nearest step_increment, which is set within the Adjustment object used with the Spin Button
- Method
set_update_policy
GTK2.SpinButtonset_update_policy(intpolicy)- Description
The possible values of policy are either GTK2.UpdateAlways or GTK2.UpdateIfValid.
These policies affect the behavior of a Spin Button when parsing inserted text and syncing its value with the values of the Adjustment.
In the case of GTK2.UpdateIfValid the Spin Button value only gets changed if the text input is a numeric value that is within the range specified by the Adjustment. Otherwise the text is reset to the current value.
In case of GTK2.UpdateAlways errors are ignored while converting text into a numeric value.
- Method
set_wrap
GTK2.SpinButtonset_wrap(intwrapp)- Description
If true, the spin button will wrap from the lowest to the highest value, and the highest to the lowest.
- Method
spin
GTK2.SpinButtonspin(intdirection,floatincrement)- Description
If you want to alter the value of a Spin Value relative to its current value, then this function can be used.
The direction paramenter is one of
SPIN_END,SPIN_HOME,SPIN_PAGE_BACKWARD,SPIN_PAGE_FORWARD,SPIN_STEP_BACKWARD,SPIN_STEP_FORWARDandSPIN_USER_DEFINEDGTK2.SpinStepForward and GTK2.SpinStepBackward change the value of the Spin Button by the amount specified by increment, unless increment is equal to 0, in which case the value is changed by the value of step_increment in theAdjustment.
GTK2.SpinPageForward and GTK2.SpinPageBackward simply alter the value of the Spin Button by increment.
GTK2.SpinHome sets the value of the Spin Button to the bottom of the Adjustments range.
GTK2.SpinEnd sets the value of the Spin Button to the top of the Adjustments range.
GTK2.SpinUserDefined simply alters the value of the Spin Button by the specified amount.
Class GTK2.Spinner
- Description
A @[Spinner] widget displays an icon-size spinning animation. It is often used as an alternative to a GtkProgressBar for displaying indefinite activity, instead of actual progress.
To start the animation, use @[start], to stop it use @[stop] Properties: int active
Class GTK2.StatusIcon
- Description
The "system tray" or notification area is normally used for transient icons that indicate some special state. For example, a system tray icon might appear to tell the user that they have new mail, or have an incoming instant message, or something along those lines. The basic idea is that creating an icon in the notification area is less annoying than popping up a dialog.
A GTK2.StatusIcon object can be used to display an icon in a "system tray". The icon can have a tooltip, and the user can interact with it by activating it or popping up a context menu. Critical information should/ not solely be displayed in a GTK2.StatusIcon, since it may not be visible (e.g. when the user doesn't have a notification area on his panel). This can be checked with is_embedded().
On X11, the implementation follows the freedesktop.org "System Tray" specification. Implementations of the "tray" side of this specification can be found e.g. in the GNOME and KDE panel applications.
Note that a GTK2.StatusIcon is not a widget, but just a G.Object. Making it a widget would be impractical, since the system tray on Win32 doesn't allow to embed arbitrary widgets. Properties: int blinking string file string icon-name GDK2.Pixbuf pixbuf int size string stock int storage-type int visible
Signals: activate
popup_menu
size_changed
- Method
create
GTK2.StatusIconGTK2.StatusIcon(mapping|GdkPixbuf|stringarg)- Description
Create a new GTK2.StatusIcon.
- Method
get_storage_type
intget_storage_type()- Description
Gets the type of icon, e.g. GTK2.IMAGE_PIXMAP, GTK2.IMAGE_PIXBUF, etc.
- Method
is_embedded
intis_embedded()- Description
Returns whether the status icon is embedded in a notification area.
- Method
set_blinking
GTK2.StatusIconset_blinking(intblinking)- Description
Makes the status icon start or stop blinking.
- Method
set_from_file
GTK2.StatusIconset_from_file(stringfilename)- Description
Set the icon from a file.
- Method
set_from_icon_name
GTK2.StatusIconset_from_icon_name(stringicon_name)- Description
Set the icon from the icon called icon_name from the current theme.
- Method
set_from_pixbuf
GTK2.StatusIconset_from_pixbuf(GTK2.GdkPixbufpixbuf)- Description
Set the icon from pixbuf.
- Method
set_from_stock
GTK2.StatusIconset_from_stock(stringstock_id)- Description
Set the icon from a stock icon.
Class GTK2.Statusbar
- Description
Statusbars are simple widgets used to display a text message. They keep a stack of the messages pushed onto them, so that popping the current message will re-display the previous text message.
In order to allow different parts of an application to use the same statusbar to display messages, the statusbar widget issues Context Identifiers which are used to identify different 'users'. The message on top of the stack is the one displayed, no matter what context it is in. Messages are stacked in last-in-first-out order, not context identifier order.
 lambda() {object sb = GTK2.Statusbar();int id = sb->get_context_id("test");sb->push(id,"A message");sb->push(id,"Another message");return sb;}()
 lambda() {object sb = GTK2.Statusbar();int id = sb->get_context_id("test");sb->push(id,"A message");sb->push(id,"Another message");sb->pop(id);return sb;}()
Properties: int has-resize-grip
Style properties: int shadow-type
Signals: text_popped
text_pushed
- Method
create
GTK2.StatusbarGTK2.Statusbar(mapping|voidprops)- Description
Create a new statusbar widget
- Method
get_context_id
intget_context_id(stringcontext)- Description
Create a new context id (or get the id of an old one). The argument is any string. The return value can be used for ->push() ->pop() and ->remove later on.
- Method
get_has_resize_grip
intget_has_resize_grip()- Description
Returns whether the statusbar has a resize grip.
- Method
push
intpush(intcontext,stringdata)- Description
Push a message onto the statusbar. The return value is an id that can be passed to remove later on.
- Method
remove
GTK2.Statusbarremove(intcontext,intid)- Description
Remove the specified message (the message id is the second argument).
Class GTK2.StringTag
Class GTK2.Style
- Description
Style settings.
Signals: realize
unrealize
- Method
attach
GTK2.Styleattach(GTK2.Widgetwindow)- Description
Attaches a style to a window; this process allocates the colors and creates the GC's for the style - it specializes it to a particular visual and colormap. The process may involve the creation of a new style if the style has already been attached to a window with a different style and colormap.
- Method
paint_arrow
GTK2.Stylepaint_arrow(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intarrow,intfill,intx,inty,intwidth,intheight)- Description
Draws an arrow in the given rectangle on window using the given parameters. arrow determines the direction of the arrow.
- Method
paint_box
GTK2.Stylepaint_box(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight)- Description
Draws a box on window with the given parameters.
- Method
paint_box_gap
GTK2.Stylepaint_box_gap(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight,intgap_side,intgap_x,intgap_width)- Description
Draws a box in window using the given style and state and shadow type, leaving a gap in one side.
- Method
paint_check
GTK2.Stylepaint_check(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight)- Description
Draws a check button indicator in the given rectangle on window.
- Method
paint_diamond
GTK2.Stylepaint_diamond(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight)- Description
Draws a diamond in the given rectangle on window.
- Method
paint_expander
GTK2.Stylepaint_expander(GTK2.Widgetwindow,intstate,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intstyle)- Description
Draws an expander as used in GTK2.TreeView. x and y specify the center of the expander. The size of the expander is determined by the "expander-size" style property of widget. (If widget is 0 or doesn't have an "expander-size" property, an unspecified default size will be used, since the caller doesn't have sufficient information to position the expander, this is likely not useful.) The expander is expander_size pixels tall in the collapsed position and expander_size pixels wide in the expanded position.
- Method
paint_extension
GTK2.Stylepaint_extension(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight,intgap_side)- Description
Draws an extension, i.e. a notebook tab.
- Method
paint_flat_box
GTK2.Stylepaint_flat_box(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight)- Description
Draws a flat box on window.
- Method
paint_focus
GTK2.Stylepaint_focus(GTK2.Widgetwindow,intstate,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight)- Description
Draws a focus indicator around the given rectangle.
- Method
paint_handle
GTK2.Stylepaint_handle(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight,intorientation)- Description
Draws a handle as used in GTK2.HandleBox and GTK2.Paned.
- Method
paint_hline
GTK2.Stylepaint_hline(GTK2.Widgetwindow,intstate,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx1,intx2,inty)- Description
Draws a horizontal line from (x1,y) to (x2,y).
- Method
paint_layout
GTK2.Stylepaint_layout(GTK2.Widgetwindow,intstate,intuse_text,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,GTK2.Pango.Layoutlayout)- Description
Draw a pango layout. Use widget->create_pango_layout() to get a Pango.Layout.
- Method
paint_option
GTK2.Stylepaint_option(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight)- Description
Draws a radio button indicator in the given rectangle.
- Method
paint_resize_grip
GTK2.Stylepaint_resize_grip(GTK2.Widgetwindow,intstate,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intedge,intx,inty,intwidth,intheight)- Description
Draws a resize grip in the given rectangle.
- Method
paint_shadow
GTK2.Stylepaint_shadow(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight)- Description
Draws a shadow around the given rectangle.
- Method
paint_shadow_gap
GTK2.Stylepaint_shadow_gap(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight,intgap_side,intgap_x,intgap_width)- Description
Draws a shadow around the given rectangle in window, leaving a gap in one side.
- Method
paint_slider
GTK2.Stylepaint_slider(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight,intorientation)- Description
Paint a slider.
- Method
paint_tab
GTK2.Stylepaint_tab(GTK2.Widgetwindow,intstate,intshadow,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,intx,inty,intwidth,intheight)- Description
Draws an option menu tab (i.e. the up and down pointing arrows).
- Method
paint_vline
GTK2.Stylepaint_vline(GTK2.Widgetwindow,intstate,GTK2.GdkRectanglerect,GTK2.Widgetwidget,stringdetail,inty1,inty2,intx)- Description
Draws a vertical line from (x,y1) to (x,y2).
- Method
render_icon
GTK2.GdkPixbufrender_icon(GTK2.IconSourcesource,intdirection,intstate,intsize,GTK2.Widgetwidget,stringdetail)- Description
Renders the icon specified by source at the given size according to the given parameters and returns the result in a pixbuf.
Class GTK2.SyntaxTag
Class GTK2.Table
- Description
The GTK2.Table allows the programmer to arrange widgets in rows and columns, making it easy to align many widgets next to each other, horizontally and vertically.
 GTK2.Table(2,2,0)->attach_defaults( GTK2.Label("0,0"), 0, 1, 0, 1)->attach_defaults( GTK2.Label("0,1"), 0, 1, 1, 2)->attach_defaults( GTK2.Label("1,0"), 1, 2, 0, 1)->attach_defaults( GTK2.Label("1,1"), 1, 2, 1, 2)->set_col_spacings(10)->set_row_spacings(10)
 GTK2.Table(2,2,0)->attach_defaults( GTK2.Label("0,0-1,0"), 0, 2, 0, 1)->attach_defaults( GTK2.Label("0,1"), 0, 1, 1, 2)->attach_defaults( GTK2.Label("1,1"), 1, 2, 1, 2)->set_col_spacings(10)->set_row_spacings(10)
Properties: int column-spacing int homogeneous int n-columns int n-rows int row-spacing
Child properties: int bottom-attach int left-attach int right-attach int top-attach int x-options int x-padding int y-options int y-padding
- Method
attach
GTK2.Tableattach(GTK2.Widgetsubwidget,intleft,intright,inttop,intbottom,intxoptions,intyoptions,intxpad,intypad)- Description
The left and right attach arguments specify where to place the widget, and how many boxes to use. If you want a button in the lower right table entry of our 2x2 table, and want it to fill that entry ONLY. left_attach would be = 1, right_attach = 2, top_attach = 1, bottom_attach = 2.
Now, if you wanted a widget to take up the whole top row of our 2x2 table, you'd use left_attach = 0, right_attach = 2, top_attach = 0, bottom_attach = 1.
The xoptions and yoptions are used to specify packing options and may be OR'ed together to allow multiple options.
These options are: <ul> <li> GTK2.Fill - If the table box is larger than the widget, and GTK_FILL is specified, the widget will expand to use all the room available.</li> <li> GTK2.Shrink - If the table widget was allocated less space then was requested (usually by the user resizing the window), then the widgets would normally just be pushed off the bottom of the window and disappear. If GTK_SHRINK is specified, the widgets will shrink with the table.</li> <li> GTK2.Expand - This will cause the table cell to expand to use up any remaining space in the window.</li> </ul>
Padding is just like in boxes, creating a clear area around the widget specified in pixels
- Method
attach_defaults
GTK2.Tableattach_defaults(GTK2.Widgetsubwidget,intleft,intright,inttop,intbottom)- Description
As there are many options associated with attach(), this convenience function provides the programmer with a means to add children to a table with identical padding and expansion options.
xoptions, yoptions, xpadding and ypadding are all set the their default values. For the options that is GTK2.Fill|GTK2.Expand. For the padding it is 0.
- Method
create
GTK2.TableGTK2.Table(int|mappingwidth_or_props,int|voidheight,int|voidhomogeneousp)- Description
Used to create a new table widget. An initial size must be given by specifying how many rows and columns the table should have, although this can be changed later with resize().
There can never be more than 65535 colums nor more than 65535 rows.
setting homogeneousp to 1 forces the all tablecells to be exactly the same size.
- Method
get_col_spacing
intget_col_spacing(intcol)- Description
Gets the amound of space between col and col+1.
- Method
get_default_col_spacing
intget_default_col_spacing()- Description
Gets the default column spacing for the table.
- Method
get_default_row_spacing
intget_default_row_spacing()- Description
Gets the default row spacing for the table.
- Method
get_homogeneous
intget_homogeneous()- Description
Returns whether the table cells are all constrained to the same width and height.
- Method
get_row_spacing
intget_row_spacing(introw)- Description
Gets the amount of space between row and row+1.
- Method
resize
GTK2.Tableresize(introws,intcolumns)- Description
If you need to change a table's size after it has been created, this function allows you to do so.
- Method
set_col_spacing
GTK2.Tableset_col_spacing(intx,intspacing)- Description
alters the amount of space between a given table column and the adjacent columns.
- Method
set_col_spacings
GTK2.Tableset_col_spacings(intspacing)- Description
Sets the space between every column in the table equal to spacing.
- Method
set_homogeneous
GTK2.Tableset_homogeneous(inthomogeneousp)- Description
Set the homogeneous flag.
- Method
set_row_spacing
GTK2.Tableset_row_spacing(inty,intspacing)- Description
alters the amount of space between a given table row and the adjacent rows.
Class GTK2.TearoffMenuItem
- Description
A GTK2.TearoffMenuItem is a special W(MenuItem) which is used to tear off and reattach its menu.
When its menu is shown normally, the GTK2.TearoffMenuItem is drawn as a dotted line indicating that the menu can be torn off. Activating it causes its menu to be torn off and displayed in its own window as a tearoff menu.
When its menu is shown as a tearoff menu, the GTK2.TearoffMenuItem is drawn as a dotted line which has a left pointing arrow graphic indicating that the tearoff menu can be reattached. Activating it will erase the tearoff menu window.
 GTK2.TearoffMenuItem()->set_size_request(100,0)
Class GTK2.TextAttributes
- Description
Holds text attributes.
- Method
copy_values
GTK2.TextAttributescopy_values(GTK2.TextAttributesdest)- Description
Copies src onto dest
Class GTK2.TextBuffer
- Description
Properties: int cursor-position int has-selection GTK2.TextTagTable tag_table string text
Signals: apply_tag
begin_user_action
changed
delete_range
end_user_action
insert_child_anchor
insert_pixbuf
insert_text
mark_deleted
mark_set
modified_changed
remove_tag
- Method
add_selection_clipboard
GTK2.TextBufferadd_selection_clipboard(GTK2.Clipboardclipboard)- Description
Adds clipboard to the list of clipboards in which the selection contents of the buffer are available. In most cases, clipboard will be the GTK2.Clipboard of GDK2.SELECTION_PRIMARY for a view of this buffer.
- Method
apply_tag
GTK2.TextBufferapply_tag(GTK2.TextTagtag,GTK2.TextIterstart,GTK2.TextIterend)- Description
Emits the "apply-tag" signal. The default handler for the signal applies tag to the given range, start and end do not have to be in order.
- Method
apply_tag_by_name
GTK2.TextBufferapply_tag_by_name(stringname,GTK2.TextIterstart,GTK2.TextIterend)- Description
Calls GTK2.TextTagTable->lookup() on the buffers tag table to get a GTK2.TextTag, then calls apply_tag().
- Method
backspace
intbackspace(GTK2.TextIteriter,intinteractive,intdefault_editable)- Description
Performs the appropriate action as if the user hit the delete key with the cursor at the position specified by iter. In the normal case a single character will be deleted, but when combining accents are involved, more than one character can be deleted, and when precomposed character and accent combinations are involved, less than one character will be deleted.
Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, iter will be re-initialized to point to the location where text was deleted.
- Method
begin_user_action
GTK2.TextBufferbegin_user_action()- Description
Called to indicate that the buffer operations between here and call end_user_action() are part of a single user-visible operation. The operations between begin_user_action() and end_user_action() can then be grouped when creating an undo stack. W(TextBuffer) maintains a count of calls to begin_user_action() that have not been closed with a call to end_user_action(), and emits the "begin-user-action" and "end-user-action" signals only for the outermost pair of calls. This allows you to build user actions from other user actions.
The "interactive" buffer mutation functions, such as insert_interactive(), automatically call begin/end user action around the buffer operations they perform, so there's no need to add extra calls if your user action consists solely of a single call to one of those functions.
- Method
copy_clipboard
GTK2.TextBuffercopy_clipboard(GTK2.Clipboardclipboard)- Description
Copies the currently-selected text to a clipboard.
- Method
create
GTK2.TextBufferGTK2.TextBuffer(GTK2.TextTagTabletable_or_props)- Description
Creates a new text buffer.
- Method
create_child_anchor
GTK2.TextChildAnchorcreate_child_anchor(GTK2.TextIteriter)- Description
This is a convenience function which simply creates a child anchor with GTK2.TextChildAnchor->create() and inserts it into the buffer with insert_child_anchor(). The new anchor is owned by the buffer; no reference count is returned.
- Method
create_mark
GTK2.TextMarkcreate_mark(GTK2.TextIterwhere,intleft_gravity,string|voidmark_name)- Description
Creates a mark at position where. If mark_name is omitted, the mark is anonymous; otherwise, the mark can be retrieve by name using get_mark(). If a mark has left gravity, and text is inserted at the mark's current location, the mark will be moved to the left of the newly-inserted text. If the mark has right gravity, the mark will end up on the right of the newly-inserted text. The standard left-to-right cursor is a mark with right gravity (when you type, the cursor stays on the right side of the text you're typing). Emits the "mark-set" signal as notification of the mark's initial placement.
- Method
create_tag
GTK2.TextTagcreate_tag(stringtag_name,mappingprops)- Description
Creates a tag and adds it to the tag table. Equivalent to calling GTK2.TextTag->create() and then adding the tag to the tag table. The returned tag is owned by the tag table.
- Method
cut_clipboard
GTK2.TextBuffercut_clipboard(GTK2.Clipboardclipboard,intdefault_editable)- Description
Copies the currently-selected text to a clipboard, then deletes said text if it's editable.
- Method
delete
GTK2.TextBufferdelete(GTK2.TextIterstart,GTK2.TextIterend)- Description
Deletes text between start and end. The order of start and end is not actually relevant; delete() will reorder them. This function actually emits the "delete-range" signal, and the default handler of that signal deletes the text. Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, start and end will be re-initialized to point to the location where text was deleted.
- Method
delete_interactive
intdelete_interactive(GTK2.TextIterstart,GTK2.TextIterend,intdefault_editable)- Description
Deletes all editable text in the given range. Calls delete() for each editable sub-range of [start,end). start and end are revalidated to point to the location of the last deleted range, or left untouched if no text was deleted.
- Method
delete_mark
GTK2.TextBufferdelete_mark(GTK2.TextMarkmark)- Description
Deletes mark, so that it's no longer located anywhere in the buffer. Removes the reference the buffer holds to the mark. There is no way to undelete a mark. The "mark-deleted" signal will be emitted as notification after the mark is deleted.
- Method
delete_mark_by_name
GTK2.TextBufferdelete_mark_by_name(stringname)- Description
Deletes the mark named name; the mark must exist.
- Method
delete_selection
intdelete_selection(intinteractive,intdefault_editable)- Description
Deletes the range between the "insert" and "selection_bound" marks, that is, the currently-selected text. If interactive is true, the editability of the selection will be considered (users can't delete uneditable text).
- Method
end_user_action
GTK2.TextBufferend_user_action()- Description
Should be paired with begin_user_action();
- Method
get_bounds
arrayget_bounds()- Description
Retrieves the first and last iterators in the buffer, i.e. the entire buffer lies within the range [start,end).
- Method
get_char_count
intget_char_count()- Description
Gets the number of characters in the buffer; note that characters and bytes are not the same, you can't e.g. expect the contents of the buffer in string form to be this many bytes long.
- Method
get_end_iter
GTK2.TextIterget_end_iter()- Description
Returns the "end iterator", one past the last valid character in the buffer. If dereferenced with W(TextIter)->get_char(), the end iterator has a character value of 0. The entire buffer lies in the range from the first position in the buffer to the end iterator.
- Method
get_has_selection
intget_has_selection()- Description
Indicates whether some text is currently selected.
- Method
get_insert
GTK2.TextMarkget_insert()- Description
Returns the mark that represents the cursor (insertion point). Equivalent to calling get_mark() to get the mark named "insert", but very slightly more efficient, and involves less typing.
- Method
get_iter_at_child_anchor
GTK2.TextIterget_iter_at_child_anchor(GTK2.TextChildAnchoranchor)- Description
Returns the location of anchor.
- Method
get_iter_at_line
GTK2.TextIterget_iter_at_line(intline)- Description
Returns a W(TextIter) to the start of the given line.
- Method
get_iter_at_line_index
GTK2.TextIterget_iter_at_line_index(intline,intbyte_index)- Description
Obtains an iterator point to byte_index with the given line. byte_index must be the start of a UTF-8 character, and must not be beyond the end of the line. Note bytes, not characters; UTF-8 may encode one character as multiple bytes.
- Method
get_iter_at_line_offset
GTK2.TextIterget_iter_at_line_offset(intline_number,intchar_offset)- Description
Obtains an iterator pointing to char_offset within the given line. The char_offset must exist, offsets off the end of the line are not allowed. Note characters, not bytes; UTF-8 may encode one character as multiple bytes.
- Method
get_iter_at_mark
GTK2.TextIterget_iter_at_mark(GTK2.TextMarkmark)- Description
Returns an iterator with the current position of mark.
- Method
get_iter_at_offset
GTK2.TextIterget_iter_at_offset(intoffset)- Description
Returns an iterator at position offset chars from the start of the entire buffer. If offset is -1 or greater than the number of characters in the buffer, returns the end iterator, the iterator one past the last valid character in the buffer.
- Method
get_modified
intget_modified()- Description
Indicates whether the buffer has been modified since the last call to set_modified() set the modification flag to false. Used for example to enable a "save" function in a text editor.
- Method
get_selection_bound
GTK2.TextMarkget_selection_bound()- Description
Returns the mark that represents the selection bound. Equivalent to calling get_mark() to get the mark named "selection_bound", but very slightly more efficient, and involves less typing.
The currently-selected text in the buffer is the region between the "selection_bound" and "insert" marks. If "selection_bound" and "insert" are in the same place, then there is no current selection. get_selection_bounds() is another convenient function for handling the selection, if you just want to know whether there's a selection and what its bounds are.
- Method
get_selection_bounds
arrayget_selection_bounds()- Description
Returns either an array with start and end W(TextIter) if some text is selected, or 0 if there's no active selection.
- Method
get_slice
stringget_slice(GTK2.TextIterstart,GTK2.TextIterend,intinclude_hidden_chars)- Description
Returns the text in the range [start,end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if include_hidden_chars is false. The returned string includes a 0xFFFC character whenever the buffer contains embedded images, so byte and character indexes into the returned string do correspond to byte and character indexes into the buffer. Contrast with get_text(). Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer.
- Method
get_start_iter
GTK2.TextIterget_start_iter()- Description
Returns an iterator with the first position in the text buffer. This is the same as using get_iter_at_offset() to get the iter at character offset 0.
- Method
get_tag_table
GTK2.TextTagTableget_tag_table()- Description
Get the W(TextTagTable) associated with this buffer.
- Method
get_text
stringget_text(GTK2.TextIterstart,GTK2.TextIterend,intinclude_hidden_chars)- Description
Returns the text int the range [start,end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if include_hidden_chars is false. Does not include characters representing embedded images, so byte and character indexes into the returned string do not correspond to byte and character indexes into the buffer. Contrast with get_slice().
- Method
insert
GTK2.TextBufferinsert(GTK2.TextIteriter,stringtext,intlen)- Description
Insert len bytes of text at position iter. If len is -1, string will be inserted in its entirely. Emits the 'insert-text' signal. iter is invalidated after insertion, but the default signal handler revalidates it to point to the end of the inserted text.
- Method
insert_at_cursor
GTK2.TextBufferinsert_at_cursor(stringtext,intlen)- Description
Simply calls insert(), using the current cursor position as the insertion point.
- Method
insert_child_anchor
GTK2.TextBufferinsert_child_anchor(GTK2.TextIteriter,GTK2.TextChildAnchoranchor)- Description
Inserts a child widget anchor into the buffer at iter. The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode "object replacement character" oxFFFC. Note that the "slice" variants for obtaining portions of the buffer as a string include this character for child anchors, but the "text" variants do not. e.g. see get_slice() and get_text(). Consider create_child_anchor() as a more convenient alternative to this function. The buffer will add a reference to the anchor, so you can unref it after insertion.
- Method
insert_interactive
intinsert_interactive(GTK2.TextIteriter,stringtext,intlen,intdefault_editable)- Description
Like insert(), but the insertion will not occur if iter is at a non- editable location in the buffer. Usually you want to prevent insertions at ineditable locations if the insertion results from a user action (is interactive).
default_edtibale indicates the editability of text that doesn't have a tag affecting editability applied to it. Typically the result of get_editable() is appropriate here.
- Method
insert_interactive_at_cursor
intinsert_interactive_at_cursor(stringtext,intlen,intdefault_editable)- Description
Calls insert_interactive() at the cursor position.
- Method
insert_pixbuf
GTK2.TextBufferinsert_pixbuf(GTK2.TextIteriter,GTK2.GdkPixbufpixbuf)- Description
Inserts an image into the text buffer at iter. The image will be counted as one character in character counts, and when obtaining the contents as a string, will be represented by the Unicode "object replacement character" 0xFFFC. Note that the "slice" variants for obtaining portions of the buffer as a string include this character for pixbufs, but the "text" variants do not. e.g. see get_slice() and get_text().
- Method
insert_range
GTK2.TextBufferinsert_range(GTK2.TextIteriter,GTK2.TextIterstart,GTK2.TextIterend)- Description
Copies text, tags, and pixbufs between start and end (the order of start and end doesn't matter) and inserts the copy at iter. Used instead of simply getting/inserting text because it preserves images and tags. If start and end are in a different buffer from this buffer, the two buffers must share the same tag table.
Implemented via emissions of the insert-text and apply-tag signals, so expect those.
- Method
insert_range_interactive
intinsert_range_interactive(GTK2.TextIteriter,GTK2.TextIterstart,GTK2.TextIterend,intdefault_editable)- Description
Same as insert_range(), but does nothing if the insertion point isn't editable. The default_editable parameter indicates whether the text is editable at iter if no tags enclosing iter affect editability.
- Method
insert_with_tags
GTK2.TextBufferinsert_with_tags(GTK2.TextIteriter,stringtext,intlen,arraytags)- Description
Inserts text into the buffer at iter, applying the list of tags to the newly-inserted text. Equivalent to calling insert(), then apply_tag() on the insert text; insert_with_tags() is just a convenience function.
- Method
insert_with_tags_by_name
GTK2.TextBufferinsert_with_tags_by_name(GTK2.TextIteriter,stringtext,intlen,arraytag_names)- Description
Same as insert_with_tags(), but allows you to pass in tag names instead of tag objects.
- Method
move_mark
GTK2.TextBuffermove_mark(GTK2.TextMarkmark,GTK2.TextIterwhere)- Description
Moves mark to the new location where. Emits the "mark-set" signal as notification of the move.
- Method
move_mark_by_name
GTK2.TextBuffermove_mark_by_name(stringname,GTK2.TextIterwhere)- Description
Moves the mark named name (which must exist) to location where.
- Method
paste_clipboard
GTK2.TextBufferpaste_clipboard(GTK2.Clipboardclipboard,int|voiddefault_editable,GTK2.TextIterlocation)- Description
Pastes the contents of a clipboard at the insertion point, or at override_location.
- Method
place_cursor
GTK2.TextBufferplace_cursor(GTK2.TextIterwhere)- Description
This function moves the "insert" and "selection_bound" marks simultaneously. If you move them to the same place in two steps with move_mark(), you will temporarily select a region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized.
- Method
remove_all_tags
GTK2.TextBufferremove_all_tags(GTK2.TextIterstart,GTK2.TextIterend)- Description
Removes all tags in the range between start and end. Be careful with this function; it could remove tags added in code unrelated to the code you're currently writing. That is, using this function is probably a bad idea if you have two or more unrelated code sections that add tags.
- Method
remove_selection_clipboard
GTK2.TextBufferremove_selection_clipboard(GTK2.Clipboardclipboard)- Description
Removes a clipboard that was added with add_selection_clipboard().
- Method
remove_tag
GTK2.TextBufferremove_tag(GTK2.TextTagtag,GTK2.TextIterstart,GTK2.TextIterend)- Description
Emits the "remove-tag" signal. The default handler for the signal removes all occurrences of tag from the given range. start and end do not have to be in order.
- Method
remove_tag_by_name
GTK2.TextBufferremove_tag_by_name(stringname,GTK2.TextIterstart,GTK2.TextIterend)- Description
Removes a tag. See apply_tag_by_name().
- Method
select_range
GTK2.TextBufferselect_range(GTK2.TextIterins,GTK2.TextIterbound)- Description
This function removes the "insert" and "selection_bound" marks simultaneously. If you move them in two steps with move_mark(), you will temporarily select a region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized.
- Method
set_modified
GTK2.TextBufferset_modified(intsetting)- Description
Used to keep track of whether the buffer has been modified since the last time it was saved. Whenever the buffer is saved to disk, call set_modified(0). When the buffer is modified, it will automatically toggle on the modified bit again. When the modifed bit flips, the buffer emits a "modified-changed" signal.
Class GTK2.TextChildAnchor
- Description
Anchors for embedding widgets in a TextBuffer.
- Method
create
GTK2.TextChildAnchorGTK2.TextChildAnchor()- Description
Creates a new W(TextChildAnchor). Usually you would then insert it into W(TextBuffer) with W(TextBuffer)->insert_child_anchor(). To perform the creation and insertion in one step, use the convenience function W(TextBuffer)->create_child_anchor().
- Method
get_deleted
intget_deleted()- Description
Determines whether a child anchor has been deleted from the buffer.
Class GTK2.TextIter
- Description
A TextIter.
- Method
backward_char
intbackward_char()- Description
Moves backward by one character offset. Returns true if the movement was possible; if it was the first in the buffer (character offset 0), backward_char() returns false for convenience when writing loops.
- Method
backward_chars
intbackward_chars(intcount)- Description
Moves count characters backward, if possible (if count would mmove past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if it didn't move, or moved onto the end iterator, then false is returned. If count is 0, the function does nothing and returns false.
- Method
backward_cursor_position
intbackward_cursor_position()- Description
Like forward_cursor_position(), but moves backward.
- Method
backward_cursor_positions
intbackward_cursor_positions(intcount)- Description
Moves up to count cursor positions.
- Method
backward_line
intbackward_line()- Description
Moves to the start of the previous line. Returns true if this iter could be moved; i.e. if iter was at character offset 0, this function returns false. Therefore if it was already on line 0, but not at the start of the line, it is snapped to the start of the line and the function returns true. (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.)
- Method
backward_search
arraybackward_search(stringstr,intflags,GTK2.TextIterlimit)- Description
Same as forward_search(), but searches backward.
- Method
backward_sentence_start
intbackward_sentence_start()- Description
Moves backward to the previous sentence start.
- Method
backward_sentence_starts
intbackward_sentence_starts(intcount)- Description
Call backward_sentence_start() count times.
- Method
backward_to_tag_toggle
intbackward_to_tag_toggle(GTK2.TextTagtag)- Description
Moves backward to the next toggle. See forward_to_tag_toggle().
- Method
backward_visible_cursor_position
intbackward_visible_cursor_position()- Description
Moves backward to the previous visible cursor position.
- Method
backward_visible_cursor_positions
intbackward_visible_cursor_positions(intcount)- Description
Moves up to count visible cursor positions.
- Method
backward_visible_line
intbackward_visible_line()- Description
Moves to the start of the previous visible line. Returns TRUE if iter could be moved; i.e. if iter was at character offset 0, this function returns FALSE. Therefore if iter was alreayd on line 0, but not at the start of the line, iter is snapped to the start of the line and the function returns TRUE. (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0).
- Method
backward_visible_lines
intbackward_visible_lines(intcount)- Description
Moves count visible lines backward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then FALSE is returned. If count is 0, the function does nothing and returns FALSE. If count is negative, moves forward by 0 - count lines.
- Method
backward_visible_word_start
intbackward_visible_word_start()- Description
Moves backward to the previous visible word start.
- Method
backward_visible_word_starts
intbackward_visible_word_starts(intcount)- Description
Call backward_visible_word_start() count times
- Method
backward_word_start
intbackward_word_start()- Description
Moves backward to the previous word start.
- Method
backward_word_starts
intbackward_word_starts(intcount)- Description
Calls backward_word_start() up to count times.
- Method
begins_tag
intbegins_tag(GTK2.TextTagtag)- Description
Returns true if tag is toggled on at exactly this point. If tag is omitted, returns true if any tag is toggled on at this point. Note that begins_tag() returns true if this iter is the start of the tagged range; has_tag() tells you whether an iterator is within a tagged range.
- Method
can_insert
intcan_insert(intdefault_editability)- Description
Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted here would be editabled. If text inserted here would be editabled then the user should be allowed to insert text here. insert_interactive() uses this function to decide whether insertions are allowed at a given position.
- Method
compare
intcompare(GTK2.TextIterrhs)- Description
Returns -1 if this iterator is less than rhs, 1 if greater than, and 0 if they're equal. Ordering is in character offset order, i.e. the first character in the buffer is less than the second character in the buffer.
- Method
editable
inteditable(intdefault_setting)- Description
Returns whether the character at this location is within an editable region of text. Non-editable text is "locked" and can't be changed by the user via W(TextView). This function is simply a convenience wrapper around get_attributes(). If no tags applied to this text editability, default_setting will be returned.
You don't want to use this function to decide whether text can be inserted here, because for insertion you don't want to know whether the char at iter is inside an editable range, you want to know whether a new characer inserted here would be inside an editable range. Use can_insert() to handle this case.
- Method
ends_line
intends_line()- Description
Returns true if iter points to the start of the paragraph delimiter characters for a line (delimiters will be either a newline, a carriage return, a carriage return followed by a newline, or a Unicode paragraph separator character). Note that an iterator pointing to the \n of a \r\n pair will not be counted as the end of a line, the line ends before the \r. The end iterator is considered to be at the end of a line, even though there are no paragraph delimiter chars there.
- Method
ends_tag
intends_tag(GTK2.TextTagtag)- Description
Returns true if tag is toggled off at exactly this point. If tag is omitted, returns true if any tag is toggled off at this point. Not that ends_tag() returns true if this iter it at the end of the tagged range; has_tag() tells you whether an iterator is within a tagged range.
- Method
ends_word
intends_word()- Description
Determines whether this iter ends a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms).
- Method
equal
intequal(GTK2.TextIterrhs)- Description
Tests whether two iterators are equal, using the fastest possible mechanism. This function is very fast; you can expect it to perform better than e.g. getting the character offset for each iterator and comparing offsets yourself. Also, it's a bit faster than compare().
- Method
forward_char
intforward_char()- Description
Moves this iterator forward by one character offset. Note that images embedded in the buffer occopy 1 character slot, to forward_char() may actually move onto an image instead of a character, if you have images in your buffer. If this iterator is the end iterator or one character before it, it will now point at the end iterator, and forward_char() returns false for convenience when writing loops.
- Method
forward_chars
intforward_chars(intcount)- Description
Moves count characters if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the new position is different from its original position, and dereferenceable (the last iterator in the buffer is not). If count is 0, the function does nothing and returns false.
- Method
forward_cursor_position
intforward_cursor_position()- Description
Moves this iterator forward by a single cursor position. Cursor positions are (unsurprisingly) positions where the cursor can appear. Perhaps surprisingly, there may not be a cursor position between all characters. The most common example for European languages would be a carriage return/newline sequence. For some Unicode characters, the equivalent of say the letter "a" with an accent mark will be represented as two characters, first the letter then a "combining mark" that causes the accent to be rendered; so the cursor can't go between those two characters. See also Pango.LogAttr and pango_break().
- Method
forward_cursor_positions
intforward_cursor_positions(intcount)- Description
Moves up to count cursor positions.
- Method
forward_line
intforward_line()- Description
Moves to the start of the next line. Returns true if there was a next line to move to, and false if this iter was simply moved to the end of the buffer and is now not dereferenceable, or if it was already at the end of the buffer.
- Method
forward_lines
intforward_lines(intcount)- Description
Moves count lines forward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then false is returned. If count is 0, the function does nothing and returns false. If count is negative, moves backward by 0 - count lines.
- Method
forward_search
arrayforward_search(stringstr,intflags,GTK2.TextIterlimit)- Description
Searches forward for str. Returns two GTK2.TextIter objects, one pointing to the first character of the match, and the second pointing to the first character after the match. The search will not continue past limit. Note that a search is a linear or O(n) operation, so you may wish to use limit to avoid locking up your UI on large buffers.
If the GTK2.TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisible text interspersed in str, i.e. str will be a possibly non-contiguous subsequence of the matched range. Similarly, if you specify GTK2.TEXT_SEARCH_TEXT_ONLY, the match may have pixbufs or child widgets mixed inside the matched range. If these flags are not given, the match must be exact; the special 0xFFFC character in str will match embedded pixbufs or child widgets.
- Method
forward_sentence_end
intforward_sentence_end()- Description
Moves forward to the next sentence end.
- Method
forward_sentence_ends
intforward_sentence_ends(intcount)- Description
Call forward_sentence_ends() count times.
- Method
forward_to_end
GTK2.TextIterforward_to_end()- Description
Moves forward to the "end iterator", which points one past the last valid character in the buffer. get_char() called on the end iterator returns 0, which is convenient for writing loops.
- Method
forward_to_line_end
intforward_to_line_end()- Description
Moves the iterator to point to the paragraph delimiter characters, which will be either a newline, a carriage return, a carriage return/newline sequence, or the Unicode paragraph separator character. If the iterator is already at the paragraph delimiter characters, moves to the paragraph delimiter characters for the next line. If iter is on the last line in the buffer, which does not end in paragraph delimiters, moves to the end iterator (end of the last line), and returns false.
- Method
forward_to_tag_toggle
intforward_to_tag_toggle(GTK2.TextTagtag)- Description
Moves forward to the next toggle (on or off) of tag, or to the next toggle of any tag if tag is omitted. If no matching tag toggles are found, returns false, otherwise true. Does not return toggles located at this iter, only toggles after. Sets this iter to the location of the toggle, or to the end of the buffer if no toggle is found.
- Method
forward_visible_cursor_position
intforward_visible_cursor_position()- Description
Moves forward to the next visible cursor position.
- Method
forward_visible_cursor_positions
intforward_visible_cursor_positions(intcount)- Description
Moves up to count visible cursor positions.
- Method
forward_visible_line
intforward_visible_line()- Description
Moves to the start of the next visible line. Returns TRUE if there was a next line to move to, and FALSE if iter was simply moved to the end of the buffer and is now not dereferenceable, or if iter was already at the end of the buffer.
- Method
forward_visible_lines
intforward_visible_lines(intcount)- Description
Moves count visible lines forward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then FALSE is returned. If count is 0, the function does nothing and returns FALSE. If count is negative, moves backward by 0 - count lines.
- Method
forward_visible_word_end
intforward_visible_word_end()- Description
Moves forward to the next visible word end.
- Method
forward_visible_word_ends
intforward_visible_word_ends(intcount)- Description
Call forward_visible_word_end() count times.
- Method
forward_word_ends
intforward_word_ends(intcount)- Description
Calls forward_word_end() up to count times.
- Method
get_buffer
GTK2.TextBufferget_buffer()- Description
Returns the W(TextBuffer) this iterator is associated with.
- Method
get_bytes_in_line
intget_bytes_in_line()- Description
Returns the number of bytes in the line, including the paragraph delimiters.
- Method
get_char
intget_char()- Description
Returns the Unicode character at this iterator. If the element at this iterator is a non-character element, such as an image embedded in the buffer, the Unicode "unknown" character 0xFFFc is returned.
- Method
get_chars_in_line
intget_chars_in_line()- Description
Returns the number of characters in the line, including the paragraph delimiters.
- Method
get_child_anchor
GTK2.TextChildAnchorget_child_anchor()- Description
If this location contains a child anchor, the anchor is returned.
- Method
get_line_index
intget_line_index()- Description
Returns the byte index of the iterator, counting from the start of a newline-terminated line. Rember that W(TextBuffer) encodes text in UTF-8, and that characters can require a variable number of bytes to represent.
- Method
get_line_offset
intget_line_offset()- Description
Returns the character offset of the iterator, counting from the start of a newline-terminated line.
- Method
get_marks
arrayget_marks()- Description
Returns a list of W(TextMark) at this location. Because marks are not iterable (they don't take up any "space" in the buffer, they are just marks in between iterable locations), multiple marks can exist in the same place. The returned list is not in any meaningful order.
- Method
get_pixbuf
GTK2.GdkPixbufget_pixbuf()- Description
If the element at iter is a pixbuf, it is returned.
- Method
get_slice
stringget_slice(GTK2.TextIterend)- Description
Returns the text in the given range. A "slice" is an array of characters including the Unicode "unknown" character 0xFFFC for iterable non-character elements in the buffer, such as images. Because images are encoded in the slice, byte and character offsets in the returned array will correspond to bytes offsets in the text buffer. Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer.
- Method
get_tags
arrayget_tags()- Description
Returns a list of tags that apply to iter, in ascending order of priority (highest-priority tags are last).
- Method
get_text
stringget_text(GTK2.TextIterend)- Description
Returns text in the given range. If the range contains non-text elements such as images, the character and byte offsets in the returned string will not correspond to character and bytes offsets in the buffer.
- Method
get_toggled_tags
arrayget_toggled_tags(inttoggled_on)- Description
Returns a list of W(TextTag) that are toggled on or off at this point. (If toggled_on is true, the list contains tags that are toggled on). If a tag is toggled on at this iterator, then some non-empty range of characters following this iter has that tag applied to it. If a tag is toggled off, then some non-empty range following this iter does not have the tag applied to it.
- Method
get_visible_line_index
intget_visible_line_index()- Description
Returns the number of bytes from the start of the line to this iter, not counting bytes that are invisible due to tags with the invisible flag toggled on.
- Method
get_visible_line_offset
intget_visible_line_offset()- Description
Returns the offset in characters from the start of the line, not not counting characters that are invisible due to tags with the invisible tag toggled on.
- Method
get_visible_slice
stringget_visible_slice(GTK2.TextIterend)- Description
Like get_slice(), but invisible text is not included.
- Method
get_visible_text
stringget_visible_text(GTK2.TextIterend)- Description
Like get_text(), but invisible text is not include.
- Method
has_tag
inthas_tag(GTK2.TextTagtag)- Description
Returns true if this iterator is within a range tagged with tag.
- Method
in_range
intin_range(GTK2.TextIterstart,GTK2.TextIterend)- Description
Checks whether this iterator falls in the range [start,end). start and end must be in ascending order.
- Method
inside_sentence
intinside_sentence()- Description
Determines whether this is inside a sentence (as opposed to int between two sentences, e.g. after a period and before the first letter of the next sentence). Sentence boundaries are determined by Pango and should be correct for nearly language (if not, the correct fix would be to the Pango text boundary algorithms).
- Method
inside_word
intinside_word()- Description
Determines whether this iter is inside a natural-language word ass opposed to say inside some whitespace).
- Method
is_cursor_position
intis_cursor_position()- Description
See forward_cursor_position() or Pango.LangAttr or pango_break() for details on what a cursor position is.
- Method
is_end
intis_end()- Description
Returns true if this location is the end iterator, i.e. one past the last dereferenceable iterator in the buffer. is_end() is the most efficient way to check whether an iterator is the end iterator.
- Method
is_start
intis_start()- Description
Returns true if this is the first iterator in the buffer, that is if it has a character offset of 0.
- Method
order
GTK2.TextIterorder(GTK2.TextItersecond)- Description
Swaps this iter for second if second comes first in the buffer. That is, ensures that this iterator and second are in sequence. Most text buffer functions that take a range call this automatically on your behalf, so there's no real reason to call it yourself in those cases. There are some exceptions, such as in_range(), that expect a pre-sorted range.
- Method
set_line
GTK2.TextIterset_line(intline_number)- Description
Moves the iterator to the start of the line line_number. If line_number is negative or larger than the number of lines in the buffer, moves to the start of the last line in the buffer.
- Method
set_line_index
GTK2.TextIterset_line_index(intindex)- Description
Same as set_line_offset(), but works with a byte index. The given byte index must be at the start of a character, it can't be in the middle of a UTF-8 encoded character.
- Method
set_line_offset
GTK2.TextIterset_line_offset(intoffset)- Description
Moves iterator within a line, to a new character (not byte) offset. The given character offset must be less than or equal to the number of characters in the line; if equal, iterator moves to the start of the next line. See set_line_index() if you have a byte index rather than a character offset.
- Method
set_offset
GTK2.TextIterset_offset(intchar_offset)- Description
Sets to point to char_offset. char_offset counts from the start of the entire text buffer, starting with 0.
- Method
set_visible_line_index
GTK2.TextIterset_visible_line_index(intindex)- Description
Same as set_line_index(), but works with visible byte index. The given byte index must be at the start of a character, it can't be in the middle of a UTF-8 encoded character.
- Method
set_visible_line_offset
GTK2.TextIterset_visible_line_offset(intoffset)- Description
Like set_line_offset(), but the offset is in visible characters, i.e. text with a tag making it invisible is not counted in the offset.
- Method
starts_line
intstarts_line()- Description
Returns true if this iter begins a paragraph, i.e. if get_line_offset() would return 0. However this function is potentially more efficient than get_line_offset() because it doesn't have to computer the offset, it just has to see whether it's 0.
- Method
starts_sentence
intstarts_sentence()- Description
Determines whether this iter begins a sentence.
- Method
starts_word
intstarts_word()- Description
Determines whether this iter begins a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms).
Class GTK2.TextMark
- Description
Marks for the text.
- Method
get_buffer
GTK2.TextBufferget_buffer()- Description
Gets the buffer this mark is located inside, or empty if the mark is deleted.
- Method
get_deleted
intget_deleted()- Description
Returns true if the mark has been removed from its buffer with delete_mark(). Marks can't be used once deleted.
- Method
get_left_gravity
intget_left_gravity()- Description
Determines whether the mark has left gravity.
- Method
set_visible
GTK2.TextMarkset_visible(intsetting)- Description
Sets the visibility of the mark; the insertion point is normally visible, i.e. you can see it as a vertical bar. Also the text widget uses a visible mark to indicate where a drop will occur when dragging-and-dropping text. Most other marks are not visible. Marks are not visible by default.
Class GTK2.TextTag
- Description
Properties: string background int background-full-height int background-full-height-set GDK2.Color background-gdk int background-set GDK2.Pixmap background-stipple int background-stipple-set int direction One of
TEXT_DIR_LTR,TEXT_DIR_NONEandTEXT_DIR_RTLint editable int editable-set string family int family-set string font Pango.FontDescription font-desc string foreground GDK2.Color foreground-gdk int foreground-set GDK2.Pixmap foreground-stipple int foreground-stipple-set int indent int indent-set int invisible int invisible_set int justification One ofJUSTIFY_CENTER,JUSTIFY_FILL,JUSTIFY_LEFTandJUSTIFY_RIGHTint justification-set string language; int language-set; int left-margin; int left-margin-set; string name; int pixels-above-lines; int pixels-above-lines-set; int pixels-below-lines; int pixels-below-lines-set; int pixels-inside-wrap; int pixels-inside-wrap-set; int right-margin; int right-margin-set; int rise; int rise-set; float scale; int scale-set; int size; double size-points; int size-set; int stretch; One ofPANGO_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 style; One ofPANGO_STYLE_ITALIC,PANGO_STYLE_NORMALandPANGO_STYLE_OBLIQUEint style-set; Pango.TabArray tabs int tabs-set; int underline; One ofPANGO_UNDERLINE_DOUBLE,PANGO_UNDERLINE_ERROR,PANGO_UNDERLINE_LOW,PANGO_UNDERLINE_NONEandPANGO_UNDERLINE_SINGLEint underline-set; int variant; One ofPANGO_VARIANT_NORMALandPANGO_VARIANT_SMALL_CAPSint variant-set; int weight; int weight-set; int wrap-mode; One ofWRAP_CHAR,WRAP_NONE,WRAP_WORDandWRAP_WORD_CHARint wrap-mode-set;Signals: event
- Method
create
GTK2.TextTagGTK2.TextTag(string|mappingname_or_props)- Description
Creates a new text tag.
- Method
event
intevent(GTK2.G.Objectevent_object,GTK2.GdkEventevent,GTK2.TextIteriter)- Description
Emits the 'event' signal.
Class GTK2.TextTagTable
- Description
Table of text tags.
Signals: tag_added
tag_changed
tag_removed
- Method
add
GTK2.TextTagTableadd(GTK2.TextTagtag)- Description
Add a tag to the table. The tag is assigned the highest priority in the table.
Class GTK2.TextView
- Description
Properties: int accepts-tab GTK2.TextBuffer buffer int cursor-visible int editable int indent int justification int left-margin int overwrite int pixels-above-lines int pixels-below-lines int pixels-inside-wrap int right-margin Pango.TabArray tabs int wrap-mode
Style properties: GDK2.Color error-underline-color
Signals: backspace
copy_clipboard
cut_clipboard
delete_from_cursor
insert_at_cursor
move_cursor
move_focus
move_viewport
page_horizontally
paste_clipboard
populate_popup
select_all
set_anchor
set_scroll_adjustments
toggle_overwrite
- Method
add_child_at_anchor
GTK2.TextViewadd_child_at_anchor(GTK2.Widgetchild,GTK2.TextChildAnchoranchor)- Description
Adds a child widget in the text buffer, at the given anchor.
- Method
add_child_in_window
GTK2.TextViewadd_child_in_window(GTK2.Widgetchild,intwintype,intxpos,intypos)- Description
Adds a child at fixed coordinates in one of the text widget's windows. The window must have nonzero size (see GTK2.TextView->set_border_window_size()). Note that the child coordinates are given relative to the GDK2.Window in question, and that these coordinates have no sane relationship to scrolling. When placing a child in GTK2.TEXT_WINDOW_WIDGET, scrolling is irrelevant, the child floats above all scrollable areas. But when placing a child in one of the scrollable windows (border windows or text window), you'll need to compute the child's correct position in buffer coordinates any time scrolling occurs or buffer changes occur, and then call GTK2.TextView->move_child() to update the child's position. Unfortunately there's no good way to detect that scrolling has occurred, using the current API; a possible hack would be to update all child positions when the scroll adjustments change or the text buffer changes.
- Method
backward_display_line
intbackward_display_line(GTK2.TextIteriter)- Description
See forward_display_line().
- Method
backward_display_line_start
intbackward_display_line_start(GTK2.TextIteriter)- Description
Moves the iter backward to the next display line start.
- Method
buffer_to_window_coords
arraybuffer_to_window_coords(intwintype,intbuffer_x,intbuffer_y)- Description
Converts coordinate (buffer_x,buffer_y) to coordinates for the window win, and returns the results. wintype is one of
TEXT_WINDOW_BOTTOM,TEXT_WINDOW_LEFT,TEXT_WINDOW_PRIVATE,TEXT_WINDOW_RIGHT,TEXT_WINDOW_TEXT,TEXT_WINDOW_TOPandTEXT_WINDOW_WIDGET.
- Method
create
GTK2.TextViewGTK2.TextView(GTK2.TextBufferbuffer_or_props)- Description
Create a new W(TextView).
- Method
forward_display_line
intforward_display_line(GTK2.TextIteriter)- Description
Moves iter forward by one display (wrapped) line. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view's width; paragraphs are the same in all view, since they depend on the contents of the W(TextBuffer).
- Method
forward_display_line_end
intforward_display_line_end(GTK2.TextIteriter)- Description
Moves the iter forward to the next display line end.
- Method
get_accepts_tab
intget_accepts_tab()- Description
Returns whether pressing the Tab key inserts a tab character.
- Method
get_border_window_size
intget_border_window_size(intwintype)- Description
Gets the width of the specified border window.
- Method
get_cursor_visible
intget_cursor_visible()- Description
Find out whether the cursor is being displayed.
- Method
get_default_attributes
GTK2.TextAttributesget_default_attributes()- Description
Obtains a copy of the default text attributes. These are the attributes used for text unless a tag overrides them.
- Method
get_iter_at_location
GTK2.TextIterget_iter_at_location(intx,inty)- Description
Retrieves the iterator at buffer coordinates x and y. Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portions. If you have coordinates from an event, you have to convert those to buffer coordinates with window_to_buffer_coords().
- Method
get_iter_at_position
GTK2.TextIterget_iter_at_position(intx,inty)- Description
Retrieves the iterator pointing to the character at buffer coordinates x and y.
- Method
get_iter_location
GTK2.GdkRectangleget_iter_location(GTK2.TextIteriter)- Description
Gets a rectangle which roughly contains the character at iter. The rectangle position is in buffer coordinates; use buffer_to_window_coords() to convert these coordinates to coordinates for one of the windows in the text view.
- Method
get_left_margin
intget_left_margin()- Description
Gets the default left margin size of paragraphs.
- Method
get_line_at_y
GTK2.TextIterget_line_at_y(inty)- Description
Returns a W(TextIter) for the start of the line containing the coordinate y. y is in buffer coordinates, convert from window coordinates with window_to_buffer_coords().
- Method
get_line_yrange
mappingget_line_yrange(GTK2.TextIteriter)- Description
Gets the y coordinate of the top of the line containing iter, and the height of the line. The coordinate is a buffer coordinate; convert to window coordinates with buffer_to_window_coords().
- Method
get_overwrite
intget_overwrite()- Description
Returns whether the view is in overwrite mode or not.
- Method
get_pixels_above_lines
intget_pixels_above_lines()- Description
Gets the default number of pixels to put above paragraphs.
- Method
get_pixels_below_lines
intget_pixels_below_lines()- Description
Gets the value set by set_pixels_below_lines().
- Method
get_pixels_inside_wrap
intget_pixels_inside_wrap()- Description
Gets the value set by set_pixels_inside_wrap().
- Method
get_right_margin
intget_right_margin()- Description
Gets the default right margin size of paragraphs.
- Method
get_tabs
GTK2.Pango.TabArrayget_tabs()- Description
Gets the default tabs. Tags in the buffer may override the defaults. The return value will be 0 if "standard" (8-space) tabs are used.
- Method
get_visible_rect
GTK2.GdkRectangleget_visible_rect()- Description
Returns a rectangle with the currently-visible region of the buffer, in buffer coordinates. Convert to window coordinates with buffer_to_window_coords().
- Method
get_window
GTK2.GdkWindowget_window(intwintype)- Description
Retrieves the GDK2.Window corresponding to an area of the text view; possible windows include the overall widget window, child windows on the left, right, top, bottom, and the window that displays the text buffer. Windows are 0 and nonexistent if their width or height is 0, and are nonexistent before the widget has been realized.
- Method
get_window_type
intget_window_type(GTK2.GdkWindowwindow)- Description
Usually used to find out which window an event corresponds to. If you connect to an event signal, this function should be called on event->window to see which window it was. One of
TEXT_WINDOW_BOTTOM,TEXT_WINDOW_LEFT,TEXT_WINDOW_PRIVATE,TEXT_WINDOW_RIGHT,TEXT_WINDOW_TEXT,TEXT_WINDOW_TOPandTEXT_WINDOW_WIDGET.
- Method
move_child
GTK2.TextViewmove_child(GTK2.Widgetchild,intx,inty)- Description
Updates the position of a child.
- Method
move_mark_onscreen
intmove_mark_onscreen(GTK2.TextMarkmark)- Description
Moves a mark within the buffer so that it's located within the currently visible text-area.
- Method
move_visually
intmove_visually(GTK2.TextIteriter,intcount)- Description
Move the iterator a given number of characters visually, treating it as the strong cursor position. If count is positive, then the new strong cursor position will be count positions to the right of the old cursor position. If count is negative then the new strong cursor position will be count positions to the left of the old cursor position.
In the presence of bidirection text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off the end of a run.
- Method
place_cursor_onscreen
intplace_cursor_onscreen()- Description
Moves the cursor to the currently visible region of the buffer, if it isn't there already.
- Method
scroll_mark_onscreen
GTK2.TextViewscroll_mark_onscreen(GTK2.TextMarkmark)- Description
Scrolls the view the minimum distance such that mark is contained within the visible area.
- Method
scroll_to_iter
GTK2.TextViewscroll_to_iter(GTK2.TextIteriter,floatwithin_margin,intuse_align,floatxalign,floatyalign)- Description
Scrolls the view so that iter is on the screen as with scroll_to_mark().
- Method
scroll_to_mark
GTK2.TextViewscroll_to_mark(GTK2.TextMarkmark,floatwithin_margin,intuse_align,floatxalign,floatyalign)- Description
Scrolls the view so that mark is on the screen in the position indicated by xalign and yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or bottom, 0.5 means center. If use_align is false, the text scrolls the minimal distance to get the mark onscreen, possibly not scrolling at all. The effective screen for purposes of this function is reduced by the margin of size within_margin.
- Method
set_accepts_tab
GTK2.TextViewset_accepts_tab(intaccepts_tab)- Description
Sets the behavior of the text widget when the Tab key is pressed. If accepts_tab is true a tab character is inserted. If accepts_tab is false the keyboard focus is moved to the next widget in the focus chain.
- Method
set_border_window_size
GTK2.TextViewset_border_window_size(intwintype,intsize)- Description
Sets the width of GTK2.TEXT_WINDOW_LEFT or GTK2.TEXT_WINDOW_RIGHT, or the height of GTK2.TEXT_WINDOW_TOP or GTK2.TEXT_WINDOW_BOTTOM. Automatically destroys the corresponding window if the size is set to 0, and creates the window if the size is set to non-zero. This function can only be used for the "border windows", it doesn't work with GTK2.TEXT_WINDOW_WIDGET, GTK2.TEXT_WINDOW_TEXT, or GTK2.TEXT_WINDOW_PRIVATE.
- Method
set_buffer
GTK2.TextViewset_buffer(GTK2.TextBufferbuffer)- Description
Sets buffer as the buffer being displayed.
- Method
set_cursor_visible
GTK2.TextViewset_cursor_visible(intsetting)- Description
Toggles whether the insertion point is displayed. A buffer with no editable text probably shouldn't have a visible cursor, so you may want to turn the cursor off.
- Method
set_editable
GTK2.TextViewset_editable(intsetting)- Description
Sets the default editability. You can override this default setting with tags in the buffer, using the "editable" attribute of tags.
- Method
set_indent
GTK2.TextViewset_indent(intindent)- Description
Sets the default indentation for paragraphs. May be overridden by tags.
- Method
set_justification
GTK2.TextViewset_justification(intjust)- Description
Sets the default justification of text. One of
JUSTIFY_CENTER,JUSTIFY_FILL,JUSTIFY_LEFTandJUSTIFY_RIGHT.
- Method
set_left_margin
GTK2.TextViewset_left_margin(intmargin)- Description
Sets the default left margin. May be overridden by tags.
- Method
set_overwrite
GTK2.TextViewset_overwrite(intoverwrite)- Description
Changes the overwrite mode, true for on, false for off.
- Method
set_pixels_above_lines
GTK2.TextViewset_pixels_above_lines(intpixels)- Description
Sets the default number of blank pixels above paragraphs. Tags in the buffer may override the defaults.
- Method
set_pixels_below_lines
GTK2.TextViewset_pixels_below_lines(intpixels)- Description
Sets the default number of blank pixels to put below paragraphs. May be overridden by tags applied to the buffer.
- Method
set_pixels_inside_wrap
GTK2.TextViewset_pixels_inside_wrap(intpixels)- Description
Sets the default number of pixels of blank space to leave between displayed/wrapped lines within a paragraph. May be overridden by tags.
- Method
set_right_margin
GTK2.TextViewset_right_margin(intmargin)- Description
Sets the default right margin. May be overridden by tags.
- Method
set_tabs
GTK2.TextViewset_tabs(GTK2.Pango.TabArraytabs)- Description
Sets the default tab stops for paragraphs. Tags in the buffer may override the default.
- Method
set_wrap_mode
GTK2.TextViewset_wrap_mode(intwrap_mode)- Description
Sets the line wrapping. One of
WRAP_CHAR,WRAP_NONE,WRAP_WORDandWRAP_WORD_CHAR.
- Method
starts_display_line
intstarts_display_line(GTK2.TextIteriter)- Description
Determines whether iter is at the start of a display line.
Class GTK2.ToggleAction
- Description
Properties int active int draw-as-radio
Signals: toggled
- Method
create
GTK2.ToggleActionGTK2.ToggleAction(string|mappingname_or_props,string|voidlabel,string|voidtooltip,string|voidstock_id)- Description
Creates a new GTK2.ToggleAction object.
- Method
get_draw_as_radio
intget_draw_as_radio()- Description
Returns whether the action should have proxies like a radio action.
- Method
set_draw_as_radio
GTK2.ToggleActionset_draw_as_radio(intsetting)- Description
Sets whether the action should have proxies like a radio action.
Class GTK2.ToggleButton
- Description
Toggle buttons are derived from normal buttons and are very similar, except they will always be in one of two states, alternated by a click. They may be depressed, and when you click again, they will pop back up. Click again, and they will pop back down.
 GTK2.ToggleButton("Toggle button")
 GTK2.ToggleButton("Toggle button")->set_active( 1 )
Properties: int active int draw-indicator int inconsistent
Signals: toggled
- Method
create
GTK2.ToggleButtonGTK2.ToggleButton(string|mappinglabel_or_props,int|voidmnemonic)- Description
If you supply a string, a label will be created and inserted in the button. Otherwise, use ->add(widget) to create the contents of the button.
- Method
get_active
intget_active()- Description
Returns true if button is pressed, and false if it is raised.
- Method
get_mode
intget_mode()- Description
Retrieves whether the button is displayed as a separator indicator and label.
- Method
set_active
GTK2.ToggleButtonset_active(intactivep)- Description
If activep is true, the toggle button will be activated.
- Method
set_inconsistent
GTK2.ToggleButtonset_inconsistent(intsetting)- Description
If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button, and the current values in that range are inconsistent, you may want to display the toggle in an "in between" state. This function turns on "in between" display.
Class GTK2.ToggleToolButton
- Description
A ToolItem containing a toggle button.
Signals: toggled
- Method
create
GTK2.ToggleToolButtonGTK2.ToggleToolButton(string|mappingstock_id)- Description
Creates a new toggle tool button, with or without a stock id.
- Method
get_active
intget_active()- Description
Returns the status of the toggle tool button, true if it is pressed in and false if it isn't.
Class GTK2.ToolButton
- Description
Properties that can be notified: icon-widget label label-widget stock-id use-underline
Signals: clicked
- Method
create
GTK2.ToolButtonGTK2.ToolButton(GTK2.Widgeticon,string|voidlabel)- Description
Create a new GTK2.ToolButton. If icon is a string, label should be omitted. If it isn't, it will be ignored. The result will be a button from a stock item, one of
STOCK_ABOUT,STOCK_ADD,STOCK_APPLY,STOCK_BOLD,STOCK_CANCEL,STOCK_CDROM,STOCK_CLEAR,STOCK_CLOSE,STOCK_COLOR_PICKER,STOCK_CONNECT,STOCK_CONVERT,STOCK_COPY,STOCK_CUT,STOCK_DELETE,STOCK_DIALOG_AUTHENTICATION,STOCK_DIALOG_ERROR,STOCK_DIALOG_INFO,STOCK_DIALOG_QUESTION,STOCK_DIALOG_WARNING,STOCK_DIRECTORY,STOCK_DISCONNECT,STOCK_DND,STOCK_DND_MULTIPLE,STOCK_EDIT,STOCK_EXECUTE,STOCK_FILE,STOCK_FIND,STOCK_FIND_AND_REPLACE,STOCK_FLOPPY,STOCK_FULLSCREEN,STOCK_GOTO_BOTTOM,STOCK_GOTO_FIRST,STOCK_GOTO_LAST,STOCK_GOTO_TOP,STOCK_GO_BACK,STOCK_GO_DOWN,STOCK_GO_FORWARD,STOCK_GO_UP,STOCK_HARDDISK,STOCK_HELP,STOCK_HOME,STOCK_INDENT,STOCK_INDEX,STOCK_INFO,STOCK_ITALIC,STOCK_JUMP_TO,STOCK_JUSTIFY_CENTER,STOCK_JUSTIFY_FILL,STOCK_JUSTIFY_LEFT,STOCK_JUSTIFY_RIGHT,STOCK_LEAVE_FULLSCREEN,STOCK_MEDIA_FORWARD,STOCK_MEDIA_NEXT,STOCK_MEDIA_PAUSE,STOCK_MEDIA_PLAY,STOCK_MEDIA_PREVIOUS,STOCK_MEDIA_RECORD,STOCK_MEDIA_REWIND,STOCK_MEDIA_STOP,STOCK_MISSING_IMAGE,STOCK_NETWORK,STOCK_NEW,STOCK_NO,STOCK_OK,STOCK_OPEN,STOCK_PASTE,STOCK_PREFERENCES,STOCK_PRINT,STOCK_PRINT_PREVIEW,STOCK_PROPERTIES,STOCK_QUIT,STOCK_REDO,STOCK_REFRESH,STOCK_REMOVE,STOCK_REVERT_TO_SAVED,STOCK_SAVE,STOCK_SAVE_AS,STOCK_SELECT_COLOR,STOCK_SELECT_FONT,STOCK_SORT_ASCENDING,STOCK_SORT_DESCENDING,STOCK_SPELL_CHECK,STOCK_STOP,STOCK_STRIKETHROUGH,STOCK_UNDELETE,STOCK_UNDERLINE,STOCK_UNDO,STOCK_UNINDENT,STOCK_YES,STOCK_ZOOM_100,STOCK_ZOOM_FIT,STOCK_ZOOM_INandSTOCK_ZOOM_OUT. If icon is a GTK2.Widget, it will be used as the icon, and label will be the label. The label must exists if that is the case.
- Method
get_icon_name
stringget_icon_name()- Description
Returns the name of the themed icon for the tool button.
- Method
get_icon_widget
GTK2.Widgetget_icon_widget()- Description
Returns the widget used as the icon widget.
- Method
get_label
stringget_label()- Description
Returns the label used by the tool button, or empty if the tool button doesn't have a label.
- Method
get_label_widget
GTK2.Widgetget_label_widget()- Description
Returns the widget used as the label.
- Method
get_use_underline
intget_use_underline()- Description
Returns whether underscores in the label property are used as mnemonics on menu items on the overflow menu.
- Method
set_icon_name
GTK2.ToolButtonset_icon_name(stringname)- Description
Sets the icon for the tool button from a named themed icon. The "icon-name" property only has an effect if not overridden by non-NULL "label", "icon-widget", and "stock-id" properties.
- Method
set_icon_widget
GTK2.ToolButtonset_icon_widget(GTK2.Widgeticon_widget)- Description
Sets icon_widget as the widget used as the icon on the button.
- Method
set_label
GTK2.ToolButtonset_label(stringlabel)- Description
Sets label as the label used for the tool button.
- Method
set_label_widget
GTK2.ToolButtonset_label_widget(GTK2.Widgetlabel_widget)- Description
Sets label_widget as the widget used as the label.
- Method
set_stock_id
GTK2.ToolButtonset_stock_id(stringstock_id)- Description
Sets the name of the stock item.
Class GTK2.ToolItem
- Description
Properties: int is-important int visible-horizontal int visible-vertical
Signals: create_menu_proxy
set_tooltip
toolbar_reconfigured
- Method
get_homogeneous
intget_homogeneous()- Description
Returns whether this item is the same size as the other homogeneous items.
- Method
get_icon_size
intget_icon_size()- Description
Returns the icon size used for this item. One of
ICON_SIZE_BUTTON,ICON_SIZE_DIALOG,ICON_SIZE_DND,ICON_SIZE_INVALID,ICON_SIZE_LARGE_TOOLBAR,ICON_SIZE_MENUandICON_SIZE_SMALL_TOOLBAR
- Method
get_is_important
intget_is_important()- Description
Returns whether this item is considered important.
- Method
get_orientation
intget_orientation()- Description
Returns the orientation used for this item. One of
ORIENTATION_HORIZONTALandORIENTATION_VERTICAL
- Method
get_proxy_menu_item
GTK2.Widgetget_proxy_menu_item(stringmenu_item_id)- Description
If menu_item_id matches the string passed to set_proxy_menu_item(), then return the corresponding GTK2.MenuItem.
- Method
get_relief_style
intget_relief_style()- Description
Returns the relief style of this item. One of
RELIEF_HALF,RELIEF_NONEandRELIEF_NORMAL
- Method
get_toolbar_style
intget_toolbar_style()- Description
Returns the toolbar style use for this item. One of
TOOLBAR_BOTH,TOOLBAR_BOTH_HORIZ,TOOLBAR_ICONS,TOOLBAR_SPACE_EMPTY,TOOLBAR_SPACE_LINEandTOOLBAR_TEXT
- Method
get_use_drag_window
intget_use_drag_window()- Description
Returns whether this item has a drag window.
- Method
get_visible_horizontal
intget_visible_horizontal()- Description
Returns whether this item is visible on toolbars that are docked horizontally.
- Method
get_visible_vertical
intget_visible_vertical()- Description
Returns whether this item is visible when the toolbar is docked vertically.
- Method
rebuild_menu
GTK2.ToolItemrebuild_menu()- Description
Calling this function signals to the toolbar that the overflow menu item for this item has changed. If the overflow menu is visible when this function is called, the menu will be rebuilt.
- Method
retrieve_proxy_menu_item
GTK2.Widgetretrieve_proxy_menu_item()- Description
Returns the GTK2.MenuItem that was last set by set_proxy_menu_item().
- Method
set_expand
GTK2.ToolItemset_expand(intexpand)- Description
Sets whether this item is allocated extra space when there is more room on the toolbar than needed for the items. The effect is that the item gets bigger when the toolbar gets bigger and smaller when the toolbar gets smaller.
- Method
set_homogeneous
GTK2.ToolItemset_homogeneous(inthomogeneous)- Description
Sets whether this item is to be allocated the same size as other homogeneous items. The effect is that all homogeneous items will have the same width as the widest of the items.
- Method
set_is_important
GTK2.ToolItemset_is_important(intis_important)- Description
Sets whether this item should be considered important.
- Method
set_proxy_menu_item
GTK2.ToolItemset_proxy_menu_item(stringmenu_item_id,GTK2.Widgetmenu_item)- Description
Sets the GTK2.MenuItem used in the toolbar overflow menu. The menu_item_id is used to identify the caller of this function and should also be used with get_proxy_menu_item().
- Method
set_tooltip
GTK2.ToolItemset_tooltip(GTK2.Tooltipstooltips,stringtip_text,stringtip_private)- Description
Sets the GTK2.Tooltips object to be used for this item, the text to be displayed as tool tip on the item and the private text to be used.
- Method
set_use_drag_window
GTK2.ToolItemset_use_drag_window(intuse_drag_window)- Description
Sets whether this item has a drag window. When true the toolitem can be used as a drag source. When this item has a drag window it will intercept all events, even those that would otherwise be sent to a child.
- Method
set_visible_horizontal
GTK2.ToolItemset_visible_horizontal(intvisible_horizontal)- Description
Sets whether toolitem is visible when the toolbar is docked horizontally.
- Method
set_visible_vertical
GTK2.ToolItemset_visible_vertical(intvisible_vertical)- Description
Sets whether this item is visible when the toolbar is docked vertically. Some tool items, such as text entries, are too wide to be useful on a vertically docked toolbar. If visible_vertical is false then this item will not appear on toolbars that are docked vertically.
Class GTK2.Toolbar
- Description
Toolbars are usually used to group some number of widgets in order to simplify customization of their look and layout. Typically a toolbar consists of buttons with icons, labels and tooltips, but any other widget can also be put inside a toolbar. Finally, items can be arranged horizontally or vertically and buttons can be displayed with icons, labels, or both.
Examples:
 GTK2.Toolbar()->insert(GTK2.ToolItem()->add(GTK2.Button("Button 1")),-1)->insert(GTK2.ToolItem()->add(GTK2.Label("     ")),-1)->insert(GTK2.ToolItem()->add(GTK2.Button("Button 2")),-1)->insert(GTK2.ToolItem()->add(GTK2.Button("Button 3")),-1)
 GTK2.Toolbar((["orientation":GTK2.ORIENTATION_VERTICAL]))->insert(GTK2.ToolItem()->add(GTK2.Button("Button 1")),-1)->insert(GTK2.ToolItem()->add(GTK2.Label("     ")),-1)->insert(GTK2.ToolItem()->add(GTK2.Button("Button 2")),-1)->insert(GTK2.ToolItem()->add(GTK2.Button("Button 3")),-1)
Properties: int icon-size int icon-size-set int orientation int show-arrow int toolbar-style int tooltips
Child properties: int expand int homogeneous
Style properties: int button-relief int internal-padding int shadow-type int space-size int space-style
Signals: orientation_changed
popup_context_menu
style_changed
- Method
get_drop_index
intget_drop_index(intx,inty)- Description
Returns the position corresponding to the indicated point on the toolbar. This is useful when dragging items to the toolbar: this function returns the position a new item should be inserted.
x and y are in toolbar coordinates.
- Method
get_icon_size
intget_icon_size()- Description
Retrieves the icon size for the toolbar. One of
ICON_SIZE_BUTTON,ICON_SIZE_DIALOG,ICON_SIZE_DND,ICON_SIZE_INVALID,ICON_SIZE_LARGE_TOOLBAR,ICON_SIZE_MENUandICON_SIZE_SMALL_TOOLBAR.
- Method
get_item_index
intget_item_index(GTK2.ToolItemitem)- Description
Returns the position of item on the toolbar, starting from 0.
- Method
get_nth_item
GTK2.ToolItemget_nth_item(intn)- Description
Returns the n's item on the toolbar, or empty if the toolbar does not contain an n'th item.
- Method
get_orientation
intget_orientation()- Description
Retrieves the current orientation of the toolbar.
- Method
get_show_arrow
intget_show_arrow()- Description
Returns whether the toolbar has an overflow menu.
- Method
get_style
intget_style()- Description
Retrieves whether the toolbar has text, icons, or both. One of
TOOLBAR_BOTH,TOOLBAR_BOTH_HORIZ,TOOLBAR_ICONS,TOOLBAR_SPACE_EMPTY,TOOLBAR_SPACE_LINEandTOOLBAR_TEXT;
- Method
insert
GTK2.Toolbarinsert(GTK2.ToolItemitem,intpos)- Description
Insert a W(ToolItem) into the toolbar at position pos. If pos is 0 the item is prepended to the start of the toolbar. If pos is negative, the item is appended to the end of the toolbar.
- Method
set_drop_highlight_item
GTK2.Toolbarset_drop_highlight_item(GTK2.ToolItemitem,intindex)- Description
Highlights the toolbar to give an ide aof what it would like if item was added at the position indicated by index.
The item passed to this function must not be part of any widget hierarchy. When an item is set as drop highlight item it can not be added to any widget hierarchy or used as highlight item for another toolbar.
- Method
set_orientation
GTK2.Toolbarset_orientation(intorientation)- Description
Sets whether a toolbar should appear horizontally or vertically. One of
ORIENTATION_HORIZONTALandORIENTATION_VERTICAL.
- Method
set_show_arrow
GTK2.Toolbarset_show_arrow(intshow_arrow)- Description
Sets whether to show an overflow menu when the toolbar doesn't have room for all items on it. If true, items for which there are not room are are available through an overflow menu.
- Method
set_style
GTK2.Toolbarset_style(intstyle)- Description
Set the style, one of
TOOLBAR_BOTH,TOOLBAR_BOTH_HORIZ,TOOLBAR_ICONS,TOOLBAR_SPACE_EMPTY,TOOLBAR_SPACE_LINEandTOOLBAR_TEXT
- Method
set_tooltips
GTK2.Toolbarset_tooltips(intenable)- Description
Sets if the tooltips should be active or not.
Class GTK2.Tooltips
- Description
Tooltips are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time. They are especially helpful for adding more verbose descriptions of things such as buttons in a toolbar.
An individual tooltip belongs to a group of tooltips. A group is created with a call to GTK2.Tooltips(). Every tooltip in the group can then be turned off with a call to disable() and enabled with enable().
The length of time the user must keep the mouse over a widget before the tip is shown, can be altered with set_delay(). This is set on a 'per group of tooltips' basis.
To assign a tip to a particular W(Widget), set_tip() is used.
The default appearance of all tooltips in a program is determined by the current gtk theme that the user has selected. To change the tooltip appearance manually, use set_colors(). Again, this is per group of tooltips.
- Method
create
GTK2.TooltipsGTK2.Tooltips()- Description
Creates an empty group of tooltips. This function initialises a GTK2.Tooltips structure. Without at least one such structure, you can not add tips to your application.
- Method
force_window
GTK2.Tooltipsforce_window()- Description
Realize the tooltip window (as returned from get_gdkwindow())
Class GTK2.TreeDragDest
- Method
drag_data_received
intdrag_data_received(GTK2.TreePathpath,GTK2.SelectionDatasel)- Description
Asks to insert a row before the path dest, deriving the contents of the row from the sel. If this dest is outside the tree so that inserting before it is impossible, false will be returned. Also, false may be returned if the new row is not created for some model-specific reason.
- Method
row_drop_possible
introw_drop_possible(GTK2.TreePathpath,GTK2.SelectionDatasel)- Description
Determines whether a drop is possible before past, at the same depth as path. i.e., can we drop the data in sel at that location. path does not have to exist; the return value will almost certainly be false if the parent of path doesn't exist, though.
- Method
drag_data_received
Class GTK2.TreeDragSource
- Method
drag_data_delete
intdrag_data_delete(GTK2.TreePathpath)- Description
Asks to delete the row at path, because it was moved somewhere else via drag-and-drop. Returns false if the deletion fails because path no longer exists, or for some model-specific reason.
- Method
drag_data_get
GTK2.SelectionDatadrag_data_get(GTK2.TreePathpath)- Description
Asks to return a representation of the row at path.
- Method
drag_data_delete
Class GTK2.TreeIter
- Description
TreeIter.
Class GTK2.TreeModel
- Description
The tree interface used by TreeView.
Signals: row_changed
row_deleted
row_has_child_toggled
row_inserted
rows_reordered
- Method
get_iter
GTK2.TreeIterget_iter(GTK2.TreePathpath)- Description
Returns a valid iterator pointer to path
- Method
get_iter_first
GTK2.TreeIterget_iter_first()- Description
Get GTK2.TreeIter with the first iterator in the tree ("0").
- Method
get_iter_from_string
GTK2.TreeIterget_iter_from_string(stringpath)- Description
Returns a valid iterator from a path string.
- Method
get_n_columns
intget_n_columns()- Description
Returns the number of columns suppported by this model.
- Method
get_path
GTK2.TreePathget_path(GTK2.TreeIteriter)- Description
Returns a GTK2.TreePath from iter.
- Method
get_string_from_iter
stringget_string_from_iter(GTK2.TreeIteriter)- Description
Get string representation of iter.
- Method
iter_children
GTK2.TreeIteriter_children(GTK2.TreeIterparent)- Description
Get first child of parent.
- Method
iter_n_children
intiter_n_children(GTK2.TreeIteriter)- Description
Returns the number of children this iter has.
- Method
iter_nth_child
GTK2.TreeIteriter_nth_child(GTK2.TreeIterparent,intindex)- Description
Get the child of parent using the given index. Returns valid GTK2.TreeIter if it exists, or 0. If the index is too big, or parent is invalid, then it returns the index from the root node.
- Method
iter_parent
GTK2.TreeIteriter_parent(GTK2.TreeIterchild)- Description
Get parent of child, or 0 if none.
- Method
row_changed
GTK2.TreeModelrow_changed(GTK2.TreePathpath,GTK2.TreeIteriter)- Description
Emit "row-changed" signal.
- Method
row_has_child_toggled
GTK2.TreeModelrow_has_child_toggled(GTK2.TreePathpath,GTK2.TreeIteriter)- Description
Emit "row-has-child-toggled" signal.
Class GTK2.TreeModelFilter
- Description
Properties: GTK2.TreeModel child-model GTK2.TreePath virtual-root
- Method
convert_child_iter_to_iter
GTK2.TreeIterconvert_child_iter_to_iter(GTK2.TreeIterchild_iter)- Description
Returns an iter pointing to the row in this model that corresponds to the row pointed at by child_iter.
- Method
convert_child_path_to_path
GTK2.TreePathconvert_child_path_to_path(GTK2.TreePathchild_path)- Description
Converts child_path to a path relative to this model. That is, child_path points to a path in the child mode. The returned path will point to the same row in the sorted model.
- Method
convert_iter_to_child_iter
GTK2.TreeIterconvert_iter_to_child_iter(GTK2.TreeItersorted_iter)- Description
Returns an iter pointing to the row in this model that corresponds to the row pointed at by sorted_iter.
- Method
convert_path_to_child_path
GTK2.TreePathconvert_path_to_child_path(GTK2.TreePathsorted_path)- Description
Converts sorted_path to a path on the child model.
- Method
create
GTK2.TreeModelFilterGTK2.TreeModelFilter(GTK2.TreeModelmodel,GTK2.TreePathroot)- Description
Create a new GTK2.TreeModel, with model as the child model.
- Method
refilter
GTK2.TreeModelFilterrefilter()- Description
Emits "row-changed" for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not.
Class GTK2.TreeModelSort
- Description
Properties: GTK2.TreeModel model
- Method
convert_child_iter_to_iter
GTK2.TreeIterconvert_child_iter_to_iter(GTK2.TreeIterchild_iter)- Description
Returns an iter pointing to the row in this model that corresponds to the row pointed at by child_iter.
- Method
convert_child_path_to_path
GTK2.TreePathconvert_child_path_to_path(GTK2.TreePathchild_path)- Description
Converts child_path to a path relative to this model. That is, child_path points to a path in the child mode. The returned path will point to the same row in the sorted model.
- Method
convert_iter_to_child_iter
GTK2.TreeIterconvert_iter_to_child_iter(GTK2.TreeItersorted_iter)- Description
Returns an iter pointing to the row in this model that corresponds to the row pointed at by sorted_iter.
- Method
convert_path_to_child_path
GTK2.TreePathconvert_path_to_child_path(GTK2.TreePathsorted_path)- Description
Converts sorted_path to a path on the child model.
- Method
create
GTK2.TreeModelSortGTK2.TreeModelSort(GTK2.TreeModelmodel)- Description
Create a new GTK2.TreeModel, with model as the child model.
- Method
reset_default_sort_func
GTK2.TreeModelSortreset_default_sort_func()- Description
This resets the default sort function to be in the 'unsorted' state. That is, it is in the same order as the child model. It will re-sort the model to be in the same order as the child model only if this model is in 'unsorted' state.
Class GTK2.TreePath
- Description
TreePath.
- Method
append_index
GTK2.TreePathappend_index(intindex)- Description
Appends a new index to path. As a result, the depth of the path is increased.
- Method
compare
intcompare(GTK2.TreePathb)- Description
Compares two paths. If this path appears before b, -1 is returned. If b before this path, 1 is return. If they are equal, 0 is returned.
- Method
down
GTK2.TreePathdown()- Description
Moves path to point to the first child of the current path.
- Method
get_indices
arrayget_indices()- Description
Returns the current indices of path as an array of integers, each representing a node in a tree.
- Method
is_ancestor
intis_ancestor(GTK2.TreePathdescendant)- Description
Returns TRUE if descendant is a descendant of this path.
- Method
is_descendant
intis_descendant(GTK2.TreePathancestor)- Description
Returns TRUE if this path is a descendant of ancestor.
- Method
next
GTK2.TreePathnext()- Description
Moves the path to point to the next node at the current depth.
- Method
prepend_index
GTK2.TreePathprepend_index(intindex)- Description
Prepends a new index to a path. As a result, the depth of the path is increased.
- Method
prev
GTK2.TreePathprev()- Description
Moves the path to point to the previous node at the current depth, if it exists. Returns TRUE if the move was made.
- Method
to_string
stringto_string()- Description
Generates a string representation of the path. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
Class GTK2.TreeRowReference
- Description
A TreeRowReference.
- Method
create
GTK2.TreeRowReferenceGTK2.TreeRowReference(GTK2.TreeModelmodel,GTK2.TreePathpath)- Description
Creates a row reference based on path. This reference will keep pointing to the node pointed to by path, so long as it exists.
- Method
get_model
GTK2.TreeModelget_model()- Description
Returns the model which this references is monitoring.
- Method
get_path
GTK2.TreePathget_path()- Description
Returns a path that the row reference currently points to.
Class GTK2.TreeSelection
- Description
Selections on a treestore.
Signals: changed
- Method
count_selected_rows
intcount_selected_rows()- Description
Returns the number of rows that have been selected.
- Method
get_selected
arrayget_selected()- Description
Returns a W(TreeITer) with the currently selected node if this selection is set to GTK2.SELECTION_SINGLE or GTK2.SELECTION_BROWSE. Also returns W(TreeModel) as a convenience. This function will not work if you this selection is set to GTK2.SELECTION_MULTIPLE.
- Method
get_selected_rows
arrayget_selected_rows(GTK2.TreeModelmodel)- Description
Creates a list of W(TreePath)'s for all selected rows. Additionally, if you are planning on modified the model after calling this function, you may want to convert the returned list into a list of W(TreeRowReference)s. To do this, you can use GTK2.TreeRowReference->create().
- Method
get_tree_view
GTK2.TreeViewget_tree_view()- Description
Returns the tree view associated with this selection.
- Method
get_user_data
objectget_user_data()- Description
Returns the user data for the selection function.
- Method
iter_is_selected
intiter_is_selected(GTK2.TreeIteriter)- Description
Returns true if the row at iter is currently selected.
- Method
path_is_selected
intpath_is_selected(GTK2.TreePathpath)- Description
Returns true if the row pointed to by path is currently selected. If path does not point to a valid location, false is returned.
- Method
select_all
GTK2.TreeSelectionselect_all()- Description
Selects all the nodes. This selection must be set to GTK2.SELECTION_MULTIPLE mode.
- Method
select_iter
GTK2.TreeSelectionselect_iter(GTK2.TreeIteriter)- Description
Selects the specified iterator.
- Method
select_path
GTK2.TreeSelectionselect_path(GTK2.TreePathpath)- Description
Select the row at path.
- Method
select_range
GTK2.TreeSelectionselect_range(GTK2.TreePathstart,GTK2.TreePathend)- Description
Selects a range of nodes, determined by start and end inclusive. This selection must be set to GTK2.SELECTION_MULTIPLE mode.
- Method
set_mode
GTK2.TreeSelectionset_mode(inttype)- Description
Sets the selection mode. If the previous type was GTK2.SELECTION_MULTIPLE, then the anchor is kept selected, if it was previously selected. One of
SELECTION_BROWSE,SELECTION_MULTIPLE,SELECTION_NONEandSELECTION_SINGLE.
- Method
unselect_iter
GTK2.TreeSelectionunselect_iter(GTK2.TreeIteriter)- Description
Unselects the specified iterator.
- Method
unselect_path
GTK2.TreeSelectionunselect_path(GTK2.TreePathpath)- Description
Unselects the row at path.
Class GTK2.TreeSortable
- Description
The interface for sortable models used by TreeView.
Signals: sort_column_changed
- Method
get_sort_column_id
mappingget_sort_column_id()- Description
Returns ([ "column": int, "order": int ])
- Method
has_default_sort_func
inthas_default_sort_func()- Description
Returns true if the model has a default sort function.
- Method
set_default_sort_func
GTK2.TreeSortableset_default_sort_func(function(:void)f,mixeduser_data)- Description
Sets the default comparison function used when sorting to be f. If the current sort column id of this sortable is GTK2.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function.
if f is 0, then there will be no default comparison function. This means once the model has been sorted, it can't go back to the default state. In this case, when the current sort column id of this sortable is GTK2.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.
- Method
set_sort_column_id
GTK2.TreeSortableset_sort_column_id(intcolumn,intorder)- Description
Sets the current sort column to be column. The widget will resort itself to reflect this change, after emitting a "sort-column-changed" signal. If column is GTK2.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the default sort function will be used, if it is set.
- Method
set_sort_func
GTK2.TreeSortableset_sort_func(intcolumn,function(:void)f,mixeduser_data)- Description
Sets the comparison function used when sorting to be f. If the current sort column id of this sortable is the same as column, then the model will sort using this function.
Class GTK2.TreeStore
- Description
A tree-like data structure that can be used with W(TreeView).
- Method
append
GTK2.TreeIterappend(GTK2.TreeIterparent)- Description
Append a new row. If parent is valid, then it will append the new row after the last child, otherwise it will append a row to the toplevel.
- Method
create
GTK2.TreeStoreGTK2.TreeStore(arraytypes)- Description
Create a new tree store with as many columns as there are items in the array. A type is either a string representing a type name, such as "int" or "float", or an actual widget. If it is a widget, the column in question should be a widget of the same type that you would like this column to represent.
- Method
insert
GTK2.TreeIterinsert(GTK2.TreeIterparent,intposition)- Description
Insert a row at position. If parent is valid, will create as child, otherwise at top level. If position is larger than then number of rows at that level, it will be added to the end of the list. iter will be changed to point to the new row.
- Method
insert_after
GTK2.TreeIterinsert_after(GTK2.TreeIterparent,GTK2.TreeItersibling)- Description
Insert a new row after sibling. If sibling is 0, then the row will be prepended to parent's children. If parent and sibling are both 0, then the row will be prepended to the toplevel.
- Method
insert_before
GTK2.TreeIterinsert_before(GTK2.TreeIterparent,GTK2.TreeItersibling)- Description
Insert a row before sibling. If sibling is 0, then the row will be appended to parent's children. If parent and sibling are 0, then the row will be appended to the toplevel.
- Method
is_ancestor
intis_ancestor(GTK2.TreeIteriter,GTK2.TreeIterdescendant)- Description
Returns true if iter is an ancestor of descendant.
- Method
iter_depth
intiter_depth(GTK2.TreeIteriter)- Description
Get the depth of iter. This will be 0 for anything on the root level, 1 for anything down a level, and so on.
- Method
move_after
GTK2.TreeStoremove_after(GTK2.TreeIteriter,GTK2.TreeIterposition)- Description
Moves iter to after position. These should be at the same level. This only works if the store is unsorted. If position is omitted, iter will be moved to the start of the level.
- Method
move_before
GTK2.TreeStoremove_before(GTK2.TreeIteriter,GTK2.TreeIterposition)- Description
Moves iter to before position. These should be at the same level. This only works if the store is unsorted. If position is omitted, iter will be moved to the end of the level.
- Method
prepend
GTK2.TreeIterprepend(GTK2.TreeIterparent)- Description
Prepend a new row. If parent is valid, then it will prepend the new row before the first child of parent, otherwise it will prepend a new row to the toplevel.
- Method
remove
GTK2.TreeStoreremove(GTK2.TreeIteriter)- Description
Remove iter. iter is set to the next valid row at that level, or invalidated if it was the last one.
- Method
set_row
GTK2.TreeStoreset_row(GTK2.TreeIteriter,arrayvalues)- Description
Set the data in an entire row.
- Method
set_value
GTK2.TreeStoreset_value(GTK2.TreeIteriter,intcolumn,mixedvalue)- Description
Set the data in the cell specified by iter and column.
Class GTK2.TreeView
- Description
Properties: int enable-search GTK2.TreeViewColumn expander-column int fixed-height-mode GTK2.Adjustment hadjustment int headers-clickable int headers-visible int hover-expand int hover-selection int level-indentation GTK2.TreeModel model int reorderable int rules-hint int search-column int show-expanders GTK2.Adjustment vadjustment
Style properties: int allow-rules GDK2.Color even-row-color int expander-size int horizontal-separator int indent-expanders GDK2.Color odd-row-color int vertical-separator
Signals: columns_changed
cursor_changed
expand_collapse_cursor_row
move_cursor
row_activated
row_collapsed
row_expanded
select_all
select_cursor_parent
select_cursor_row
set_scroll_adjustments
start_interactive_search
test_collapse_row
test_expand_row
toggle_cursor_row
unselect_all
- Method
append_column
GTK2.TreeViewappend_column(GTK2.TreeViewColumncolumn)- Description
Appends column to the list of columns. If this tree view has "fixed_height" mode enabled, then column must have its "sizing" property set to be GTK2.TREE_VIEW_COLUMN_FIXED.
- Method
collapse_all
GTK2.TreeViewcollapse_all()- Description
Recursively collapses all visible, expanded nodes.
- Method
collapse_row
intcollapse_row(GTK2.TreePathpath)- Description
Collapses a row (hides its child rows, if they exist).
- Method
columns_autosize
GTK2.TreeViewcolumns_autosize()- Description
Resizes all columns to their optimal width. Only works after the treeview has been realized.
- Method
convert_bin_window_to_tree_coords
mappingconvert_bin_window_to_tree_coords(intbx,intby)- Description
Convert bin_window coordinates to tree coordinates.
- Method
convert_bin_window_to_widget_coords
mappingconvert_bin_window_to_widget_coords(intbx,intby)- Description
Convert bin_window coordinates to widget coordinates.
- Method
convert_tree_to_bin_window_coords
mappingconvert_tree_to_bin_window_coords(inttx,intty)- Description
Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.
- Method
convert_tree_to_widget_coords
mappingconvert_tree_to_widget_coords(inttx,intty)- Description
Convert tree coordinates to widget coordinates.
- Method
convert_widget_to_bin_window_coords
mappingconvert_widget_to_bin_window_coords(intwx,intwy)- Description
Convert widget coordinates to bin_window coordinates.
- Method
convert_widget_to_tree_coords
mappingconvert_widget_to_tree_coords(intwx,intwy)- Description
Convert widget coordinates to tree coordinates.
- Method
create
GTK2.TreeViewGTK2.TreeView(GTK2.TreeModelmodel_or_props)- Description
Create a new W(TreeView), with or without a default model.
- Method
create_row_drag_icon
GTK2.GdkPixmapcreate_row_drag_icon(GTK2.TreePathpath)- Description
Creates a GDK2.Pixmap representation of the row at path. This image is used for a drag icon.
- Method
enable_model_drag_dest
GTK2.TreeViewenable_model_drag_dest(arraytargets,intactions)- Description
Turns the view into a drop destination for automatic DND. See also:
drag_dest_set,drag_source_set
- Method
enable_model_drag_source
GTK2.TreeViewenable_model_drag_source(intstart_button_mask,arraytargets,intactions)- Description
Turns the view into a drag source for automatic DND. See also:
drag_source_set
- Method
expand_row
intexpand_row(GTK2.TreePathpath,intopen_all)- Description
Opens the row so its children are visible.
- Method
expand_to_path
GTK2.TreeViewexpand_to_path(GTK2.TreePathpath)- Description
Expands the row at path. This will also expand all parent rows of path as necessary.
- Method
get_background_area
GTK2.GdkRectangleget_background_area(GTK2.TreePathpath,GTK2.TreeViewColumncolumn)- Description
Similar to get_cell_area(). The returned rectangle is equivalent to the background_area passed to GTK2.CellRenderer->render(). These background area tiles to cover the entire tree window (except for the area used for header buttons). Contrast with get_cell_area(), which returns only the cell itself, excluding surrounding borders and the tree expander area.
- Method
get_bin_window
GTK2.GdkWindowget_bin_window()- Description
Returns the window that this view renders to. This is used primarily to compare to event->window to confirm that the event on this view is on the right window.
- Method
get_cell_area
GTK2.GdkRectangleget_cell_area(GTK2.TreePathpath,GTK2.TreeViewColumncolumn)- Description
Fills the bounding rectangle in tree window coordinates for the cell at the row specified by path and the column specified by column. If path is omitted or 0, or points to a path not currently displayed, the y and height fields of the rectangle will be 0. If column is omitted, the x and width fields will be o. The sum of all cell rects does not cover the entire tree; there are extra pixels in between rows, for example. The returned rectangle is equivalent to the cell_area passed to GTK2.CellRenderer->render(). This function is only valid if the view is realized.
- Method
get_column
GTK2.TreeViewColumnget_column(intn)- Description
Gets the W(TreeViewColumn) at the given position.
- Method
get_columns
arrayget_columns()- Description
Returns an array of all the W(TreeViewColumn)'s current in the view.
- Method
get_cursor
mappingget_cursor()- Description
Returns the current path and focus column. If the cursor isn't currently set, then "path" will be 0. If no column currently has focus, then "focus_column" will be 0. Returns ([ "path": GTK2.TreePath, "column": GTK2.TreeViewColumn ]);
- Method
get_dest_row_at_pos
mappingget_dest_row_at_pos(intdrag_x,intdrag_y)- Description
Determines the destination row for a given position. Returns ([ "path": GTK2.TreePath, "pos": int ]) if there is such a row, or 0 if not. pos will be one of GTK2.TREE_VIEW_DROP_[INTO_OR_]{BEFORE,AFTER}.
- Method
get_drag_dest_row
mappingget_drag_dest_row()- Description
Gets information about the row that is highlighted for feedback. Returns ([ "path": GTK2.TreePath, "pos": int ]); pos will be one of GTK2.TREE_VIEW_DROP_[INTO_OR_]{BEFORE,AFTER}.
- Method
get_enable_search
intget_enable_search()- Description
Returns whether or not the tree allows to start interactive searching by typing in text.
- Method
get_enable_tree_lines
intget_enable_tree_lines()- Description
Returns whether or not tree lines are drawn.
- Method
get_expander_column
GTK2.TreeViewColumnget_expander_column()- Description
Returns the column that is the current expander column. This column has the expander arrow drawn next to it.
- Method
get_fixed_height_mode
intget_fixed_height_mode()- Description
Returns whether fixed height mode is turned on.
- Method
get_hadjustment
GTK2.Adjustmentget_hadjustment()- Description
Gets the W(Adjustment) currently being used for the horizontal aspect.
- Method
get_headers_clickable
intget_headers_clickable()- Description
Returns whether all header columns are clickable.
- Method
get_headers_visible
intget_headers_visible()- Description
Returns true if the headers are visible.
- Method
get_hover_expand
intget_hover_expand()- Description
Returns whether hover expansion mode is turned on.
- Method
get_hover_selection
intget_hover_selection()- Description
Returns whether hover selection mode is turned on.
- Method
get_level_indentation
intget_level_indentation()- Description
Returns the amount, in pixels, of extra indentation for child levels
- Method
get_path_at_pos
mappingget_path_at_pos(intx,inty)- Description
Finds the path at the point (x,y) relative to widget coordinates. That is, x and y are relative to an events coordinates. x and y must come from an event on the view only where event->window==get_bin(). It is primarily for things like popup menus. Returns GTK2.TreePath, GTK2.TreeViewColumn, and cell_x and cell_y, which are the coordinates relative to the cell background (i.e. the background_area passed to GTK2.CellRenderer->render()). This function is only meaningful if the widget is realized.
- Method
get_reorderable
intget_reorderable()- Description
Retrieves whether the user can reorder the tree via drag-and-drop.
- Method
get_rubber_banding
intget_rubber_banding()- Description
Returns whether rubber banding is turned on. If the selection mode is GTK2.SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.
- Method
get_search_column
intget_search_column()- Description
Gets the column searched on by the interactive search code.
- Method
get_search_entry
GTK2.Entryget_search_entry()- Description
Returns the GTK2.Entry which is currently in use as interactive search entry. In case the built-in entry is being used, 0 will be returned.
- Method
get_selected
arrayget_selected()- Description
Shortcut to GTK2.TreeView->get_selection() and GTK2.TreeSelection()->get_selected().
- Method
get_selection
GTK2.TreeSelectionget_selection()- Description
Gets the W(TreeSelection) associated with this TreeView.
- Method
get_show_expanders
intget_show_expanders()- Description
Returns whether or not expanders are drawn
- Method
get_vadjustment
GTK2.Adjustmentget_vadjustment()- Description
Gets the W(Adjustment) currently being used for the vertical aspect.
- Method
get_visible_range
arrayget_visible_range()- Description
Returns the first and last visible path. Note that there may be invisible paths in between.
- Method
get_visible_rect
GTK2.GdkRectangleget_visible_rect()- Description
Returns a GDK2.Rectangle with the currently-visible region of the buffer, in tree coordinates. Conver to widget coordinates with tree_to_widget_coords(). Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.
- Method
insert_column
intinsert_column(GTK2.TreeViewColumncolumn,intposition)- Description
This inserts the column at position. If position is -1, then the column is inserted at the end. If this tree view has "fixed_height" mode enabled, then column must have its "sizing property set to GTK2.TREE_VIEW_COLUMN_FIXED.
- Method
move_column_after
GTK2.TreeViewmove_column_after(GTK2.TreeViewColumncolumn,GTK2.TreeViewColumnbase)- Description
Moves column to be after base. If base is omitted, then column is placed in the first position.
- Method
row_activated
GTK2.TreeViewrow_activated(GTK2.TreePathpath,GTK2.TreeViewColumncolumn)- Description
Activates the cell determined by path and column.
- Method
row_expanded
introw_expanded(GTK2.TreePathpath)- Description
Returns true if the node pointed to by path is expanded.
- Method
scroll_to_cell
GTK2.TreeViewscroll_to_cell(GTK2.TreePathpath,GTK2.TreeViewColumncolumn,float|voidrow_align,float|voidcol_align)- Description
Moves the alignments of the view to the position specified by column and path. If column is 0, then no horizontal scrolling occurs. Likewise, if path is 0, no vertical scrolling occurs. At a minimum, one of column or path needs to be non-zero. row_align determines where the row is placed, and col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.
If row_align exists, then col_align must exist, otherwise neither will be used. If neither are used, the tree does the minimum amount of work to scroll the cell onto the screen. This means that the cell will be scrolled to the edge closest to its current position. If the cell is currently visible on the screen, nothing is done.
This function only works if the model is set, and path is a valid row on the model. If the model changes before the view is realized, the centered path will be modifed to reflect this change.
- Method
scroll_to_point
GTK2.TreeViewscroll_to_point(intx,inty)- Description
Scrolls the tree view such that the top-left corner of the visible area is x,y, where x and y are specified in tree window coordinates. The view must be realized before this function is called. If it isn't, you probably want to be using scroll_to_cell().
If either x or y are -1, then that direction isn't scrolled.
- Method
set_cursor
GTK2.TreeViewset_cursor(GTK2.TreePathpath,GTK2.TreeViewColumnfocus_column,int|voidstart_editing)- Description
Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user's attention on a particular row. If focus_column is present, then focus is given to the column specified by it. Additionally, if focus_column is specified, and start_editing is true, then editing should be started in the specified cell. This function is often followed by grab_focus() in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.
- Method
set_cursor_on_cell
GTK2.TreeViewset_cursor_on_cell(GTK2.TreePathpath,GTK2.TreeViewColumnfocus_column,int|voidstart_editing,GTK2.CellRendererfocus_cell)- Description
Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user's attention on a particular row. If focus_column is present, then focus is given to the column specified by it. If focus_column and focus_cell are present, and focus_column contains 2 or more editable or activatable cells, then focus is given to the cell specified by focus_cell. Additionally, if focus_column is specified, and start_editing is true, then editing should be started in the specified cell. This function is often followed by grab_focus() in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.
- Method
set_drag_dest_row
GTK2.TreeViewset_drag_dest_row(GTK2.TreePathpath,intpos)- Description
Sets the row that is highlighted for feedback. pos is one of the four constants GTK2.TREE_VIEW_DROP_[INTO_OR_]{BEFORE,AFTER}.
- Method
set_enable_search
GTK2.TreeViewset_enable_search(intenable_search)- Description
If enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find").
Note that even if this is false, the user can still initiate a search using the "start-interactive-search" key binding.
- Method
set_enable_tree_lines
GTK2.TreeViewset_enable_tree_lines(intenabled)- Description
Sets whether to draw lines interconnecting the expanders. This does not have any visible effects for lists.
- Method
set_expander_column
GTK2.TreeViewset_expander_column(GTK2.TreeViewColumncolumn)- Description
Sets the column to draw the expander arrow at. It must be in the view. If column is omitted, then the expander arrow is always at the first visible column.
- Method
set_fixed_height_mode
GTK2.TreeViewset_fixed_height_mode(intenable)- Description
Enables or disables the fixed height mode. Fixed height mode speeds up W(TreeView) by assuming that all rows have the same height. Only enable this option if all rows are the same height and all columns are of type GTK2.TREE_VIEW_COLUMN_FIXED.
- Method
set_grid_lines
GTK2.TreeViewset_grid_lines(intgrid_lines)- Description
Sets which grid lines to draw.
- Method
set_hadjustment
GTK2.TreeViewset_hadjustment(GTK2.Adjustmenthadj)- Description
Sets the W(Adjustment) for the current horizontal aspect.
- Method
set_headers_clickable
GTK2.TreeViewset_headers_clickable(intsetting)- Description
Allow the column title buttons to be clicked.
- Method
set_headers_visible
GTK2.TreeViewset_headers_visible(intheaders_visible)- Description
Sets the visibility state of the headers.
- Method
set_hover_expand
GTK2.TreeViewset_hover_expand(intexpand)- Description
Enables or disables the hover expansion mode. Hover expansion makes rows expand or collapse if the pointer moves over them.
- Method
set_hover_selection
GTK2.TreeViewset_hover_selection(inthover)- Description
Enables or disables the hover selection mode. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes GTK2.SELECTION_SINGLE and GTK2.SELECTION_BROWSE.
- Method
set_model
GTK2.TreeViewset_model(GTK2.TreeModelmodel)- Description
Sets the model. If this TreeView already has a model set, it will remove it before setting the new model.
- Method
set_reorderable
GTK2.TreeViewset_reorderable(intreorderable)- Description
This function is a convenience function to allow you to reorder models. If reorderable is true, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model's "row-inserted" and "row-deleted" signals.
This function does not give you any degree of control over the order -- any reordering is allowed. If more control is needed, you should probably handle drag and drop manually.
- Method
set_row_separator_func
GTK2.TreeViewset_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.
- Method
set_rubber_banding
GTK2.TreeViewset_rubber_banding(intenable)- Description
Enables or disables rubber banding.
- Method
set_rules_hint
GTK2.TreeViewset_rules_hint(intsetting)- Description
This function tells GTK2+ that the user interface for your application requires users to read across tree rows and associate cells with one another. By default, GTK2+ will then render the tree with alternating row colors. Do not use it just because you prefer the appearance of the ruled tree; that's a question for the theme. Some themes will draw tree rows in alternating colors even when rules are turned off, and users who prefer that appearance all the time can choose those themes. You should call this function only as a semantic hint to the theme engine that your tree makes alternating colors usefull from a functional standpoint (since it has lots of columns, generally).
- Method
set_search_column
GTK2.TreeViewset_search_column(intcolumn)- Description
Sets column as the column where the interactive search code should search in.
If the sort column is set, users can use the "start-interactive-search" key binding to bring up search popup. The enable-search property controls whether simply typing text will also start an interactive search.
Note that column refers to a column of the model.
- Method
set_search_entry
GTK2.TreeViewset_search_entry(GTK2.Entryentry)- Description
Sets the entry which the interactive search code will use. This is useful when you want to provide a search entry in your interface at all times at a fixed position. Passing 0 will make the interactive search code use the built-in popup entry again.
- Method
set_show_expanders
GTK2.TreeViewset_show_expanders(intshow)- Description
Sets whether to draw and enable expanders and indent child rows.
- Method
set_vadjustment
GTK2.TreeViewset_vadjustment(GTK2.Adjustmentvadj)- Description
Sets the W(Adjustment) for the current vertical aspect.
- Method
unset_rows_drag_dest
GTK2.TreeViewunset_rows_drag_dest()- Description
Undoes the effect of enable_model_drag_dest().
Class GTK2.TreeViewColumn
- Description
Properties: float alignment int clickable int expand int fixed-width int max-width int min-width int reorderable int resizable int sizing
TREE_VIEW_COLUMN_AUTOSIZE,TREE_VIEW_COLUMN_FIXEDandTREE_VIEW_COLUMN_GROW_ONLYint sort-indicator int sort-orderSORT_ASCENDINGandSORT_DESCENDINGint spacing string title int visible GTK2.Widget widget int widthSignals: clicked
- Method
add_attribute
GTK2.TreeViewColumnadd_attribute(GTK2.CellRenderercell_renderer,stringattribute,intcolumn)- Description
Adds an attribute mapping to the list. The column is the column of the model to get a value from, and the attribute is the parameter on cell_rendere to be set from the value. So for example if column 2 of the model contains strings, you could have the "text" attribute of a W(CellRendererText) get its values from column 2.
- Method
cell_get_position
mappingcell_get_position(GTK2.CellRenderercell_renderer)- Description
Obtains the horizontal position and size of a cell in a column. If the cell is not found in the column, returns -1 for start_pos and width.
- Method
cell_get_size
mappingcell_get_size(GTK2.GdkRectanglecell_area)- Description
Obtains the width and height needed to render the column.
- Method
cell_is_visible
intcell_is_visible()- Description
Returns true if any of the cells packed into the colum are visible. For this to be meaningful, you must first initialize the cells with cell_set_cell_data().
- Method
cell_set_cell_data
GTK2.TreeViewColumncell_set_cell_data(GTK2.TreeModelmodel,GTK2.TreeIteriter,intis_expander,intis_expanded)- Description
Sets the cell renderer based on the model and iter. That is, for every attribute mapping in this column, it will get a value from the set column on the iter, and use that value to set the attribute on the cell renderer. This is used primarily by the W(TreeView).
- Method
clear_attributes
GTK2.TreeViewColumnclear_attributes(GTK2.CellRenderercell_renderer)- Description
Clears all existing attributes previously set.
- Method
clicked
GTK2.TreeViewColumnclicked()- Description
Emits the "clicked" signal on the column. This function will only work if this column is clickable.
- Method
create
GTK2.TreeViewColumnGTK2.TreeViewColumn(string|mappingtitle_or_props,GTK2.CellRendererrenderer,stringproperty,intcol,int|string...moreprops)- Description
Creates a new W(TreeViewColumn). At least one property/col pair must be specified; any number of additional pairs can also be given.
- Method
focus_cell
GTK2.TreeViewColumnfocus_cell(GTK2.CellRenderercell)- Description
Sets the current keyboard focus to be at cell, if the column contains 2 or more editable and activatable cells.
- Method
get_alignment
floatget_alignment()- Description
Returns the current x alignment. This value can range between 0.0 and 1.0.
- Method
get_cell_renderers
arrayget_cell_renderers()- Description
Returns an array of all the cell renderers in the column, in no partciular order.
- Method
get_clickable
intget_clickable()- Description
Returns true if the user can click on the header for the column.
- Method
get_expand
intget_expand()- Description
Return true if the column expands to take any available space.
- Method
get_max_width
intget_max_width()- Description
Returns the maximum width in pixels, or -1 if no maximum width is set.
- Method
get_min_width
intget_min_width()- Description
Returns the minimum width in pixels, or -1 if no minimum width is set.
- Method
get_reorderable
intget_reorderable()- Description
Returns true if the column can be reordered by the user.
- Method
get_resizable
intget_resizable()- Description
Returns true if the column can be resized by the end user.
- Method
get_sort_column_id
intget_sort_column_id()- Description
Gets the logical column_id that the model sorts on when this column is selected for sorting.
- Method
get_sort_indicator
intget_sort_indicator()- Description
Gets the value set by set_sort_indicator();
- Method
get_tree_view
GTK2.Widgetget_tree_view()- Description
Returns the W(TreeView) that this TreeViewColumn has been inserted into.
- Method
get_widget
GTK2.Widgetget_widget()- Description
Returns the W(Widget) in the button on the column header. If a custom widget has not been set then 0 is returned.
- Method
pack_end
GTK2.TreeViewColumnpack_end(GTK2.CellRenderercell,intexpand)- Description
Packs the cell to the end of the column.
- Method
pack_start
GTK2.TreeViewColumnpack_start(GTK2.CellRenderercell,intexpand)- Description
Packs the cell into the beginning of the column. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divied evenly between cells for which expand is true.
- Method
queue_resize
GTK2.TreeViewColumnqueue_resize()- Description
Flags the column, and the cell renderers added to this column, to have their sizes renegotiated.
- Method
set_alignment
GTK2.TreeViewColumnset_alignment(floatxalign)- Description
Sets the alignment of the title or custom widget inside the column header. The alignment determines its location inside the button - 0.0 for left, 0.5 for center, 1.0 for right.
- Method
set_clickable
GTK2.TreeViewColumnset_clickable(intclickable)- Description
Sets the header to be active if clickable is true. When the header is active, then it can take keyboard focus, and can be clicked.
- Method
set_expand
GTK2.TreeViewColumnset_expand(intexpand)- Description
Sets the column to take available extra space. This space is shared equally amongst all columns that have the expand set to true. If no column has this option set, then the last column gets all extra space. By default, every column is created with this false.
- Method
set_fixed_width
GTK2.TreeViewColumnset_fixed_width(intfixed_width)- Description
Sets the size of the column in pixels. The is meaningful only if the sizing type is GTK2.TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to the min/max width for the column. Please note that the min/max width of the column doesn't actually affect the "fixed-width" property of the widget, just the actual size when displayed.
- Method
set_max_width
GTK2.TreeViewColumnset_max_width(intmax_width)- Description
Sets the maximum width. If max_width is -1, then the maximum width is unset. Note, the column can actually be wider than max width if it's the last column in a view. In this case, the column expands to fill any extra space.
- Method
set_min_width
GTK2.TreeViewColumnset_min_width(intmin_width)- Description
Sets the minimum width. If min_width is -1, then the minimum width is unset.
- Method
set_reorderable
GTK2.TreeViewColumnset_reorderable(intreorderable)- Description
If reorderable is true, then the column can be reorderd by the end user dragging the header.
- Method
set_resizable
GTK2.TreeViewColumnset_resizable(intresizable)- Description
If resizable is true, then the user can explicitly resize the column by grabbing the outer edge of the column button. If resizable is ture and the sizing mode of the column is GTK2.TREE_VIEW_COLUMN_AUTOSIZE, then the sizing mode is changed to GTK2.TREE_VIEW_COLUMN_GROW_ONLY.
- Method
set_sizing
GTK2.TreeViewColumnset_sizing(inttype)- Description
Sets the growth behavior of this columnt to type. One of
TREE_VIEW_COLUMN_AUTOSIZE,TREE_VIEW_COLUMN_FIXEDandTREE_VIEW_COLUMN_GROW_ONLY.
- Method
set_sort_column_id
GTK2.TreeViewColumnset_sort_column_id(intcolumn_id)- Description
Sets the logical column_id that this column sorts on when this column is selected for sorting. Doing so makes the column header clickable.
- Method
set_sort_indicator
GTK2.TreeViewColumnset_sort_indicator(intsetting)- Description
Call this function with a setting of true to display an arrow in the header button indicating the column is sorted. Call set_sort_order() to change the direction of the arrow.
- Method
set_sort_order
GTK2.TreeViewColumnset_sort_order(intorder)- Description
Changes the appearance of the sort indicator.
This does not actually sort the model. Use set_sort_column_id() if you wnat automatic sorting support. This function is primarily for custom sorting behavior, and should be used in conjunction with GTK2.TreeSortable->set_sort_column() to do that. For custom models, the mechanism will vary.
The sort indicator changes direction to indicate normal sort or reverse sort. Note that you must have the sort indicator enabled to see anything when calling this function. One of
SORT_ASCENDINGandSORT_DESCENDING.
- Method
set_spacing
GTK2.TreeViewColumnset_spacing(intspacing)- Description
Sets the spacing field, which is the number of pixels to place between cell renderers packed into it.
- Method
set_title
GTK2.TreeViewColumnset_title(stringtitle)- Description
Sets the title. If a custom widget has been set, then this value is ignored.
Class GTK2.UiManager
- Description
Constructing menus and toolbars from an XML description. Properties: int add-tearoffs string ui
Signals: actions_changed Emitted whenever the actions changes.
add_widget Emitted for each generated menubar and toolbar, but not for generated popup menus.
connect_proxy Emitted after connecting a proxy to an action.
disconnect_proxy Emitted after disconnecting a proxy from an action.
post_activate Emitted just after the action is activated.
pre_activate Emitted just before the action is activated. A UI definition: <ui> <menubar> <menu name="FileMenu" action="FileMenuAction"> <menuitem name="New" action="New2Action" /> <placeholder name="FileMenuAdditions" /> </menu> <menu name="JustifyMenu" action="JustifyMenuAction"> <menuitem name="Left" action="justify-left"/> <menuitem name="Centre" action="justify-center"/> <menuitem name="Right" action="justify-right"/> <menuitem name="Fill" action="justify-fill"/> </menu> </menubar> <toolbar action="toolbar1"> <placeholder name="JustifyToolItems"> <separator/> <toolitem name="Left" action="justify-left"/> <toolitem name="Centre" action="justify-center"/> <toolitem name="Right" action="justify-right"/> <toolitem name="Fill" action="justify-fill"/> <separator/> </placeholder> </toolbar> </ui>
- Method
add_ui
GTK2.UiManageradd_ui(intmerge_id,stringpath,stringname,stringaction,inttype,inttop)- Description
Adds a ui element to the current contents.
If type is GTK2.UI_MANAGER_AUTO, GTK2+ inserts a menuitem, toolitem or separator if such an element can be inserted at the place determined by path. Otherwise type must indicate an element that can be inserted at the place determined by path.
- Method
add_ui_from_file
intadd_ui_from_file(stringfilename)- Description
Parses a file containing a ui definition.
- Method
add_ui_from_string
intadd_ui_from_string(stringbuffer)- Description
Parses a string containing a ui definition and merges it with the current contents. An enclosing >ui< element is added if it is missing.
- Method
create
GTK2.UiManagerGTK2.UiManager(mapping|voidprops)- Description
Creates a new ui manager object.
- Method
ensure_update
GTK2.UiManagerensure_update()- Description
Makes sure that all pending updates to the ui have been completed.
- Method
get_accel_group
GTK2.AccelGroupget_accel_group()- Description
Returns the GTK2.AccelGroup associated with this.
- Method
get_action
GTK2.Actionget_action(stringpath)- Description
Looks up an action by following a path.
- Method
get_add_tearoffs
intget_add_tearoffs()- Description
Returns whether menus generated by this manager will have tearoff menu items.
- Method
get_toplevels
arrayget_toplevels(inttypes)- Description
Obtains a list of all toplevel widgets of the requested types. Bitwise or of
UI_MANAGER_ACCELERATOR,UI_MANAGER_AUTO,UI_MANAGER_MENU,UI_MANAGER_MENUBAR,UI_MANAGER_MENUITEM,UI_MANAGER_PLACEHOLDER,UI_MANAGER_POPUP,UI_MANAGER_SEPARATOR,UI_MANAGER_TOOLBARandUI_MANAGER_TOOLITEM.
- Method
get_widget
GTK2.Widgetget_widget(stringpath)- Description
Looks up a widget by following a path. The path consists of the names specified in the xml description of the ui, separated by '/'. Elements which don't have a name or action attribute in the xml (e.g. >popup<) can be addressed by their xml element name (e.g. "popup"). The root element ("/ui") can be omitted in the path.
Note that the widget found be following a path that ends in a >menu< element is the menuitem to which the menu is attached, not the menu itself.
- Method
insert_action_group
GTK2.UiManagerinsert_action_group(GTK2.ActionGroupgroup,intpos)- Description
Inserts an action group into the list of action groups. Actions in earlier groups hide actions with the same name in later groups.
- Method
new_merge_id
intnew_merge_id()- Description
Returns an unused merge id, suitable for use with add_ui().
- Method
remove_action_group
GTK2.UiManagerremove_action_group(GTK2.ActionGroupgroup)- Description
Removes an action group from the list of action groups.
- Method
remove_ui
GTK2.UiManagerremove_ui(intmerge_id)- Description
Unmerges the part of the content identified by merge_id.
Class GTK2.VScrollbar
- Description
General documentation: See W(Scrollbar)
 GTK2.VScrollbar(GTK2.Adjustment())->set_size_request(15,60)
Class GTK2.Vbox
- Description
Most packing is done by creating boxes. These are invisible widget containers that we can pack our widgets into which come in two forms, a horizontal box, and a vertical box. This is the vertical one. When packing widgets into a vertical box, the objects are inserted horizontally from top to bottom or bottom to top depending on the call used.
 GTK2.Vbox(0,0)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))
 GTK2.Vbox(1,0)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))
 GTK2.Vbox(1,40)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))
Class GTK2.VbuttonBox
- Description
A Vbutton_box is very similar to a Vbox. The major diffference is that the button box is made to pack buttons in, and has a few convenience function for normal button layouts.
 GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_size_request(100,300)
 GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_SPREAD)->set_size_request(100,300)
 GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_EDGE)->set_size_request(100,300)
 GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_START)->set_size_request(100,300)
 GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_END)->set_size_request(100,300)
Class GTK2.Viewport
- Description
This is a container that can be scrolled around, but it has no scrollbars. You can connect scrollbars to it using the adjustment objects.
 GTK2.Viewport(GTK2.Adjustment(),GTK2.Adjustment())->set_size_request(100,100)
 GTK2.Viewport(GTK2.Adjustment(),GTK2.Adjustment())->set_size_request(100,100)->set_shadow_type(GTK2.SHADOW_ETCHED_IN)
 GTK2.Viewport(GTK2.Adjustment(),GTK2.Adjustment())->set_size_request(100,100)->add(GTK2.Label("A label with a very long text on it, it will not fit"))->set_shadow_type(GTK2.SHADOW_ETCHED_IN)
 lambda(){ object a1;object v = GTK2.Viewport(a1=GTK2.Adjustment(),GTK2.Adjustment())->set_size_request(100,100)->add(GTK2.Label("A label with a very long text on it, it will not fit"))->set_shadow_type(GTK2.SHADOW_ETCHED_IN);call_out(a1->set_value,0,100.0);return v;}()
Properties: GTK2.Adjustment hadjustment int shadow-type GTK2.Adjustment vadjustment
Signals: set_scroll_adjustments
- Method
create
GTK2.ViewportGTK2.Viewport(GTK2.Adjustmentxscroll_or_props,GTK2.Adjustmentyscroll)- Description
Create a new viewport. The adjustments are used to select what part of the viewport to view to the user. They are normally connected to a scrollbar or something similar.
- Method
get_hadjustment
GTK2.Adjustmentget_hadjustment()- Description
Return the current horizontal adjustment object
- Method
get_shadow_type
intget_shadow_type()- Description
Get the shadow type. One Of
SHADOW_ETCHED_IN,SHADOW_ETCHED_OUT,SHADOW_IN,SHADOW_NONEandSHADOW_OUT
- Method
get_vadjustment
GTK2.Adjustmentget_vadjustment()- Description
Return the current vertical adjustment object
- Method
set_hadjustment
GTK2.Viewportset_hadjustment(GTK2.Adjustmentxscroll)- Description
Set a new horizontal adjustment object.
- Method
set_shadow_type
GTK2.Viewportset_shadow_type(inttype)- Description
Set the shadow style. One of
SHADOW_ETCHED_IN,SHADOW_ETCHED_OUT,SHADOW_IN,SHADOW_NONEandSHADOW_OUT
Class GTK2.VolumeButton
- Description
Volume Button
Class GTK2.Vpaned
- Description
The paned window widgets are useful when you want to divide an area into two parts, with the relative size of the two parts controlled by the user. A groove is drawn between the two portions with a handle that the user can drag to change the ratio. This widgets makes a vertical division
 GTK2.Vpaned()->add1(GTK2.Label("Top Side Of Pane"))->add2(GTK2.Label("Bottom"))->set_size_request(100,100)
Class GTK2.Vscale
- Description
The GTK2.HScale widget is used to allow the user to select a value using a horizontal slider. A GTK2.Adjustment is used to set the initial value, the lower and upper bounds, and the step and page increments.
See W(Scale) for details
The position to show the current value, and the number of decimal places shown can be set using the parent W(Scale) class's functions.
 GTK2.Vscale(GTK2.Adjustment())->set_size_request(300,30)
Class GTK2.Vseparator
- Description
Simply creates a vertical separator. No bells or whistles.
 GTK2.Vseparator()->set_size_request(3,50)
Class GTK2.Widget
- Description
The basic widget, inherited (directly or indirectly) by all widgets. Thus, all functions and signals defined in this widget work on all widgets.
One of the most important functions in this class is 'show', it lets GTK2 know that we are done setting the attributes of the widget, and it is ready to be displayed. You may also use hide to make it disappear again. The order in which you show the widgets is not important, but I suggest showing the toplevel window last so the whole window pops up at once rather than seeing the individual widgets come up on the screen as they're formed. The children of a widget (a window is a widget too) will not be displayed until the window itself is shown using the show() function.
Properties: int app-paintable int can-default int can-focus int composite-child int events (GDK2.EventMask) int extension-events (
GDK_EXTENSION_EVENTS_ALL,GDK_EXTENSION_EVENTS_CURSORandGDK_EXTENSION_EVENTS_NONE) int has-default int has-focus int has-tooltip int height-request int is-focus string name int no-show-all GTK2.Container parent int receives-default int sensitive GTK2.Style style string tooltip-markup string tooltip-text int visible int width-requestStyle properties: float cursor-aspect-ratio GDK2.Color cursor-color int draw-border string focus-line-pattern int focus-line-width int focus-padding int interior-focus GDK2.Color link-color int scroll-arrow-hlength int scroll-arrow-vlength int separator-height int separator-width GDK2.Color visited-link-color int wide-separators
Signals: accel_closures_changed
button_press_event Called when a mouse button is pressed
button_release_event Called when a mouse button is released
can_activate_accel
child_notify
client_event An event sent by another client application
composited_changed
configure_event The size, position or stacking order of the widget has changed
delete_event Called when the user has requested that the widget should be closed
destroy_event Called when the widget is destroyed
direction_changed
drag_begin Called when the drag is initiated, on the sending side
drag_data_delete Called when the data can be safely deleted (there is no need to use this function in pigtk, it's all handled automatically)
drag_data_get Called on the sending side when the drop is initiated
drag_data_received Called on the receiving side when the drop is finished
drag_drop Called on the receiving side when the drop is initiated
drag_end Called when the drag is finished, on the sending side
drag_failed
drag_leave Called when the mouse leaves the widget while the user is dragging something
drag_motion Called on the receiving side when the cursor is moved over the widget while dragging something
enter_notify_event Calls when the mouse enters the widget
event Called for all events
event_after
expose_event Called when the widget, or a part of the widget, gets an expose event
focus
focus_in_event The keyboard focus has entered the widget
focus_out_event The keyboard focus has left the widget
grab_broken_event
grab_focus
grab_notify
hide Called when the widget is hidden
hierarchy_changed
key_press_event Called when a keyboard key is pressed
key_release_event Called when a keyboard key is released
keynav_failed
leave_notify_event Called when the mouse leaves the widget
map Called when the window associated with the widget is mapped
map_event Called just before the 'map' signal
mnemonic_activate
motion_notify_event Called when the mouse is moved inside the widget
no_expose_event
parent_set Called when the parent widget is changed
popup_menu
property_notify_event Called when a property of the GDK window associated with the widget is changed
proximity_in_event
proximity_out_event
query_tooltip
realize Called when the widget is realized. Some methods cannot be used until the widget has been realized; if you get assertion errors related to 'w->window' or similar, this is probably the cause.
screen_changed
scroll_event
selection_clear_event
selection_get
selection_notify_event
selection_received
selection_request_event
show Called when the widget is shown
show_help
size_allocate Called when the widget gets the size it should be
size_request Called when the widget should calculate how big it wants to be
state_changed
style_set Called when the style is changed
unmap Called when the window associated with the widget is unmapped
unmap_event Called just before the 'unmap' signal
unrealize Called when the widget is unrealized;
visibility_notify_event The widget has been mapped, unmapped, hidden, or otherwise had it's visibility modified
window_state_event
- Method
APP_PAINTABLE
GTK2.WidgetAPP_PAINTABLE()- Description
Returns if the GTK2.APP_PAINTABLE flag has been set on this widget.
- Method
CAN_DEFAULT
GTK2.WidgetCAN_DEFAULT()- Description
Returns if this widget is allowed to receive the default action.
- Method
CAN_FOCUS
GTK2.WidgetCAN_FOCUS()- Description
Returns if this widget is able to handle focus grabs.
- Method
COMPOSITE_CHILD
GTK2.WidgetCOMPOSITE_CHILD()- Description
Returns if this widget is a composite child of its parent.
- Method
DOUBLE_BUFFERED
GTK2.WidgetDOUBLE_BUFFERED()- Description
Returns if the GTK2.DOUBLE_BUFFERED flag has been set on this widget.
- Method
HAS_DEFAULT
GTK2.WidgetHAS_DEFAULT()- Description
Returns if this widget is currently receiving the default action.
- Method
HAS_FOCUS
GTK2.WidgetHAS_FOCUS()- Description
Returns if this widget has grabbed the focus and no other widget has done so more recently.
- Method
HAS_GRAB
GTK2.WidgetHAS_GRAB()- Description
Returns if this widget is in the grab_widgets stack, and will be the preferred one for receiving events other than ones of cosmetic value.
- Method
IS_SENSITIVE
GTK2.WidgetIS_SENSITIVE()- Description
Returns if this widget is effectively sensitive.
- Method
NO_WINDOW
GTK2.WidgetNO_WINDOW()- Description
Returns if this widget doesn't have its own GDK2.Window.
- Method
PARENT_SENSITIVE
GTK2.WidgetPARENT_SENSITIVE()- Description
Returns if the GTK2.PARENT_SENSITIVE flag is set.
- Method
RC_STYLE
GTK2.WidgetRC_STYLE()- Description
Returns if the widget's style has been looked up through the rc mechanism.
- Method
RECEIVES_DEFAULT
GTK2.WidgetRECEIVES_DEFAULT()- Description
Returns if this widget when focused will receive the default action even if there is a different widget set as default.
- Method
activate
intactivate()- Description
For widgets that can be "activated" (buttons, menu items, etc.) this functions activates them. Activation is what happens when you press Enter on a widget during key navigation.
- Method
add_accelerator
GTK2.Widgetadd_accelerator(stringaccel_signal,GTK2.AccelGroupaccel_group,intaccel_key,intaccel_mods,intaccel_flags)- Description
Installs an accelerator in accel_group that causes accel_signal to be emitted if the accelerator is activated. The signal must be of type G_RUN_ACTION.
- Method
add_events
GTK2.Widgetadd_events(intevents)- Description
Adds the events in the bitfield events to the event mask.
- Method
add_mnemonic_label
GTK2.Widgetadd_mnemonic_label(GTK2.Widgetlabel)- Description
Adds a widget to the list of mnemonic lables for this widget. Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update it's internal state at this point as well, by using a connection to the destroy signal.
- Method
allocation
mappingallocation()- Description
Returns ([ "x": xoffset, "y":yoffset, "width":xsize, "height":ysize ])
- Method
can_activate_accel
intcan_activate_accel(intsignal_id)- Description
Determines whether an accelerator that activates the signal signal_id can currently be activated.
- Method
child_notify
GTK2.Widgetchild_notify(stringprop)- Description
Emits a "child-notify" signal for the child property prop.
- Method
create_pango_context
GTK2.Pango.Contextcreate_pango_context()- Description
Creates a new Pango.Context with the appropriate colormap, font description, and base direction for drawing text for this widget.
- Method
create_pango_layout
GTK2.Pango.Layoutcreate_pango_layout(stringtext)- Description
Creates a new Pango.Layout with the appropriate colormap, font description, and base direction for drawing text.
- Method
drag_dest_set
GTK2.Widgetdrag_dest_set(intflags,arraytargets,intactions)- Description
Set this widget up so it can accept drops. Parallel to
drag_source_set- see there for arg info. flags allows default drop behaviour to turned on and off; use GTK2.DEST_DEFAULT_ALL for normal behaviour.
- Method
drag_source_set
GTK2.Widgetdrag_source_set(intbuttons,arraytargets,intactions)- Description
Set this widget up so a drag operation will start when the user clicks and drags on this widget.
buttons is a bitwise 'or' of the mouse buttons that can initiate dragging, eg GTK2.GDK_BUTTON1_MASK.
targets is an array of triples eg ({({"text/plain", GTK2.TARGET_SAME_APP, 0})}) where each triple gives an identifying MIME type, a flag specifying whether the drag should be allowed to go to other applications, and an ID which will be passed on to signal handlers. NOTE: For internal reasons, you are currently permitted a maximum of ten targets.
actions is the set of valid actions that can be performed; use constants GTK2.GDK_ACTION_COPY|GTK2.GDK_ACTION_MOVE etc.
- Method
error_bell
GTK2.Widgeterror_bell()- Description
Notifies the user about an input-related error on this widget. If the "gtk-error-bell" setting is TRUE, it calls gdk_window_beep(), otherwise it does nothing
- Method
freeze_child_notify
GTK2.Widgetfreeze_child_notify()- Description
Stops emission of "child-notify" signals. The signals are queued until thaw_child_notify() is called on the widget.
- Method
get_action
GTK2.Actionget_action()- Description
Returns the GTK2.Action that this widget is a proxy for.
- Method
get_clipboard
GTK2.Clipboardget_clipboard(GDK2.Atomselection)- Description
Returns the clipboard object for the given selection.
- Method
get_display
GTK2.GdkDisplayget_display()- Description
Get the GDK2.Display for the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a GTK2.Window at the top.
- Method
get_extension_events
intget_extension_events()- Description
Retrieves the extension events the widget will receive.
- Method
get_modifier_style
GTK2.RcStyleget_modifier_style()- Description
Returns the current modifier style.
- Method
get_no_show_all
intget_no_show_all()- Description
Returns the current value of the "no-show-all" property.
- Method
get_pango_context
GTK2.Pango.Contextget_pango_context()- Description
Gets a Pango.Context with the appropriate colormap, font description, and base direction for this widget.
- Method
get_pointer
mappingget_pointer()- Description
Obtains the location of the mouse pointer in widget coordinates.
- Method
get_screen
GTK2.GdkScreenget_screen()- Description
Get the GDK2.Screen from the toplevel window associated with this widget.
- Method
get_settings
GTK2.Settingsget_settings()- Description
Gets the settings object holding the settings (global property settings, RC file information, etc) used for this widget.
- Method
get_size_request
mappingget_size_request()- Description
Gets the size request that was explicityly set for the widget using set_size_request(). A value of -1 for width or height indices that that dimension has not been set explicityly and the natural requisition of the widget will be used instead. To get the size a widget will actually use, call size_request() instead.
- Method
get_snapshot
GTK2.GdkPixmapget_snapshot(GTK2.GdkRectangleclip_rect)- Description
Create a GDK2.Pixmap of the contents of the widget and its children
Works even if the widget is obscured. The depth and visual of the resulting pixmap is dependent on the widget being snapshot and likely differs from those of a target widget displaying the pixmap. The function GDK2.Pixbuf->get_from_drawable() can be used to convert the pixmap to a visual independent representation.
The snapshot are used by this function is the widget's allocation plus any extra space occupied by additional windows belonging to this widget (such as the arrows of a spin button). Thus, the resulting snapshot pixmap is possibly larger than the allocation.
If clip_rect is non-null, the resulting pixmap is shrunken to match the specified clip_rect. The (x,y) coordinates of clip_rect are interpreted widget relative. If width or height of clip_rect are 0 or negative, the width or height of the resulting pixmap will be shurnken by the respective amount. For instance, a clip_rect (+5,+5,-10,-10) will chop off 5 pixels at each side of the snapshot pixmap. If non-null, clip_rect will contain the exact widget-relative snapshot coordinates upon return. A clip_rect of (-1,-1,0,0) can be used to preserve the auto-grown snapshot area and use clip_rect as a pure output parameter.
The return pixmap can be 0, if the resulting clip_area was empty.
- Method
get_tooltip_window
GTK2.Windowget_tooltip_window()- Description
Returns the GtkWindow of the current tooltip
- Method
get_toplevel
GTK2.Widgetget_toplevel()- Description
This function returns the topmost widget in the container hierarchy this widget is a part of. If this widget has no parent widgets, it will be returned as the topmost widget.
- Method
get_window
GTK2.GdkWindowget_window()- Description
Returns the widget's window if it is realized, other NULL.
- Method
grab_default
GTK2.Widgetgrab_default()- Description
Causes this widget to become the default widget.
- Method
grab_focus
GTK2.Widgetgrab_focus()- Description
Causes this widget to have the keyboard focus. This widget must be a focusable widget, such as a GTK2.Entry; something like GTK2.Frame won't work.
- Method
has_screen
inthas_screen()- Description
Checks whether there is a GDK2.Screen associated with this widget.
- Method
input_shape_combine_mask
GTK2.Widgetinput_shape_combine_mask(GTK2.GdkBitmapshape_mask,intoffset_x,intoffset_y)- Description
Sets an input shape for this widget's GDK2.Window.
- Method
is_ancestor
intis_ancestor(GTK2.Widgetancestor)- Description
Determines whether this widget is somewhere inside ancestor.
- Method
is_composited
intis_composited()- Description
Whether this widget can rely on having its alpha channel drawn correctly.
- Method
is_focus
intis_focus()- Description
Determines if the widget is the focus widget within its toplevel. (This does not mean that the HAS_FOCUS flag is necessarily set; HAS_FOCUS will only be set if the toplevel widget additionally has the input focus.
- Method
keynav_failed
intkeynav_failed(intdirection)- Description
This function should be called whenever keyboard navigation within a single widget hits a boundary. The function emits the "keynav-changed" signal on the widget and its return value should be interpreted in a way similar to the return value of widget->child_focus():
When TRUE is returned, stay in the widget, the failed keyboard navigation is Ok and/or there is nowhere we can/should move the focus to.
When FALSE is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling widget->child_focus() on the widget's toplevel.
The default ::keynav-failed handler returns TRUE for GTK_DIR.TAB_FORWARD and GTK_DIR.TAB_BACKWARD. For the other values of GtkDirectionType, it looks at the "gtk-keynav-cursor-only"" setting and returns FALSE if the setting is TRUE. This way the entire user interface becomes cursor-navigatable on input devices such as mobile phones which only have cursor keys but no tab key.
Whenever the default handler returns TRUE, it also calls widget->error_bell() to notify the user of the failed keyboard navigation.
- Method
list_mnemonic_lables
arraylist_mnemonic_lables()- Description
Returns a list of the widgets, normally labels, for which this widget is the target of a mnemonic.
- Method
modify_base
GTK2.Widgetmodify_base(intstate,GTK2.GdkColorcolor)- Description
Sets the base color of the widget in a particular state. See modify_fg().
- Method
modify_bg
GTK2.Widgetmodify_bg(intstate,GTK2.GdkColorcolor)- Description
Sets the background color of the widget in a particular state. See modify_fg().
- Method
modify_cursor
GTK2.Widgetmodify_cursor(GTK2.GdkColorprimary,GTK2.GdkColorsecondary)- Description
Sets the cursor color to use in a widget.
- Method
modify_fg
GTK2.Widgetmodify_fg(intstate,GTK2.GdkColorcolor)- Description
Sets the foreground color of the widget in a particular state. state is one of
STATE_ACTIVE,STATE_INSENSITIVE,STATE_NORMAL,STATE_PRELIGHTandSTATE_SELECTED. color can be omitted to undo the effect of a previous call.
- Method
modify_text
GTK2.Widgetmodify_text(intstate,GTK2.GdkColorcolor)- Description
Sets the text color of the widget in a particular state. See modify_fg().
- Method
path
stringpath()- Description
Obtains the full path. The path is simply the name of a widget and all its parents in the container hierarchy, separated by periods.
- Method
queue_draw
GTK2.Widgetqueue_draw()- Description
Equivalent to calling queue_draw_area() for the entire area of the widget.
- Method
queue_draw_area
GTK2.Widgetqueue_draw_area(intx,inty,intwidth,intheight)- Description
Invalidates the rectangular area defined by x,y,width,height by calling GDK2.Window->invalidate_rect() on the widget's window and all its child windows. Once the main loop becomse idle (after the current batch of events has been processed, roughly), the window will receive expose events for the union of all regions that have been invalidated.
- Method
queue_resize
GTK2.Widgetqueue_resize()- Description
This function is only for use in widget implementations. Flags a widget to have its size renegotiated; should be called when a widget for some reason has a new size request. For example, when you change the text in a W(Label), GTK2.Label queues a resize to ensure there's enough space for the new text.
- Method
queue_resize_no_redraw
GTK2.Widgetqueue_resize_no_redraw()- Description
This function works like queue_resize(), except that the widget is not invalidated.
- Method
remove_accelerator
intremove_accelerator(GTK2.AccelGroupaccel_group,intaccel_key,intaccel_mods)- Description
Removes an accelerator.
- Method
remove_mnemonic_label
GTK2.Widgetremove_mnemonic_label(GTK2.Widgetlabel)- Description
Removes a widget from the list of mnemonic labels for this widget.
- Method
render_icon
GTK2.GdkPixbufrender_icon(stringstock_id,intsize,stringdetail)- Description
A convenience function that uses the theme engine and rc file settings to look up stock_id and render it to a pixbuf. stock_id should be a stock icon ID such as GTK2.STOCK_OPEN or GTK2.STOCK_OK. size should be a size such as GTK2.ICON_SIZE_MENU. detail should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code.
The pixels in the returned GDK2.Pixbuf are shared with the rest of the application and should not be modified.
- Method
reparent
GTK2.Widgetreparent(GTK2.Widgetnew_parent)- Description
Moves a widget from one W(Container) to another.
- Method
reset_shapes
GTK2.Widgetreset_shapes()- Description
Recursively resets the shape on this widget and its descendants.
- Method
set_accel_path
GTK2.Widgetset_accel_path(stringaccel_path,GTK2.AccelGroupaccel_group)- Description
Sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, this widget will be activated.
- Method
set_composite_name
GTK2.Widgetset_composite_name(stringname)- Description
Sets a widget's composite name.
- Method
set_direction
GTK2.Widgetset_direction(intdir)- Description
Sets the reading direction. This direction controls the primary direction for widgets containing text, and also the direction in which the children of the container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).
- Method
set_events
GTK2.Widgetset_events(intevents)- Description
Sets the event mask for a widget. The event mask determines which events a widget will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget's functionality, so be careful. This function must be called while a widget is unrealized. Consider add_events() for widgets that are already realized, or if you want to preserve the existing event mask. This function can't be used with GTK2.NO_WINDOW widgets; to get events on those widgets, place them inside a GTK2.EventBox and receive events on the event box.
- Method
set_extension_events
GTK2.Widgetset_extension_events(intmode)- Description
Sets the extension events mask to mode. One of
GDK_EXTENSION_EVENTS_ALL,GDK_EXTENSION_EVENTS_CURSORandGDK_EXTENSION_EVENTS_NONE
- Method
set_flags
GTK2.Widgetset_flags(intflags)- Description
Set certain flags, such as GTK2.CAN_DEFAULT.
- Method
set_name
GTK2.Widgetset_name(stringname)- Description
Widgets can be named, which allows you to refer to them from a gtkrc file. You can apply a style to widgets with a particular name in the gtkrc file.
- Method
set_no_show_all
GTK2.Widgetset_no_show_all(intno_show_all)- Description
Sets the "no-show-all" property, which determines whether calls to show_all() and hide_all() will affect this widget.
- Method
set_parent
GTK2.Widgetset_parent(GTK2.Widgetparent)- Description
Sets the container as the parent of this widget.
- Method
set_parent_window
GTK2.Widgetset_parent_window(GTK2.GdkWindowparent)- Description
Sets a non default parent window for this widget.
- Method
set_scroll_adjustments
GTK2.Widgetset_scroll_adjustments(GTK2.Adjustmenthadj,GTK2.Adjustmentvadj)- Description
For widgets that support scrolling, sets the scroll adjustments. For widgets that don't support scrolling, does nothing. Widgets that don't support scrolling can be scrolled by placing them in a W(Viewport), which does support scrolling.
- Method
set_sensitive
GTK2.Widgetset_sensitive(intsensitive)- Description
Sets the sensitivity. A widget is sensitive is the user can interact with it. Insensitive widgets are "grayed out" and the user can't interact with them. Insensitive widgets are known as "inactive", "disabled", or "ghosted" in some other toolkits.
- Method
set_size_request
GTK2.Widgetset_size_request(intwidth,intheight)- Description
Sets the minimum size of a widget; that is, the widget's size request will be width by height. You can use this function to force a widget to be either larger or smaller than it normally would be.
In most cases, set_default_size() is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request. When dealing with window sizes, set_geometry_hints() can be a useful function as well.
Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it's basically impossible to hardcode a size that will always be correct.
The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it request.
If the size request in a given direction is -1 (unset), then the "natural" size request of the widget will be used instead.
Widgets can't actually be allocated a size less than 1x1, but you can pass 0,0 to this function to mean "as small as possible".
- Method
set_tooltip_markup
GTK2.Widgetset_tooltip_markup(stringmarkup)- Description
Sets markup as the contents of the tooltip
- Method
set_tooltip_text
GTK2.Widgetset_tooltip_text(stringtext)- Description
Sets text as the contents of the tooltip.
- Method
set_tooltip_window
GTK2.Widgetset_tooltip_window(GTK2.Windowwindow)- Description
Replaces the default, usually yellow, window used for displaying tooltips.
- Method
shape_combine_mask
GTK2.Widgetshape_combine_mask(GTK2.GdkBitmapshape_mask,intoffset_x,intoffset_y)- Description
Sets a shape for a widget's GDK2.Window. This allows for transparent window, etc.
- Method
show
GTK2.Widgetshow()- Description
Show the widget. Most (almost all) widgets must be shown to be visible on the screen.
- Method
show_now
GTK2.Widgetshow_now()- Description
Shows a widget. If the widget is an unmapped toplevel widget (i.e. a GTK2.Window that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during this function.
- Method
style_get_property
mixedstyle_get_property(stringname)- Description
Gets the value of the style property called name.
- Method
thaw_child_notify
GTK2.Widgetthaw_child_notify()- Description
Reverts the effect of a previous call to freeze_child_notify().
Class GTK2.Window
- Description
The basic window. Nothing much to say about it. It can only contain one child widget. Show the main window last to avoid annoying flashes when the subwidget (and it's subwidgets) are added to it, this is done automatically by calling 'window->show_all' when you are done with your widget packing. Properties: int accept-focus int allow-grow int allow-shrink int decorated int default-height int default-width int deletable int destroy-with-parent int focus-on-map int gravity
GDK_GRAVITY_CENTER,GDK_GRAVITY_EAST,GDK_GRAVITY_NORTH,GDK_GRAVITY_NORTH_EAST,GDK_GRAVITY_NORTH_WEST,GDK_GRAVITY_SOUTH,GDK_GRAVITY_SOUTH_EAST,GDK_GRAVITY_SOUTH_WEST,GDK_GRAVITY_STATICandGDK_GRAVITY_WESTint has-toplevel-focus GDK2.Pixbuf icon string icon-name int is-active int modal float opacity int resizable string role GDK2.Screen screen int skip-pager-hint int skip-taskbar-hint string startup-id string title GTK2.Window transient-for int typeWINDOW_POPUPandWINDOW_TOPLEVELint type-hintGDK_WINDOW_TYPE_HINT_DESKTOP,GDK_WINDOW_TYPE_HINT_DIALOG,GDK_WINDOW_TYPE_HINT_DOCK,GDK_WINDOW_TYPE_HINT_MENU,GDK_WINDOW_TYPE_HINT_NORMAL,GDK_WINDOW_TYPE_HINT_SPLASHSCREEN,GDK_WINDOW_TYPE_HINT_TOOLBARandGDK_WINDOW_TYPE_HINT_UTILITYint urgency-hint int window-positionWIN_POS_CENTER,WIN_POS_CENTER_ALWAYS,WIN_POS_CENTER_ON_PARENT,WIN_POS_MOUSEandWIN_POS_NONESignals: activate_default
activate_focus
frame_event
keys_changed
move_focus
set_focus
- Method
activate_default
intactivate_default()- Description
Activates the default widget, unless the current focused widget has been configured to receive the default action, in which case the focuses widget is activated.
- Method
add_accel_group
GTK2.Windowadd_accel_group(GTK2.AccelGroupgroup)- Description
This function adds an accelerator group to the window. The shortcuts in the table will work in the window, it's child, and all children of it's child that do not select keyboard input.
- Method
add_mnemonic
GTK2.Windowadd_mnemonic(intkeyval,GTK2.Widgettarget)- Description
Adds a mnemonic to this window.
- Method
begin_move_drag
GTK2.Windowbegin_move_drag(intbutton,introot_x,introot_y,inttimestamp)- Description
Starts moving a window. This function is used if an application has window movement grips.
- Method
begin_resize_drag
GTK2.Windowbegin_resize_drag(intedge,intbutton,introot_x,introot_y,inttimestamp)- Description
Starts resizing a window. This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the window manager or windowing system.
- Method
create
GTK2.WindowGTK2.Window(int|mappingprops)- Description
Argument is one of
WINDOW_POPUPandWINDOW_TOPLEVEL, or a mapping of allowed properties.
- Method
fullscreen
GTK2.Windowfullscreen()- Description
Asks to place this window in the fullscreen state. Same caveats iconify().
- Method
get_decorated
intget_decorated()- Description
Returns whether the window has been set to have decorations such as a title bar.
- Method
get_default_size
mappingget_default_size()- Description
Gets the default size of the window. A value of -1 for the width or height indicates that a default size has not been explicitly set for that dimeension, so the "natural" size of the window will be used.
- Method
get_deletable
intget_deletable()- Description
Returns whether the window has been set to have a close button.
- Method
get_destroy_with_parent
intget_destroy_with_parent()- Description
Returns whether the window will be destroyed with its transient parent.
- Method
get_focus
GTK2.Widgetget_focus()- Description
Retrieves the current focused widget within the window. Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then has_focus() will not be true for the widget.
- Method
get_group
GTK2.WindowGroupget_group()- Description
Returns the group for this widget or the default group.
- Method
get_icon_list
arrayget_icon_list()- Description
Retrieves the list of icons set by set_icon_list().
- Method
get_icon_name
stringget_icon_name()- Description
Returns the name of the themed icon for the window.
- Method
get_mnemonic_modifier
intget_mnemonic_modifier()- Description
Returns the mnemonic modifier for this window.
- Method
get_position
mappingget_position()- Description
This function returns the position you need to pass to move() to keep this window in its current position. This means that the meaning of the returned value varies with window gravity.
If you haven't changed the window gravity, its gravity will be GDK2.GRAVITY_NORTH_WEST. This means that get_position() gets the position of the top-left corner of the window manager frame for the window. move() sets the position of this same top-left corner.
get_position() is not 100% reliable because X does not specify a way to obtain the geometry of the decorations placed on a window by the window manager. Thus GTK+ is using a "best guess" that works with most window managers.
Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a window to its current position as returned by get_position() tends to result in moving the window slightly. Window managers are slowly getting better over time.
If a window has gravity GDK2.GRAVITY_STATIC the window manager frame is not relevant, and thus get_position() will always produc accurate results. However you can't use static gravity to do things like place a window in a corner of the screen, because static gravity ignores the window manager decorations.
If you are saving and restoring your application's window positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state.
- Method
get_skip_pager_hint
intget_skip_pager_hint()- Description
Gets the value set by set_skip_pager_hint().
- Method
get_skip_taskbar_hint
intget_skip_taskbar_hint()- Description
Gets the value set by set_skip_taskbar_hint().
- Method
get_transient_for
GTK2.Windowget_transient_for()- Description
Fetches the transient parent for this window.
- Method
has_toplevel_focus
inthas_toplevel_focus()- Description
Returns whether the input focus is within this window. For real toplevel windows, this is identical to is_active(), but for embedded windows, like W(Plug), the results will differ.
- Method
iconify
GTK2.Windowiconify()- Description
Asks to iconify (minimize) this window. Note that you shouldn't assume the window is definitely iconified afterward, because other entities (e.g. the user or window manager) could deiconify it again, or there may not be a window manager in which case iconification isn't possible, etc.
- Method
is_active
intis_active()- Description
Returns whether the window is part of the current active toplevel. (That is, the toplevel window receiving keystrokes.) The return value is true if the window is active toplevel itself, but also if it is, say, a W(Plug) embedded in the active toplevel. You might use this function if you wanted to draw a widget differently in an active window from a widget in an inactive window().
- Method
mnemonic_activate
intmnemonic_activate(intkeyval,intmodifier)- Description
Activates the targets associated with the mnemonic. modifier is one of GDK2.SHIFT_MASK, GDK2.LOCK_MASK, GDK2.CONTROL_MASK, GDK2.MOD1_MASK, GDK2.MOD2_MASK, GDK2.MOD3_MASK, GDK2.MOD4_MASK, GDK2.MOD5_MASK, GDK2.BUTTON1_MASK, GDK2.BUTTON2_MASK, GDK2.BUTTON3_MASK, GDK2.BUTTON4_MASK GDK2.BUTTON5_MASK, GDK2.RELEASE_MASK, GDK2.MODIFIER_MASK
- Method
move
GTK2.Windowmove(intx,inty)- Description
Asks the window manage to move the window to the given position. Window managers are free to ignore this; most window managers ignore request for initial window positions (instead using a user-defined placement algorithm) and honor requests after the window has already been shown.
Note: the position is the position of the gravity-determined reference point for the window. The gravity determines two things: first, the location of the reference point in root window coordinates; and second, which point on the window is position at the reference point.
By default the gravity is GDK2.GRAVITY_NORTH_WEST, so the reference point is simply the x,y supplied to move(). The top-left corner of the window decorations (aka window frame or border) will be place at x,y. Therefore, to position a window at the top left of the screen, you want to use the default gravity (which is GDK2.GRAVITY_NORTH_WEST) and move the window to 0,0.
To position a window at the bottom right corner of the screen, you would set GDK2.GRAVITY_SOUTH_EAST, which means that the reference point is at x + the window width and y + the window height, and the bottom-right corner of the window border will be placed at that reference point.
- Method
parse_geometry
intparse_geometry(stringgeometry)- Description
Parses a standard X geometry string.
- Method
present
GTK2.Windowpresent()- Description
Presents this window to the user. This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user's platform, window manager, and preferences.
If hidden, it calls show() as well.
- Method
present_with_time
GTK2.Windowpresent_with_time(inttimestamp)- Description
Presents a window to the user with a timestamp. See present().
- Method
remove_accel_group
GTK2.Windowremove_accel_group(GTK2.AccelGroupgroup)- Description
Reverses the effects of add_accel_group().
- Method
remove_mnemonic
GTK2.Windowremove_mnemonic(intkeyval,GTK2.Widgettarget)- Description
Removes a mnemonic from this window.
- Method
reshow_with_initial_size
GTK2.Windowreshow_with_initial_size()- Description
Hides the window, then reshows it, resetting the default size and position of the window.
- Method
resize
GTK2.Windowresize(intwidth,intheight)- Description
Resizes the window as if the user had done so, obeying geometry constraints.
- Method
set_accept_focus
GTK2.Windowset_accept_focus(intsetting)- Description
Windows may set a hint asking the desktop environment not to receive the input focus.
- Method
set_decorated
GTK2.Windowset_decorated(intsetting)- Description
Add title bar, resize controls, etc. Default is true, so you may only need to use this function if you want to remove decorations. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling show().
- Method
set_default
GTK2.Windowset_default(GTK2.Widgetchild)- Description
The default widget is the widget that's activated when the user presses Enter in a dialog (for example). This function sets or unsets the default widget. When setting (rather than unsetting) the default widget it's generally easier to call GTK2.Widget->grab_default() on the widget.
- Method
set_default_size
GTK2.Windowset_default_size(intwidth,intheight)- Description
Sets the default size of a window. If the window's "natural" size (its size request) is larger than the default, the default will be ignored. more generally, if the default size does not obey the geometry hints for the window (set_geometry_hints() can be used to set these explicitly), the default size will be clamped to the nearest permitted size.
Unlike set_size_request(), which sets a size request for a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the window).
For more control over a window's initial size and how resizing works, investigate set_geometry_hints().
For some uses, resize() is a more appropriate function. resize() changes the current size of the window, rather than the size to be used on initial display. resize() always affects the window itself, not the geometry widget.
The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
Window scan't actually be 0x0 in size, they must be at least 1x1, but passing 0 for width and height is OK, resulting in a 1x1 default size.
- Method
set_deletable
GTK2.Windowset_deletable(intsetting)- Description
By default, windows have a close button in the window frame. Some window managers allow GTK+ to disable this button. If you set the deletable property to FALSE using this function, GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling show().
On Windows, this function always works, since there's no window manager policy involved.
- Method
set_destroy_with_parent
GTK2.Windowset_destroy_with_parent(intsetting)- Description
If setting is true, then destroying the transient parent of this window will also destroy the window itself. This is useful for dialogs that shouldn't persist beyond the lifetime of the main window they're associated with, for example.
- Method
set_focus
GTK2.Windowset_focus(GTK2.Widgetchild)- Description
If child is not the current focus widget, and is focusable, sets it as the focus widget for the window. If child is 0, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use GTK2.Widget->grab_focus() instead of this function.
- Method
set_focus_on_map
GTK2.Windowset_focus_on_map(intsetting)- Description
Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped.
- Method
set_geometry_hints
GTK2.Windowset_geometry_hints(GTK2.Widgetwidget,mappinggeometry)- Description
This function sets up hints about how a window can be resized by the user. You can set a minimum and maximum size; allowed resized increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. geometry is a mapping with the following fields. Any field which is omitted is left as the default: ([ "min_width": int, "min_height": int, "max_width": int, "max_height": int, "base_width": int, "base_height": int, "width_inc": int, "height_inc": int, "min_aspect": float, "max_aspect": float, "win_gravity": int,
GDK_GRAVITY_CENTER,GDK_GRAVITY_EAST,GDK_GRAVITY_NORTH,GDK_GRAVITY_NORTH_EAST,GDK_GRAVITY_NORTH_WEST,GDK_GRAVITY_SOUTH,GDK_GRAVITY_SOUTH_EAST,GDK_GRAVITY_SOUTH_WEST,GDK_GRAVITY_STATICandGDK_GRAVITY_WEST]); min_width/min_height/max_width/max_height may be set to -1, and it will substitute the size request of the window or geometry widget. If the minimum size hint is not provided, it will use its requisition as the minimum size. If the minimum size is provided and a geometry widget is set, it will take the minimum size as the minimum size of the geometry widget rather than the entire window. The base size is treat similarly. min_width: minimum width of the window (-1 to use requisition) min_height: minimum height of window (-1 to use requisition) max_width: maximum width of window (-1 to use requisition) max_height: maximum height of window (-1 to use requisition) base_width: allow window widths are base_width+width_inc*N (-1 allowed) base_height: allowed window widths are base_height+height_inc*N (-1 allowed) width_inc: width resize increment height_inc: height resize increment min_aspect: minimum width/height ratio max_aspect: maximum width/height ratio win_gravity: window gravity
- Method
set_gravity
GTK2.Windowset_gravity(intgravity)- Description
Window gravity defines the meaning of coordinates passed to move().
The default window gravity is GDK2.GRAVITY_NORTH_WEST, which will typically "do what you mean."
- Method
set_icon
GTK2.Windowset_icon(GTK2.GdkPixbuficon)- Description
Sets up the icon representing this window. This icon is used when the window is minimized (also know as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts.
The icon should be provided in whatever size it was naturally drawn; that is, don't scale the image before passing it. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.
If you have your icon hand-drawn in multiple sizes, use set_icon_list(). Then the best size will be used.
- Method
set_icon_list
GTK2.Windowset_icon_list(arraylist)- Description
Set up the icons for minimizing.
set_icon_list() allows you to pass in the same icon in several hand-drawn sizes. The list should contain the natural sizes your icon is avilable in; that is, don't scale the image before passing it. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.
By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling.
Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and larger images (64x64, 128x128) if you have them.
- Method
set_icon_name
GTK2.Windowset_icon_name(stringname)- Description
Sets the icon for the window from a named themed icon.
- Method
set_mnemonic_modifier
GTK2.Windowset_mnemonic_modifier(intmodifier)- Description
Sets the mnemonic modifer for this window.
- Method
set_modal
GTK2.Windowset_modal(intsetting)- Description
Sets a window modal or non-modal. Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use set_transient_for() to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.
- Method
set_opacity
GTK2.Windowset_opacity(floatopacity)- Description
Request the windowing system to make this window partially transparent, with opacity 0 being full transparent and 1 fully opaque.
- Method
set_position
GTK2.Windowset_position(intpos)- Description
Sets a position contraint for this window. If the old or new constraint is GTK2.WIN_POS_CENTER_ALWAYS, this will also cause the window to be repositioned to satisfy the new constraint.
- Method
set_resizable
GTK2.Windowset_resizable(intsetting)- Description
Sets whether the user can resize a window. Windows are user resizable by default.
- Method
set_skip_pager_hint
GTK2.Windowset_skip_pager_hint(intsetting)- Description
Windows may set a hint asking the desktop environment not to display the window in the pager.
- Method
set_skip_taskbar_hint
GTK2.Windowset_skip_taskbar_hint(intsetting)- Description
Windows may set a hint asking the desktop environment not to display the window in the task bar. This function sets this hint.
- Method
set_startup_id
GTK2.Windowset_startup_id(stringid)- Description
Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying GDK2.Window. Normally, startup identifier is managed automatically and you should only use this function in special cases like transferring focus from other processes. You should use this function before calling window->present() or any equivalent function generating a window map event.
- Method
set_title
GTK2.Windowset_title(stringtitle)- Description
Set the window title. The default title is the value sent to setup_gtk, or if none is sent, Pike GTK.
- Method
set_transient_for
GTK2.Windowset_transient_for(GTK2.Windowparent)- Description
Dialog window should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. W(Dialog) and other convenience objects in GTK+ will sometimes call set_transient_for on your behalf.
- Method
set_type_hint
GTK2.Windowset_type_hint(inthint)- Description
Set type of window. Values are
GDK_WINDOW_TYPE_HINT_DESKTOP,GDK_WINDOW_TYPE_HINT_DIALOG,GDK_WINDOW_TYPE_HINT_DOCK,GDK_WINDOW_TYPE_HINT_MENU,GDK_WINDOW_TYPE_HINT_NORMAL,GDK_WINDOW_TYPE_HINT_SPLASHSCREEN,GDK_WINDOW_TYPE_HINT_TOOLBARandGDK_WINDOW_TYPE_HINT_UTILITY
- Method
set_urgency_hint
GTK2.Windowset_urgency_hint(intsetting)- Description
Windows may set a hint asking the desktop environment to draw the users attention to the window. This function sets this hint.
- Method
set_wmclass
GTK2.Windowset_wmclass(stringname,stringclass)- Description
Set the window manager application name and class.
Class GTK2.WindowGroup
- Description
Limit the effect of grabs.
- Method
create
GTK2.WindowGroupGTK2.WindowGroup()- Description
Creates a new GTK2.WindowGroup object. Grabs added with GTK2.grab_add() only affect windows with the same GTK2.WindowGroup.
Class GTK2.build_pgtk
Class GTK2.build_pgtk.Class
- Variable
name
Variable file
Variable line stringGTK2.build_pgtk.Class.namestring|zeroGTK2.build_pgtk.Class.fileintGTK2.build_pgtk.Class.line
- Variable
name
Class GTK2.build_pgtk.Constant
- Variable
name
Variable type
Variable file
Variable line stringGTK2.build_pgtk.Constant.nameTypeGTK2.build_pgtk.Constant.typestringGTK2.build_pgtk.Constant.fileintGTK2.build_pgtk.Constant.line
- Variable
name
Class GTK2.build_pgtk.GtkFunction
- Variable
parent
Variable name
Variable return_type
Variable arg_types
Variable arg_names
Variable body
Variable require
Variable doc
Variable file
Variable line ClassGTK2.build_pgtk.GtkFunction.parentstringGTK2.build_pgtk.GtkFunction.nameType|zeroGTK2.build_pgtk.GtkFunction.return_typearray(Type) GTK2.build_pgtk.GtkFunction.arg_typesarray(string) GTK2.build_pgtk.GtkFunction.arg_namesmixedGTK2.build_pgtk.GtkFunction.bodyarrayGTK2.build_pgtk.GtkFunction.requirestringGTK2.build_pgtk.GtkFunction.docstringGTK2.build_pgtk.GtkFunction.fileintGTK2.build_pgtk.GtkFunction.line
- Method
__create__
protectedlocalvoid__create__(Classparent,stringname,Type|zeroreturn_type,array(Type)arg_types,array(string)arg_names,mixedbody,arrayrequire,stringdoc,stringfile,intline)
- Variable
parent
Class GTK2.build_pgtk.Member
- Variable
name
Variable type
Variable set
Variable file
Variable line
Variable parent stringGTK2.build_pgtk.Member.nameTypeGTK2.build_pgtk.Member.typeintGTK2.build_pgtk.Member.setstringGTK2.build_pgtk.Member.fileintGTK2.build_pgtk.Member.lineClassGTK2.build_pgtk.Member.parent
- Method
__create__
protectedlocalvoid__create__(stringname,Typetype,intset,stringfile,intline,Classparent)
- Variable
name
Class GTK2.build_pgtk.Property
- Variable
name
Variable type
Variable set
Variable file
Variable line
Variable parent stringGTK2.build_pgtk.Property.nameTypeGTK2.build_pgtk.Property.typeintGTK2.build_pgtk.Property.setstringGTK2.build_pgtk.Property.fileintGTK2.build_pgtk.Property.lineClassGTK2.build_pgtk.Property.parent
- Method
__create__
protectedlocalvoid__create__(stringname,Typetype,intset,stringfile,intline,Classparent)
- Variable
name
Module GTK2.G
Class GTK2.G.InitiallyUnowned
- Description
Abstract class - do not instantiate
Class GTK2.G.Object
- Description
The base object. All GDK and GTK classes inherit from this. The Pango classes also inherit from this class.
Signals: notify
- Method
_destruct
protectedG.Object_destruct()- Description
Destroy this object. This is the normal way to (eg) close a window - simply call destruct(obj) and it will be destroyed.
- Method
accel_groups_activate
G.Objectaccel_groups_activate(intaccel_key,intaccel_mods)- Description
Finds the first accelerator in an GTK.AccelGroup attached to this object that matches accel_key and accel_mods, and activates that accelerator.
- Method
new_signal
intnew_signal(stringname,arraytypes,stringreturn_type)- Description
Create a new signal.
- Method
notify
G.Objectnotify(stringproperty)- Description
Emits a "notify" signal for the named property on the object.
- Method
set_data
objectset_data(stringname,mixedarg)- Description
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
- Method
set_property
G.Objectset_property(stringproperty,mixedvalue)- Description
Set a property on a G.Object (and any derived types) to value.
- Method
signal_block
G.Objectsignal_block(intsignal_id)- Description
Temporarily block a signal handler. No signals will be received while the handler is blocked. See signal_connect() for more info.
- Method
signal_connect
intsignal_connect(stringsignal,function(:void)callback,mixed|voidcallback_arg,string|voiddetail,int|voidconnect_before)- Description
Connect a signal to a pike function. The function will be called with the last argument to this function as its last argument (defaults to 0); the first argument is always the widget, and any other arguments are the ones supplied by GTK. If connect_before is nonzero, the callback will be called prior to the normal handling of the signal (and can return true to suppress that handling), otherwise it will be called after.
The return value of this function can be used to remove a signal with signal_disconnect(), and block and unblock the signal with signal_block() and signal_unblock().
- Method
signal_disconnect
G.Objectsignal_disconnect(intsignal_id)- Description
Remove a signal formerly added by signal_connect. The argument is the return value of signal_connect(). See signal_connect() for more info.
- Method
signal_emit
G.Objectsignal_emit(stringsignal_name,string|voiddetail)- Description
Send the current named signal.
Module GTK2.Pango
Class GTK2.Pango.AttrList
- Description
A PangoAttrList.
Class GTK2.Pango.FontDescription
- Description
Pango Font Description.
- Method
better_match
intbetter_match(GTK2.Pango.FontDescriptionnew,GTK2.Pango.FontDescriptionold)- Description
Determines if the style attributes of new are a closer match than old, or if old is omitted, determines if new is a match at all. Approximate matching is done for weight and style; other attributes must match exactly.
- Method
create
GTK2.Pango.FontDescriptionGTK2.Pango.FontDescription(string|voiddesc)- Description
Create a new font description. If desc is present, creates a new font description from a string representation in the form "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]", where FAMILY-LIST is a comma separated list of families optionally terminated by a comma, STYLE-OPTIONS is a whitespace separated list of words where each word describes one of style, variant, weight, or stretch, and size is a decimal number (size in points). Any one of the options may be absent. If FAMILY-LIST is absent, then the family name will be blank. If STYLE-OPTIONS is missing, then all style options will be set to the default values. If SIZE is missing, the size in the resulting font description will be set to 0.
- Method
equal
intequal(GTK2.Pango.FontDescriptiondesc)- Description
Compares two font descriptions for equality.
- Method
merge
Pango.FontDescriptionmerge(GTK2.Pango.FontDescriptiondesc,intreplace)- Description
Merges the fields that are set int desc to the fields in this description. If replace is false, only fields in this description that are not already set are affected. If true, then fields that are already set will be replaced as well.
- Method
set_family
Pango.FontDescriptionset_family(stringfamily)- Description
Sets the family name. The family name represents a family of related fonts styles, and will resolve to a particular PangoFontFamily.
- Method
set_size
Pango.FontDescriptionset_size(intsize)- Description
Sets the size in fractional points. This is the size of the font in points, scaled by PANGO_SCALE. (That is, a size value of 10*PANGO_SCALE) is a 10 point font. The conversion factor between points and device units depends on system configuration and the output device. For screen display, a logical DPI of 96 is common, in which case a 10 point font corresponds to a 1o*(96.72) = 13.3 pixel font. Use set_absolute_size() if you need a particular size in device units.
- Method
set_stretch
Pango.FontDescriptionset_stretch(intstretch)- Description
Sets the stretch. This specifies how narrow or wide the font should be. One of
PANGO_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_EXPANDED.
- Method
set_style
Pango.FontDescriptionset_style(intstyle)- Description
Sets the style. This describes whether the font is slanted and the manner in which is is slanted. One of
PANGO_STYLE_ITALIC,PANGO_STYLE_NORMALandPANGO_STYLE_OBLIQUE. Most fonts will either have an italic style or an oblique style, but not both, and font matching in Pango will match italic specifications with oblique fonts and vice-versa if an exact match is not found.
- Method
set_variant
Pango.FontDescriptionset_variant(intvariant)- Description
Sets the variant. One of
PANGO_VARIANT_NORMALandPANGO_VARIANT_SMALL_CAPS.
- Method
set_weight
Pango.FontDescriptionset_weight(intweight)- Description
Sets the weight. The weight specifies how bold or light the font should be. In addition to the values of
PANGO_WEIGHT_BOLD,PANGO_WEIGHT_HEAVY,PANGO_WEIGHT_LIGHT,PANGO_WEIGHT_NORMAL,PANGO_WEIGHT_ULTRABOLDandPANGO_WEIGHT_ULTRALIGHT, other intermediate numeric values are possible.
- Method
to_filename
stringto_filename()- Description
Creates a filename representation. The filename is identical to the result from calling to_string(), but with underscores instead of characters that are untypical in filenames, and in lower case only.
Class GTK2.Pango.Layout
- Description
Pango Layout.
- Method
context_changed
Pango.Layoutcontext_changed()- Description
Forces recomputation of any state in the layout that might depend on the layout's context. This function should be called if you make changes to the context subsequent to creating the layout.
- Method
create
GTK2.Pango.LayoutGTK2.Pango.Layout(GTK2.Pango.Contextcontext)- Description
Create a new layout with attributes initialized to default values for a particular Pango.Context
- Method
get_auto_dir
intget_auto_dir()- Description
Gets whether to calculate the bidirectional base direction for the layout according to the contents of the layout.
- Method
get_cursor_pos
arrayget_cursor_pos(intindex)- Description
Given an index within a layout, determines the positions of the strong and weak cursors if the insertion point is at that index. The position of each cursor is stored as a zero-width rectangle. The strong cursor is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted. Returns: array of mappings, each mapping is the same as index_to_pos().
- Method
get_indent
intget_indent()- Description
Gets the paragraph indent in pango units. A negative value indicates a hanging indent.
- Method
get_justify
intget_justify()- Description
Gets whether or not each complete line should be stretched to fill the entire width of the layout.
- Method
get_single_paragraph_mode
intget_single_paragraph_mode()- Description
Gets the value set by set_single_paragraph_mode().
- Method
get_tabs
GTK2.Pango.TabArrayget_tabs()- Description
Gets the current W(TabArray) used by this layout. If no W(TabArray) has been set, then the default tabs are in use and 0 is returned. Default tabs are every 8 spaces.
- Method
index_to_pos
mappingindex_to_pos(intindex)- Description
Converts from an index to the onscreen position corresponding to the grapheme at that index, which is represented as a rectangle. Note that x is always the leading edge of the grapheme and x+width the trailing edge of the grapheme. If the direction of the grapheme is right-to-left, then width will be negative.
Returns: ([ "x": x coordinate, "y": y coordinate, "width": width of the rectangle, "height": height of the rectangle ])
- Method
move_cursor_visually
mappingmove_cursor_visually(intstrong,intold_index,intold_trailing,intdir)- Description
Computes a new cursor position from an old position and a count of positions to move visually. If count is positive, then the new strong cursor position will be one position to the right of the old cursor position. If count is negative, then the new strong cursor position will be one position to the left of the old cursor position.
In the presence of bidirectional text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off the end of a run.
Motion here is in cursor positions, not in characters, so a single call to move_cursor_visually() may move the cursor over multiple characters when multiple characters combine to form a single grapheme.
- Method
set_alignment
Pango.Layoutset_alignment(intalignment)- Description
Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.) One of
PANGO_ALIGN_CENTER,PANGO_ALIGN_LEFTandPANGO_ALIGN_RIGHT.
- Method
set_auto_dir
Pango.Layoutset_auto_dir(intauto_dir)- Description
Sets whether to calculate the bidirectional base direction for the layout according to the contents of the layout; when this flag is on (the default), then paragraphs that begin with strong right-to-left characters (Arabic and Hebrew principally), will have right-left-layout, paragraphs with letters from other scripts will have left-to-right layout. Paragraphs with only neutral characters get their direction from the surrounding paragraphs.
When false, the choice between left-to-right and right-to-left layout is done by according to the base direction of the Pango.Context.
- Method
set_font_description
Pango.Layoutset_font_description(GTK2.Pango.FontDescriptiondesc)- Description
Sets the default font description for the layout. If no font description is set on the layout, the font descriptions from the layout's context is used.
- Method
set_indent
Pango.Layoutset_indent(intindent)- Description
Sets the width in pango units to indent each paragraph. A negative value of indent will produce a hanging indent. That is, the first line will have the full width, and subsequent lines will be indented by the absolute value of indent.
- Method
set_justify
Pango.Layoutset_justify(intjustify)- Description
Sets whether or not each complete line should be stretched to fill the entire width of the layout. This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters.
- Method
set_markup
Pango.Layoutset_markup(stringmarkup,intlength)- Description
Same as set_markup_with_accel(), but the markup text isn't scanned for accelerators.
- Method
set_markup_with_accel
Pango.Layoutset_markup_with_accel(stringmarkup,intlength,int|voidaccel_marker)- Description
Sets the layout text and attribute from marked-up text. Replaces the current text and attribute list.
If accel_marker is nonzero, the given character will mark the character following it as an accelerator. For example, the accel marker might be an ampersand or underscore. All characters marked as an acclerator will receive a GTK2.PANGO_UNDERLINE_LOW attribute, and the first character so marked will be returned. Two accel_marker characters following each other produce a single literal accel_marker character.
- Method
set_single_paragraph_mode
Pango.Layoutset_single_paragraph_mode(intsetting)- Description
If setting is true, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters. Used when you want to allow editing of newlines on a single text line.
- Method
set_spacing
Pango.Layoutset_spacing(intspacing)- Description
Sets the amount of spacing between the lines.
- Method
set_tabs
Pango.Layoutset_tabs(GTK2.Pango.TabArraytabs)- Description
Sets the tabs to use, overriding the default tabs (by default, tabs are every 8 spaces). If tabs is omitted, the default tabs are reinstated.
- Method
set_text
Pango.Layoutset_text(sprintf_formattext,sprintf_args...fmt)- Description
Sets the text of the layout.
- Method
set_width
Pango.Layoutset_width(intwidth)- Description
Sets the width to which the lines should be wrapped.
- Method
set_wrap
Pango.Layoutset_wrap(intwrap)- Description
Sets the wrap mode; the wrap mode only has an effect if a width is set on the layout with set_width(). To turn off wrapping, set the width to -1. One of
PANGO_WRAP_CHAR,PANGO_WRAP_WORDandPANGO_WRAP_WORD_CHAR.
- Method
xy_to_index
mappingxy_to_index(intx,inty)- Description
Converts from x and y position within a layout to the byte index to the character at that logical position. If the y position is not inside the layout, the closest position is chosen (the position will be clamped inside the layout). If the X position is not within the layout, then the start or the end of the line is chosen as describe for x_to_index(). If either the x or y positions were not inside the layout, then returns 0.
Returns: ([ "index": byte index, "trailing": where in grapheme user clicked ]).
Class GTK2.Pango.LayoutIter
- Description
PangoLayoutIter.
- Method
at_last_line
intat_last_line()- Description
Determines whether this iter is on the last line of the layout.
- Method
get_baseline
intget_baseline()- Description
Gets the y position of the current line's baseline, in layout coordinates (origin at top left of the entire layout).
- Method
get_char_extents
mappingget_char_extents()- Description
Gets the extents of the current character, in layout coordinates (origin is the top left of the entire layout).
- Method
get_cluster_extents
arrayget_cluster_extents()- Description
Gets the extents of the current cluster, in layout coordinates.
- Method
get_index
intget_index()- Description
Gets the current byte index. Note that iterating forward by char moves in visual order, not logical order, so indexes may not be sequential. Also, the index may be equal to the length of the text in the layout.
- Method
get_line_yrange
arrayget_line_yrange()- Description
Divides the vertical space being iterated over between the lines in the layout, and returns the space belonging to the current line. A line's range includes the line's logical extents, plus half of the spacing above and below the line, if Pango.Layout->set_spacing() has been called to set layout spacing. The y positions are in layout coordinates.
- Method
get_run_extents
arrayget_run_extents()- Description
Gets the extents of the current run in layout coordinates.
- Method
next_char
intnext_char()- Description
Moves forward to the next character in visual order. If it was already at the end of the layout, returns false.
- Method
next_cluster
intnext_cluster()- Description
Moves forward to the next cluster in visual order. If it was already at the end of the layout, returns false.
- Method
next_line
intnext_line()- Description
Moves forward to the start of the next line. If it is already on the last line, returns false.
Class GTK2.Pango.LayoutLine
- Description
PangoLayoutLine.
- Method
get_extents
arrayget_extents()- Description
Computes the logical and ink extents of a layout line.
- Method
get_pixel_extents
arrayget_pixel_extents()- Description
Computes the logical and ink extents of a layout line, in device units.
- Method
index_to_x
intindex_to_x(intindex,inttrailing)- Description
Converts an index within a line to an x position.
- Method
x_to_index
mappingx_to_index(intx_pos)- Description
Converts from x offset to the byte index of the corresponding character within the text of the layout. If x_pos is outside the line, index and trailing will point to the very first or very last position in the line. This determination is based on the resolved direction of the paragraph; for example, if the resolved direction is right-to-left, then an X position to the right of the line (after it) results in 0 being stored in index and trailing. An X position to the left of the line results in index pointing to the (logical) last grapheme in the line and trailing set to the number of characters in that grapheme. The reverse is true for a left-to-right line.
Class GTK2.Pango.TabArray
- Description
A set of tab stops for laying out text that includes tab characters.
- Method
create
GTK2.Pango.TabArrayGTK2.Pango.TabArray(intinitial_size,intposition_in_pixels)- Description
Creates an array of initial_size tab stops. Tab stops are specified in pixel units if positions_in_pixels is true, otherwise in Pango units. All stops are initially at position 0.
- Method
get_positions_in_pixels
intget_positions_in_pixels()- Description
Returns true if the tab positions are in pixels, false if they are in Pango units.
- Method
resize
Pango.TabArrayresize(intnew_size)- Description
Resizes the array. You must subsequently initialize any tabs that were added as a result of growing the array.
- Method
add_builtin_icon
Module GDK
- Description
GDK wrapper module.
This is a convenience module that is identical to either either the
GDK2or theGDK1module depending on which (if any) of them is available.- See also
GDK1,GDK2