Pike Reference Manual

16. Graphic User Interface

Module GTK

Description

GTK wrapper module.

This is a convenience module that is identical to the latest supported GTK versionm, if available. Currently only GTK2 is possible.

See also

GTK2

Inherit GTK2: inherit GTK2 : GTK2

Module GTK2

Constant ACCEL_LOCKED: constant GTK2.ACCEL_LOCKED

Constant ACCEL_MASK: constant GTK2.ACCEL_MASK

Constant ACCEL_VISIBLE: constant GTK2.ACCEL_VISIBLE

Constant ANCHOR_CENTER: constant GTK2.ANCHOR_CENTER

Constant ANCHOR_E: constant GTK2.ANCHOR_E

Constant ANCHOR_EAST: constant GTK2.ANCHOR_EAST

Constant ANCHOR_N: constant GTK2.ANCHOR_N

Constant ANCHOR_NE: constant GTK2.ANCHOR_NE

Constant ANCHOR_NORTH: constant GTK2.ANCHOR_NORTH

Constant ANCHOR_NORTH_EAST: constant GTK2.ANCHOR_NORTH_EAST

Constant ANCHOR_NORTH_WEST: constant GTK2.ANCHOR_NORTH_WEST

Constant ANCHOR_NW: constant GTK2.ANCHOR_NW

Constant ANCHOR_S: constant GTK2.ANCHOR_S

Constant ANCHOR_SE: constant GTK2.ANCHOR_SE

Constant ANCHOR_SOUTH: constant GTK2.ANCHOR_SOUTH

Constant ANCHOR_SOUTH_EAST: constant GTK2.ANCHOR_SOUTH_EAST

Constant ANCHOR_SOUTH_WEST: constant GTK2.ANCHOR_SOUTH_WEST

Constant ANCHOR_SW: constant GTK2.ANCHOR_SW

Constant ANCHOR_W: constant GTK2.ANCHOR_W

Constant ANCHOR_WEST: constant GTK2.ANCHOR_WEST

Constant APP_PAINTABLE: constant GTK2.APP_PAINTABLE

Constant ARROW_DOWN: constant GTK2.ARROW_DOWN

Constant ARROW_LEFT: constant GTK2.ARROW_LEFT

Constant ARROW_RIGHT: constant GTK2.ARROW_RIGHT

Constant ARROW_UP: constant GTK2.ARROW_UP

Constant ASSISTANT_PAGE_CONFIRM: constant GTK2.ASSISTANT_PAGE_CONFIRM

Constant ASSISTANT_PAGE_CONTENT: constant GTK2.ASSISTANT_PAGE_CONTENT

Constant ASSISTANT_PAGE_INTRO: constant GTK2.ASSISTANT_PAGE_INTRO

Constant ASSISTANT_PAGE_PROGRESS: constant GTK2.ASSISTANT_PAGE_PROGRESS

Constant ASSISTANT_PAGE_SUMMARY: constant GTK2.ASSISTANT_PAGE_SUMMARY

Constant BUTTONBOX_DEFAULT_STYLE: constant GTK2.BUTTONBOX_DEFAULT_STYLE

Constant BUTTONBOX_EDGE: constant GTK2.BUTTONBOX_EDGE

Constant BUTTONBOX_END: constant GTK2.BUTTONBOX_END

Constant BUTTONBOX_SPREAD: constant GTK2.BUTTONBOX_SPREAD

Constant BUTTONBOX_START: constant GTK2.BUTTONBOX_START

Constant BUTTONS_CANCEL: constant GTK2.BUTTONS_CANCEL

Constant BUTTONS_CLOSE: constant GTK2.BUTTONS_CLOSE

Constant BUTTONS_NONE: constant GTK2.BUTTONS_NONE

Constant BUTTONS_OK: constant GTK2.BUTTONS_OK

Constant BUTTONS_OK_CANCEL: constant GTK2.BUTTONS_OK_CANCEL

Constant BUTTONS_YES_NO: constant GTK2.BUTTONS_YES_NO

Constant CALENDAR_NO_MONTH_CHANGE: constant GTK2.CALENDAR_NO_MONTH_CHANGE

Constant CALENDAR_SHOW_DAY_NAMES: constant GTK2.CALENDAR_SHOW_DAY_NAMES

Constant CALENDAR_SHOW_HEADING: constant GTK2.CALENDAR_SHOW_HEADING

Constant CALENDAR_SHOW_WEEK_NUMBERS: constant GTK2.CALENDAR_SHOW_WEEK_NUMBERS

Constant CALENDAR_WEEK_START_MONDAY: constant GTK2.CALENDAR_WEEK_START_MONDAY

Constant CAN_DEFAULT: constant GTK2.CAN_DEFAULT

Constant CAN_FOCUS: constant GTK2.CAN_FOCUS

Constant CELL_RENDERER_ACCEL_MODE_GTK: constant GTK2.CELL_RENDERER_ACCEL_MODE_GTK

Constant CELL_RENDERER_ACCEL_MODE_OTHER: constant GTK2.CELL_RENDERER_ACCEL_MODE_OTHER

Constant CELL_RENDERER_FOCUSED: constant GTK2.CELL_RENDERER_FOCUSED

Constant CELL_RENDERER_INSENSITIVE: constant GTK2.CELL_RENDERER_INSENSITIVE

Constant CELL_RENDERER_MODE_ACTIVATABLE: constant GTK2.CELL_RENDERER_MODE_ACTIVATABLE

Constant CELL_RENDERER_MODE_EDITABLE: constant GTK2.CELL_RENDERER_MODE_EDITABLE

Constant CELL_RENDERER_MODE_INERT: constant GTK2.CELL_RENDERER_MODE_INERT

Constant CELL_RENDERER_PRELIT: constant GTK2.CELL_RENDERER_PRELIT

Constant CELL_RENDERER_SELECTED: constant GTK2.CELL_RENDERER_SELECTED

Constant CELL_RENDERER_SORTED: constant GTK2.CELL_RENDERER_SORTED

Constant CENTIMETERS: constant GTK2.CENTIMETERS

Constant COMPOSITE_CHILD: constant GTK2.COMPOSITE_CHILD

Constant CORNER_BOTTOM_LEFT: constant GTK2.CORNER_BOTTOM_LEFT

Constant CORNER_BOTTOM_RIGHT: constant GTK2.CORNER_BOTTOM_RIGHT

Constant CORNER_TOP_LEFT: constant GTK2.CORNER_TOP_LEFT

Constant CORNER_TOP_RIGHT: constant GTK2.CORNER_TOP_RIGHT

Constant CURVE_TYPE_FREE: constant GTK2.CURVE_TYPE_FREE

Constant CURVE_TYPE_LINEAR: constant GTK2.CURVE_TYPE_LINEAR

Constant CURVE_TYPE_SPLINE: constant GTK2.CURVE_TYPE_SPLINE

Constant DATABOX_BARS: constant GTK2.DATABOX_BARS

Constant DATABOX_CROSS_SIMPLE: constant GTK2.DATABOX_CROSS_SIMPLE

Constant DATABOX_GRID: constant GTK2.DATABOX_GRID

Constant DATABOX_LINES: constant GTK2.DATABOX_LINES

Constant DATABOX_NOT_DISPLAYED: constant GTK2.DATABOX_NOT_DISPLAYED

Constant DATABOX_POINTS: constant GTK2.DATABOX_POINTS

Constant DELETE_CHARS: constant GTK2.DELETE_CHARS

Constant DELETE_DISPLAY_LINES: constant GTK2.DELETE_DISPLAY_LINES

Constant DELETE_DISPLAY_LINE_ENDS: constant GTK2.DELETE_DISPLAY_LINE_ENDS

Constant DELETE_PARAGRAPHS: constant GTK2.DELETE_PARAGRAPHS

Constant DELETE_PARAGRAPH_ENDS: constant GTK2.DELETE_PARAGRAPH_ENDS

Constant DELETE_WHITESPACE: constant GTK2.DELETE_WHITESPACE

Constant DELETE_WORDS: constant GTK2.DELETE_WORDS

Constant DELETE_WORD_ENDS: constant GTK2.DELETE_WORD_ENDS

Constant DEST_DEFAULT_ALL: constant GTK2.DEST_DEFAULT_ALL

Constant DEST_DEFAULT_DROP: constant GTK2.DEST_DEFAULT_DROP

Constant DEST_DEFAULT_HIGHLIGHT: constant GTK2.DEST_DEFAULT_HIGHLIGHT

Constant DEST_DEFAULT_MOTION: constant GTK2.DEST_DEFAULT_MOTION

Constant DIALOG_DESTROY_WITH_PARENT: constant GTK2.DIALOG_DESTROY_WITH_PARENT

Constant DIALOG_MODAL: constant GTK2.DIALOG_MODAL

Constant DIALOG_NO_SEPARATOR: constant GTK2.DIALOG_NO_SEPARATOR

Constant DIR_DOWN: constant GTK2.DIR_DOWN

Constant DIR_LEFT: constant GTK2.DIR_LEFT

Constant DIR_RIGHT: constant GTK2.DIR_RIGHT

Constant DIR_TAB_BACKWARD: constant GTK2.DIR_TAB_BACKWARD

Constant DIR_TAB_FORWARD: constant GTK2.DIR_TAB_FORWARD

Constant DIR_UP: constant GTK2.DIR_UP

Constant DOUBLE_BUFFERED: constant GTK2.DOUBLE_BUFFERED

Constant ENTRY_ICON_PRIMARY: constant GTK2.ENTRY_ICON_PRIMARY

Constant ENTRY_ICON_SECONDARY: constant GTK2.ENTRY_ICON_SECONDARY

Constant EXPAND: constant GTK2.EXPAND

Constant EXPANDER_COLLAPSED: constant GTK2.EXPANDER_COLLAPSED

Constant EXPANDER_EXPANDED: constant GTK2.EXPANDER_EXPANDED

Constant EXPANDER_SEMI_COLLAPSED: constant GTK2.EXPANDER_SEMI_COLLAPSED

Constant EXPANDER_SEMI_EXPANDED: constant GTK2.EXPANDER_SEMI_EXPANDED

Constant FALSE: constant GTK2.FALSE

Constant FILE_CHOOSER_ACTION_CREATE_FOLDER: constant GTK2.FILE_CHOOSER_ACTION_CREATE_FOLDER

Constant FILE_CHOOSER_ACTION_OPEN: constant GTK2.FILE_CHOOSER_ACTION_OPEN

Constant FILE_CHOOSER_ACTION_SAVE: constant GTK2.FILE_CHOOSER_ACTION_SAVE

Constant FILE_CHOOSER_ACTION_SELECT_FOLDER: constant GTK2.FILE_CHOOSER_ACTION_SELECT_FOLDER

Constant FILE_CHOOSER_ERROR_BAD_FILENAME: constant GTK2.FILE_CHOOSER_ERROR_BAD_FILENAME

Constant FILE_CHOOSER_ERROR_NONEXISTENT: constant GTK2.FILE_CHOOSER_ERROR_NONEXISTENT

Constant FILE_FILTER_DISPLAY_NAME: constant GTK2.FILE_FILTER_DISPLAY_NAME

Constant FILE_FILTER_FILENAME: constant GTK2.FILE_FILTER_FILENAME

Constant FILE_FILTER_MIME_TYPE: constant GTK2.FILE_FILTER_MIME_TYPE

Constant FILE_FILTER_URI: constant GTK2.FILE_FILTER_URI

Constant FILL: constant GTK2.FILL

Constant FLOATING: constant GTK2.FLOATING

Constant GDK_2BUTTON_PRESS: constant GTK2.GDK_2BUTTON_PRESS

Constant GDK_3BUTTON_PRESS: constant GTK2.GDK_3BUTTON_PRESS

Constant GDK_ACTION_ASK: constant GTK2.GDK_ACTION_ASK

Constant GDK_ACTION_COPY: constant GTK2.GDK_ACTION_COPY

Constant GDK_ACTION_DEFAULT: constant GTK2.GDK_ACTION_DEFAULT

Constant GDK_ACTION_LINK: constant GTK2.GDK_ACTION_LINK

Constant GDK_ACTION_MOVE: constant GTK2.GDK_ACTION_MOVE

Constant GDK_ACTION_PRIVATE: constant GTK2.GDK_ACTION_PRIVATE

Constant GDK_ALL_EVENTS_MASK: constant GTK2.GDK_ALL_EVENTS_MASK

Constant GDK_AND: constant GTK2.GDK_AND

Constant GDK_AND_INVERT: constant GTK2.GDK_AND_INVERT

Constant GDK_AND_REVERSE: constant GTK2.GDK_AND_REVERSE

Constant GDK_ARROW: constant GTK2.GDK_ARROW

Constant GDK_AXIS_IGNORE: constant GTK2.GDK_AXIS_IGNORE

Constant GDK_AXIS_LAST: constant GTK2.GDK_AXIS_LAST

Constant GDK_AXIS_PRESSURE: constant GTK2.GDK_AXIS_PRESSURE

Constant GDK_AXIS_WHEEL: constant GTK2.GDK_AXIS_WHEEL

Constant GDK_AXIS_X: constant GTK2.GDK_AXIS_X

Constant GDK_AXIS_XTILT: constant GTK2.GDK_AXIS_XTILT

Constant GDK_AXIS_Y: constant GTK2.GDK_AXIS_Y

Constant GDK_AXIS_YTILT: constant GTK2.GDK_AXIS_YTILT

Constant GDK_BASED_ARROW_DOWN: constant GTK2.GDK_BASED_ARROW_DOWN

Constant GDK_BASED_ARROW_UP: constant GTK2.GDK_BASED_ARROW_UP

Constant GDK_BOAT: constant GTK2.GDK_BOAT

Constant GDK_BOGOSITY: constant GTK2.GDK_BOGOSITY

Constant GDK_BOTTOM_LEFT_CORNER: constant GTK2.GDK_BOTTOM_LEFT_CORNER

Constant GDK_BOTTOM_RIGHT_CORNER: constant GTK2.GDK_BOTTOM_RIGHT_CORNER

Constant GDK_BOTTOM_SIDE: constant GTK2.GDK_BOTTOM_SIDE

Constant GDK_BOTTOM_TEE: constant GTK2.GDK_BOTTOM_TEE

Constant GDK_BOX_SPIRAL: constant GTK2.GDK_BOX_SPIRAL

Constant GDK_BUTTON1_MASK: constant GTK2.GDK_BUTTON1_MASK

Constant GDK_BUTTON1_MOTION_MASK: constant GTK2.GDK_BUTTON1_MOTION_MASK

Constant GDK_BUTTON2_MASK: constant GTK2.GDK_BUTTON2_MASK

Constant GDK_BUTTON2_MOTION_MASK: constant GTK2.GDK_BUTTON2_MOTION_MASK

Constant GDK_BUTTON3_MASK: constant GTK2.GDK_BUTTON3_MASK

Constant GDK_BUTTON3_MOTION_MASK: constant GTK2.GDK_BUTTON3_MOTION_MASK

Constant GDK_BUTTON4_MASK: constant GTK2.GDK_BUTTON4_MASK

Constant GDK_BUTTON5_MASK: constant GTK2.GDK_BUTTON5_MASK

Constant GDK_BUTTON_MOTION_MASK: constant GTK2.GDK_BUTTON_MOTION_MASK

Constant GDK_BUTTON_PRESS: constant GTK2.GDK_BUTTON_PRESS

Constant GDK_BUTTON_PRESS_MASK: constant GTK2.GDK_BUTTON_PRESS_MASK

Constant GDK_BUTTON_RELEASE: constant GTK2.GDK_BUTTON_RELEASE

Constant GDK_BUTTON_RELEASE_MASK: constant GTK2.GDK_BUTTON_RELEASE_MASK

Constant GDK_CAP_BUTT: constant GTK2.GDK_CAP_BUTT

Constant GDK_CAP_NOT_LAST: constant GTK2.GDK_CAP_NOT_LAST

Constant GDK_CAP_PROJECTING: constant GTK2.GDK_CAP_PROJECTING

Constant GDK_CAP_ROUND: constant GTK2.GDK_CAP_ROUND

Constant GDK_CENTER_PTR: constant GTK2.GDK_CENTER_PTR

Constant GDK_CIRCLE: constant GTK2.GDK_CIRCLE

Constant GDK_CLEAR: constant GTK2.GDK_CLEAR

Constant GDK_CLIENT_EVENT: constant GTK2.GDK_CLIENT_EVENT

Constant GDK_CLIP_BY_CHILDREN: constant GTK2.GDK_CLIP_BY_CHILDREN

Constant GDK_CLOCK: constant GTK2.GDK_CLOCK

Constant GDK_COFFEE_MUG: constant GTK2.GDK_COFFEE_MUG

Constant GDK_COLORSPACE_RGB: constant GTK2.GDK_COLORSPACE_RGB

Constant GDK_CONFIGURE: constant GTK2.GDK_CONFIGURE

Constant GDK_CONTROL_MASK: constant GTK2.GDK_CONTROL_MASK

Constant GDK_COPY: constant GTK2.GDK_COPY

Constant GDK_COPY_INVERT: constant GTK2.GDK_COPY_INVERT

Constant GDK_CROSS: constant GTK2.GDK_CROSS

Constant GDK_CROSSHAIR: constant GTK2.GDK_CROSSHAIR

Constant GDK_CROSSING_GRAB: constant GTK2.GDK_CROSSING_GRAB

Constant GDK_CROSSING_NORMAL: constant GTK2.GDK_CROSSING_NORMAL

Constant GDK_CROSSING_UNGRAB: constant GTK2.GDK_CROSSING_UNGRAB

Constant GDK_CROSS_REVERSE: constant GTK2.GDK_CROSS_REVERSE

Constant GDK_CURSOR_IS_PIXMAP: constant GTK2.GDK_CURSOR_IS_PIXMAP

Constant GDK_DECOR_ALL: constant GTK2.GDK_DECOR_ALL

Constant GDK_DECOR_BORDER: constant GTK2.GDK_DECOR_BORDER

Constant GDK_DECOR_MAXIMIZE: constant GTK2.GDK_DECOR_MAXIMIZE

Constant GDK_DECOR_MENU: constant GTK2.GDK_DECOR_MENU

Constant GDK_DECOR_MINIMIZE: constant GTK2.GDK_DECOR_MINIMIZE

Constant GDK_DECOR_RESIZEH: constant GTK2.GDK_DECOR_RESIZEH

Constant GDK_DECOR_TITLE: constant GTK2.GDK_DECOR_TITLE

Constant GDK_DELETE: constant GTK2.GDK_DELETE

Constant GDK_DESTROY: constant GTK2.GDK_DESTROY

Constant GDK_DIAMOND_CROSS: constant GTK2.GDK_DIAMOND_CROSS

Constant GDK_DOT: constant GTK2.GDK_DOT

Constant GDK_DOTBOX: constant GTK2.GDK_DOTBOX

Constant GDK_DOUBLE_ARROW: constant GTK2.GDK_DOUBLE_ARROW

Constant GDK_DRAFT_LARGE: constant GTK2.GDK_DRAFT_LARGE

Constant GDK_DRAFT_SMALL: constant GTK2.GDK_DRAFT_SMALL

Constant GDK_DRAG_ENTER: constant GTK2.GDK_DRAG_ENTER

Constant GDK_DRAG_LEAVE: constant GTK2.GDK_DRAG_LEAVE

Constant GDK_DRAG_MOTION: constant GTK2.GDK_DRAG_MOTION

Constant GDK_DRAG_PROTO_LOCAL: constant GTK2.GDK_DRAG_PROTO_LOCAL

Constant GDK_DRAG_PROTO_MOTIF: constant GTK2.GDK_DRAG_PROTO_MOTIF

Constant GDK_DRAG_PROTO_NONE: constant GTK2.GDK_DRAG_PROTO_NONE

Constant GDK_DRAG_PROTO_OLE2: constant GTK2.GDK_DRAG_PROTO_OLE2

Constant GDK_DRAG_PROTO_ROOTWIN: constant GTK2.GDK_DRAG_PROTO_ROOTWIN

Constant GDK_DRAG_PROTO_WIN32_DROPFILES: constant GTK2.GDK_DRAG_PROTO_WIN32_DROPFILES

Constant GDK_DRAG_PROTO_XDND: constant GTK2.GDK_DRAG_PROTO_XDND

Constant GDK_DRAG_STATUS: constant GTK2.GDK_DRAG_STATUS

Constant GDK_DRAPED_BOX: constant GTK2.GDK_DRAPED_BOX

Constant GDK_DROP_FINISHED: constant GTK2.GDK_DROP_FINISHED

Constant GDK_DROP_START: constant GTK2.GDK_DROP_START

Constant GDK_ENTER_NOTIFY: constant GTK2.GDK_ENTER_NOTIFY

Constant GDK_ENTER_NOTIFY_MASK: constant GTK2.GDK_ENTER_NOTIFY_MASK

Constant GDK_EQUIV: constant GTK2.GDK_EQUIV

Constant GDK_EVEN_ODD_RULE: constant GTK2.GDK_EVEN_ODD_RULE

Constant GDK_EXCHANGE: constant GTK2.GDK_EXCHANGE

Constant GDK_EXPOSE: constant GTK2.GDK_EXPOSE

Constant GDK_EXPOSURE_MASK: constant GTK2.GDK_EXPOSURE_MASK

Constant GDK_EXTENSION_EVENTS_ALL: constant GTK2.GDK_EXTENSION_EVENTS_ALL

Constant GDK_EXTENSION_EVENTS_CURSOR: constant GTK2.GDK_EXTENSION_EVENTS_CURSOR

Constant GDK_EXTENSION_EVENTS_NONE: constant GTK2.GDK_EXTENSION_EVENTS_NONE

Constant GDK_FILTER_CONTINUE: constant GTK2.GDK_FILTER_CONTINUE

Constant GDK_FILTER_REMOVE: constant GTK2.GDK_FILTER_REMOVE

Constant GDK_FILTER_TRANSLATE: constant GTK2.GDK_FILTER_TRANSLATE

Constant GDK_FLEUR: constant GTK2.GDK_FLEUR

Constant GDK_FOCUS_CHANGE: constant GTK2.GDK_FOCUS_CHANGE

Constant GDK_FOCUS_CHANGE_MASK: constant GTK2.GDK_FOCUS_CHANGE_MASK

Constant GDK_FUNC_ALL: constant GTK2.GDK_FUNC_ALL

Constant GDK_FUNC_CLOSE: constant GTK2.GDK_FUNC_CLOSE

Constant GDK_FUNC_MAXIMIZE: constant GTK2.GDK_FUNC_MAXIMIZE

Constant GDK_FUNC_MINIMIZE: constant GTK2.GDK_FUNC_MINIMIZE

Constant GDK_FUNC_MOVE: constant GTK2.GDK_FUNC_MOVE

Constant GDK_FUNC_RESIZE: constant GTK2.GDK_FUNC_RESIZE

Constant GDK_GC_BACKGROUND: constant GTK2.GDK_GC_BACKGROUND

Constant GDK_GC_CAP_STYLE: constant GTK2.GDK_GC_CAP_STYLE

Constant GDK_GC_CLIP_MASK: constant GTK2.GDK_GC_CLIP_MASK

Constant GDK_GC_CLIP_X_ORIGIN: constant GTK2.GDK_GC_CLIP_X_ORIGIN

Constant GDK_GC_CLIP_Y_ORIGIN: constant GTK2.GDK_GC_CLIP_Y_ORIGIN

Constant GDK_GC_EXPOSURES: constant GTK2.GDK_GC_EXPOSURES

Constant GDK_GC_FILL: constant GTK2.GDK_GC_FILL

Constant GDK_GC_FONT: constant GTK2.GDK_GC_FONT

Constant GDK_GC_FOREGROUND: constant GTK2.GDK_GC_FOREGROUND

Constant GDK_GC_FUNCTION: constant GTK2.GDK_GC_FUNCTION

Constant GDK_GC_JOIN_STYLE: constant GTK2.GDK_GC_JOIN_STYLE

Constant GDK_GC_LINE_STYLE: constant GTK2.GDK_GC_LINE_STYLE

Constant GDK_GC_LINE_WIDTH: constant GTK2.GDK_GC_LINE_WIDTH

Constant GDK_GC_STIPPLE: constant GTK2.GDK_GC_STIPPLE

Constant GDK_GC_SUBWINDOW: constant GTK2.GDK_GC_SUBWINDOW

Constant GDK_GC_TILE: constant GTK2.GDK_GC_TILE

Constant GDK_GC_TS_X_ORIGIN: constant GTK2.GDK_GC_TS_X_ORIGIN

Constant GDK_GC_TS_Y_ORIGIN: constant GTK2.GDK_GC_TS_Y_ORIGIN

Constant GDK_GOBBLER: constant GTK2.GDK_GOBBLER

Constant GDK_GRAB_ALREADY_GRABBED: constant GTK2.GDK_GRAB_ALREADY_GRABBED

Constant GDK_GRAB_FROZEN: constant GTK2.GDK_GRAB_FROZEN

Constant GDK_GRAB_INVALID_TIME: constant GTK2.GDK_GRAB_INVALID_TIME

Constant GDK_GRAB_NOT_VIEWABLE: constant GTK2.GDK_GRAB_NOT_VIEWABLE

Constant GDK_GRAB_SUCCESS: constant GTK2.GDK_GRAB_SUCCESS

Constant GDK_GRAVITY_CENTER: constant GTK2.GDK_GRAVITY_CENTER

Constant GDK_GRAVITY_EAST: constant GTK2.GDK_GRAVITY_EAST

Constant GDK_GRAVITY_NORTH: constant GTK2.GDK_GRAVITY_NORTH

Constant GDK_GRAVITY_NORTH_EAST: constant GTK2.GDK_GRAVITY_NORTH_EAST

Constant GDK_GRAVITY_NORTH_WEST: constant GTK2.GDK_GRAVITY_NORTH_WEST

Constant GDK_GRAVITY_SOUTH: constant GTK2.GDK_GRAVITY_SOUTH

Constant GDK_GRAVITY_SOUTH_EAST: constant GTK2.GDK_GRAVITY_SOUTH_EAST

Constant GDK_GRAVITY_SOUTH_WEST: constant GTK2.GDK_GRAVITY_SOUTH_WEST

Constant GDK_GRAVITY_STATIC: constant GTK2.GDK_GRAVITY_STATIC

Constant GDK_GRAVITY_WEST: constant GTK2.GDK_GRAVITY_WEST

Constant GDK_GUMBY: constant GTK2.GDK_GUMBY

Constant GDK_HAND1: constant GTK2.GDK_HAND1

Constant GDK_HAND2: constant GTK2.GDK_HAND2

Constant GDK_HEART: constant GTK2.GDK_HEART

Constant GDK_HINT_ASPECT: constant GTK2.GDK_HINT_ASPECT

Constant GDK_HINT_BASE_SIZE: constant GTK2.GDK_HINT_BASE_SIZE

Constant GDK_HINT_MAX_SIZE: constant GTK2.GDK_HINT_MAX_SIZE

Constant GDK_HINT_MIN_SIZE: constant GTK2.GDK_HINT_MIN_SIZE

Constant GDK_HINT_POS: constant GTK2.GDK_HINT_POS

Constant GDK_HINT_RESIZE_INC: constant GTK2.GDK_HINT_RESIZE_INC

Constant GDK_HINT_USER_POS: constant GTK2.GDK_HINT_USER_POS

Constant GDK_HINT_USER_SIZE: constant GTK2.GDK_HINT_USER_SIZE

Constant GDK_ICON: constant GTK2.GDK_ICON

Constant GDK_IMAGE_FASTEST: constant GTK2.GDK_IMAGE_FASTEST

Constant GDK_IMAGE_NORMAL: constant GTK2.GDK_IMAGE_NORMAL

Constant GDK_IMAGE_SHARED: constant GTK2.GDK_IMAGE_SHARED

Constant GDK_INCLUDE_INFERIORS: constant GTK2.GDK_INCLUDE_INFERIORS

Constant GDK_INPUT_EXCEPTION: constant GTK2.GDK_INPUT_EXCEPTION

Constant GDK_INPUT_ONLY: constant GTK2.GDK_INPUT_ONLY

Constant GDK_INPUT_OUTPUT: constant GTK2.GDK_INPUT_OUTPUT

Constant GDK_INPUT_READ: constant GTK2.GDK_INPUT_READ

Constant GDK_INPUT_WRITE: constant GTK2.GDK_INPUT_WRITE

Constant GDK_INTERP_BILINEAR: constant GTK2.GDK_INTERP_BILINEAR

Constant GDK_INTERP_HYPER: constant GTK2.GDK_INTERP_HYPER

Constant GDK_INTERP_NEAREST: constant GTK2.GDK_INTERP_NEAREST

Constant GDK_INTERP_TILES: constant GTK2.GDK_INTERP_TILES

Constant GDK_INVERT: constant GTK2.GDK_INVERT

Constant GDK_IRON_CROSS: constant GTK2.GDK_IRON_CROSS

Constant GDK_JOIN_BEVEL: constant GTK2.GDK_JOIN_BEVEL

Constant GDK_JOIN_MITER: constant GTK2.GDK_JOIN_MITER

Constant GDK_JOIN_ROUND: constant GTK2.GDK_JOIN_ROUND

Constant GDK_KEY_PRESS: constant GTK2.GDK_KEY_PRESS

Constant GDK_KEY_PRESS_MASK: constant GTK2.GDK_KEY_PRESS_MASK

Constant GDK_KEY_RELEASE: constant GTK2.GDK_KEY_RELEASE

Constant GDK_KEY_RELEASE_MASK: constant GTK2.GDK_KEY_RELEASE_MASK

Constant GDK_LAST_CURSOR: constant GTK2.GDK_LAST_CURSOR

Constant GDK_LEAVE_NOTIFY: constant GTK2.GDK_LEAVE_NOTIFY

Constant GDK_LEAVE_NOTIFY_MASK: constant GTK2.GDK_LEAVE_NOTIFY_MASK

Constant GDK_LEFTBUTTON: constant GTK2.GDK_LEFTBUTTON

Constant GDK_LEFT_PTR: constant GTK2.GDK_LEFT_PTR

Constant GDK_LEFT_SIDE: constant GTK2.GDK_LEFT_SIDE

Constant GDK_LEFT_TEE: constant GTK2.GDK_LEFT_TEE

Constant GDK_LINE_DOUBLE_DASH: constant GTK2.GDK_LINE_DOUBLE_DASH

Constant GDK_LINE_ON_OFF_DASH: constant GTK2.GDK_LINE_ON_OFF_DASH

Constant GDK_LINE_SOLID: constant GTK2.GDK_LINE_SOLID

Constant GDK_LL_ANGLE: constant GTK2.GDK_LL_ANGLE

Constant GDK_LOCK_MASK: constant GTK2.GDK_LOCK_MASK

Constant GDK_LR_ANGLE: constant GTK2.GDK_LR_ANGLE

Constant GDK_LSB_FIRST: constant GTK2.GDK_LSB_FIRST

Constant GDK_MAN: constant GTK2.GDK_MAN

Constant GDK_MAP: constant GTK2.GDK_MAP

Constant GDK_MIDDLEBUTTON: constant GTK2.GDK_MIDDLEBUTTON

Constant GDK_MOD1_MASK: constant GTK2.GDK_MOD1_MASK

Constant GDK_MOD2_MASK: constant GTK2.GDK_MOD2_MASK

Constant GDK_MOD3_MASK: constant GTK2.GDK_MOD3_MASK

Constant GDK_MOD4_MASK: constant GTK2.GDK_MOD4_MASK

Constant GDK_MOD5_MASK: constant GTK2.GDK_MOD5_MASK

Constant GDK_MODE_DISABLED: constant GTK2.GDK_MODE_DISABLED

Constant GDK_MODE_SCREEN: constant GTK2.GDK_MODE_SCREEN

Constant GDK_MODE_WINDOW: constant GTK2.GDK_MODE_WINDOW

Constant GDK_MODIFIER_MASK: constant GTK2.GDK_MODIFIER_MASK

Constant GDK_MOTION_NOTIFY: constant GTK2.GDK_MOTION_NOTIFY

Constant GDK_MOUSE: constant GTK2.GDK_MOUSE

Constant GDK_MSB_FIRST: constant GTK2.GDK_MSB_FIRST

Constant GDK_NAND: constant GTK2.GDK_NAND

Constant GDK_NOOP: constant GTK2.GDK_NOOP

Constant GDK_NOR: constant GTK2.GDK_NOR

Constant GDK_NOTHING: constant GTK2.GDK_NOTHING

Constant GDK_NOTIFY_ANCESTOR: constant GTK2.GDK_NOTIFY_ANCESTOR

Constant GDK_NOTIFY_INFERIOR: constant GTK2.GDK_NOTIFY_INFERIOR

Constant GDK_NOTIFY_NONLINEAR: constant GTK2.GDK_NOTIFY_NONLINEAR

Constant GDK_NOTIFY_NONLINEAR_VIRTUAL: constant GTK2.GDK_NOTIFY_NONLINEAR_VIRTUAL

Constant GDK_NOTIFY_UNKNOWN: constant GTK2.GDK_NOTIFY_UNKNOWN

Constant GDK_NOTIFY_VIRTUAL: constant GTK2.GDK_NOTIFY_VIRTUAL

Constant GDK_NO_EXPOSE: constant GTK2.GDK_NO_EXPOSE

Constant GDK_OPAQUE_STIPPLED: constant GTK2.GDK_OPAQUE_STIPPLED

Constant GDK_OR: constant GTK2.GDK_OR

Constant GDK_OR_INVERT: constant GTK2.GDK_OR_INVERT

Constant GDK_OR_REVERSE: constant GTK2.GDK_OR_REVERSE

Constant GDK_OVERLAP_RECTANGLE_IN: constant GTK2.GDK_OVERLAP_RECTANGLE_IN

Constant GDK_OVERLAP_RECTANGLE_OUT: constant GTK2.GDK_OVERLAP_RECTANGLE_OUT

Constant GDK_OVERLAP_RECTANGLE_PART: constant GTK2.GDK_OVERLAP_RECTANGLE_PART

Constant GDK_OWNER_CHANGE: constant GTK2.GDK_OWNER_CHANGE

Constant GDK_OWNER_CHANGE_CLOSE: constant GTK2.GDK_OWNER_CHANGE_CLOSE

Constant GDK_OWNER_CHANGE_DESTROY: constant GTK2.GDK_OWNER_CHANGE_DESTROY

Constant GDK_OWNER_CHANGE_NEW_OWNER: constant GTK2.GDK_OWNER_CHANGE_NEW_OWNER

Constant GDK_PENCIL: constant GTK2.GDK_PENCIL

Constant GDK_PIRATE: constant GTK2.GDK_PIRATE

Constant GDK_PIXBUF_ALPHA_BILEVEL: constant GTK2.GDK_PIXBUF_ALPHA_BILEVEL

Constant GDK_PIXBUF_ALPHA_FULL: constant GTK2.GDK_PIXBUF_ALPHA_FULL

Constant GDK_PIXBUF_ERROR_BAD_OPTION: constant GTK2.GDK_PIXBUF_ERROR_BAD_OPTION

Constant GDK_PIXBUF_ERROR_CORRUPT_IMAGE: constant GTK2.GDK_PIXBUF_ERROR_CORRUPT_IMAGE

Constant GDK_PIXBUF_ERROR_FAILED: constant GTK2.GDK_PIXBUF_ERROR_FAILED

Constant GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY: constant GTK2.GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY

Constant GDK_PIXBUF_ERROR_UNKNOWN_TYPE: constant GTK2.GDK_PIXBUF_ERROR_UNKNOWN_TYPE

Constant GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION: constant GTK2.GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION

Constant GDK_PIXBUF_ROTATE_CLOCKWISE: constant GTK2.GDK_PIXBUF_ROTATE_CLOCKWISE

Constant GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE: constant GTK2.GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE

Constant GDK_PIXBUF_ROTATE_NONE: constant GTK2.GDK_PIXBUF_ROTATE_NONE

Constant GDK_PIXBUF_ROTATE_UPSIDEDOWN: constant GTK2.GDK_PIXBUF_ROTATE_UPSIDEDOWN

Constant GDK_PLUS: constant GTK2.GDK_PLUS

Constant GDK_POINTER_MOTION_HINT_MASK: constant GTK2.GDK_POINTER_MOTION_HINT_MASK

Constant GDK_POINTER_MOTION_MASK: constant GTK2.GDK_POINTER_MOTION_MASK

Constant GDK_PROPERTY_CHANGE_MASK: constant GTK2.GDK_PROPERTY_CHANGE_MASK

Constant GDK_PROPERTY_DELETE: constant GTK2.GDK_PROPERTY_DELETE

Constant GDK_PROPERTY_NEW_VALUE: constant GTK2.GDK_PROPERTY_NEW_VALUE

Constant GDK_PROPERTY_NOTIFY: constant GTK2.GDK_PROPERTY_NOTIFY

Constant GDK_PROP_MODE_APPEND: constant GTK2.GDK_PROP_MODE_APPEND

Constant GDK_PROP_MODE_PREPEND: constant GTK2.GDK_PROP_MODE_PREPEND

Constant GDK_PROP_MODE_REPLACE: constant GTK2.GDK_PROP_MODE_REPLACE

Constant GDK_PROXIMITY_IN: constant GTK2.GDK_PROXIMITY_IN

Constant GDK_PROXIMITY_IN_MASK: constant GTK2.GDK_PROXIMITY_IN_MASK

Constant GDK_PROXIMITY_OUT: constant GTK2.GDK_PROXIMITY_OUT

Constant GDK_PROXIMITY_OUT_MASK: constant GTK2.GDK_PROXIMITY_OUT_MASK

Constant GDK_QUESTION_ARROW: constant GTK2.GDK_QUESTION_ARROW

Constant GDK_RELEASE_MASK: constant GTK2.GDK_RELEASE_MASK

Constant GDK_RGB_DITHER_MAX: constant GTK2.GDK_RGB_DITHER_MAX

Constant GDK_RGB_DITHER_NONE: constant GTK2.GDK_RGB_DITHER_NONE

Constant GDK_RGB_DITHER_NORMAL: constant GTK2.GDK_RGB_DITHER_NORMAL

Constant GDK_RIGHTBUTTON: constant GTK2.GDK_RIGHTBUTTON

Constant GDK_RIGHT_PTR: constant GTK2.GDK_RIGHT_PTR

Constant GDK_RIGHT_SIDE: constant GTK2.GDK_RIGHT_SIDE

Constant GDK_RIGHT_TEE: constant GTK2.GDK_RIGHT_TEE

Constant GDK_RTL_LOGO: constant GTK2.GDK_RTL_LOGO

Constant GDK_SAILBOAT: constant GTK2.GDK_SAILBOAT

Constant GDK_SB_DOWN_ARROW: constant GTK2.GDK_SB_DOWN_ARROW

Constant GDK_SB_H_DOUBLE_ARROW: constant GTK2.GDK_SB_H_DOUBLE_ARROW

Constant GDK_SB_LEFT_ARROW: constant GTK2.GDK_SB_LEFT_ARROW

Constant GDK_SB_RIGHT_ARROW: constant GTK2.GDK_SB_RIGHT_ARROW

Constant GDK_SB_UP_ARROW: constant GTK2.GDK_SB_UP_ARROW

Constant GDK_SB_V_DOUBLE_ARROW: constant GTK2.GDK_SB_V_DOUBLE_ARROW

Constant GDK_SCROLL: constant GTK2.GDK_SCROLL

Constant GDK_SCROLL_DOWN: constant GTK2.GDK_SCROLL_DOWN

Constant GDK_SCROLL_LEFT: constant GTK2.GDK_SCROLL_LEFT

Constant GDK_SCROLL_MASK: constant GTK2.GDK_SCROLL_MASK

Constant GDK_SCROLL_RIGHT: constant GTK2.GDK_SCROLL_RIGHT

Constant GDK_SCROLL_UP: constant GTK2.GDK_SCROLL_UP

Constant GDK_SELECTION_CLEAR: constant GTK2.GDK_SELECTION_CLEAR

Constant GDK_SELECTION_NOTIFY: constant GTK2.GDK_SELECTION_NOTIFY

Constant GDK_SELECTION_REQUEST: constant GTK2.GDK_SELECTION_REQUEST

Constant GDK_SET: constant GTK2.GDK_SET

Constant GDK_SETTING: constant GTK2.GDK_SETTING

Constant GDK_SETTING_ACTION_CHANGED: constant GTK2.GDK_SETTING_ACTION_CHANGED

Constant GDK_SETTING_ACTION_DELETED: constant GTK2.GDK_SETTING_ACTION_DELETED

Constant GDK_SETTING_ACTION_NEW: constant GTK2.GDK_SETTING_ACTION_NEW

Constant GDK_SHIFT_MASK: constant GTK2.GDK_SHIFT_MASK

Constant GDK_SHUTTLE: constant GTK2.GDK_SHUTTLE

Constant GDK_SIZING: constant GTK2.GDK_SIZING

Constant GDK_SOLID: constant GTK2.GDK_SOLID

Constant GDK_SOURCE_CURSOR: constant GTK2.GDK_SOURCE_CURSOR

Constant GDK_SOURCE_ERASER: constant GTK2.GDK_SOURCE_ERASER

Constant GDK_SOURCE_MOUSE: constant GTK2.GDK_SOURCE_MOUSE

Constant GDK_SOURCE_PEN: constant GTK2.GDK_SOURCE_PEN

Constant GDK_SPIDER: constant GTK2.GDK_SPIDER

Constant GDK_SPRAYCAN: constant GTK2.GDK_SPRAYCAN

Constant GDK_STAR: constant GTK2.GDK_STAR

Constant GDK_STIPPLED: constant GTK2.GDK_STIPPLED

Constant GDK_STRUCTURE_MASK: constant GTK2.GDK_STRUCTURE_MASK

Constant GDK_SUBSTRUCTURE_MASK: constant GTK2.GDK_SUBSTRUCTURE_MASK

Constant GDK_TARGET: constant GTK2.GDK_TARGET

Constant GDK_TCROSS: constant GTK2.GDK_TCROSS

Constant GDK_TILED: constant GTK2.GDK_TILED

Constant GDK_TOP_LEFT_ARROW: constant GTK2.GDK_TOP_LEFT_ARROW

Constant GDK_TOP_LEFT_CORNER: constant GTK2.GDK_TOP_LEFT_CORNER

Constant GDK_TOP_RIGHT_CORNER: constant GTK2.GDK_TOP_RIGHT_CORNER

Constant GDK_TOP_SIDE: constant GTK2.GDK_TOP_SIDE

Constant GDK_TOP_TEE: constant GTK2.GDK_TOP_TEE

Constant GDK_TREK: constant GTK2.GDK_TREK

Constant GDK_UL_ANGLE: constant GTK2.GDK_UL_ANGLE

Constant GDK_UMBRELLA: constant GTK2.GDK_UMBRELLA

Constant GDK_UNMAP: constant GTK2.GDK_UNMAP

Constant GDK_UR_ANGLE: constant GTK2.GDK_UR_ANGLE

Constant GDK_VISIBILITY_FULLY_OBSCURED: constant GTK2.GDK_VISIBILITY_FULLY_OBSCURED

Constant GDK_VISIBILITY_NOTIFY: constant GTK2.GDK_VISIBILITY_NOTIFY

Constant GDK_VISIBILITY_NOTIFY_MASK: constant GTK2.GDK_VISIBILITY_NOTIFY_MASK

Constant GDK_VISIBILITY_PARTIAL: constant GTK2.GDK_VISIBILITY_PARTIAL

Constant GDK_VISIBILITY_UNOBSCURED: constant GTK2.GDK_VISIBILITY_UNOBSCURED

Constant GDK_VISUAL_DIRECT_COLOR: constant GTK2.GDK_VISUAL_DIRECT_COLOR

Constant GDK_VISUAL_GRAYSCALE: constant GTK2.GDK_VISUAL_GRAYSCALE

Constant GDK_VISUAL_PSEUDO_COLOR: constant GTK2.GDK_VISUAL_PSEUDO_COLOR

Constant GDK_VISUAL_STATIC_COLOR: constant GTK2.GDK_VISUAL_STATIC_COLOR

Constant GDK_VISUAL_STATIC_GRAY: constant GTK2.GDK_VISUAL_STATIC_GRAY

Constant GDK_VISUAL_TRUE_COLOR: constant GTK2.GDK_VISUAL_TRUE_COLOR

Constant GDK_WATCH: constant GTK2.GDK_WATCH

Constant GDK_WA_COLORMAP: constant GTK2.GDK_WA_COLORMAP

Constant GDK_WA_CURSOR: constant GTK2.GDK_WA_CURSOR

Constant GDK_WA_NOREDIR: constant GTK2.GDK_WA_NOREDIR

Constant GDK_WA_TITLE: constant GTK2.GDK_WA_TITLE

Constant GDK_WA_VISUAL: constant GTK2.GDK_WA_VISUAL

Constant GDK_WA_WMCLASS: constant GTK2.GDK_WA_WMCLASS

Constant GDK_WA_X: constant GTK2.GDK_WA_X

Constant GDK_WA_Y: constant GTK2.GDK_WA_Y

Constant GDK_WINDING_RULE: constant GTK2.GDK_WINDING_RULE

Constant GDK_WINDOW_CHILD: constant GTK2.GDK_WINDOW_CHILD

Constant GDK_WINDOW_DIALOG: constant GTK2.GDK_WINDOW_DIALOG

Constant GDK_WINDOW_EDGE_EAST: constant GTK2.GDK_WINDOW_EDGE_EAST

Constant GDK_WINDOW_EDGE_NORTH: constant GTK2.GDK_WINDOW_EDGE_NORTH

Constant GDK_WINDOW_EDGE_NORTH_EAST: constant GTK2.GDK_WINDOW_EDGE_NORTH_EAST

Constant GDK_WINDOW_EDGE_NORTH_WEST: constant GTK2.GDK_WINDOW_EDGE_NORTH_WEST

Constant GDK_WINDOW_EDGE_SOUTH: constant GTK2.GDK_WINDOW_EDGE_SOUTH

Constant GDK_WINDOW_EDGE_SOUTH_EAST: constant GTK2.GDK_WINDOW_EDGE_SOUTH_EAST

Constant GDK_WINDOW_EDGE_SOUTH_WEST: constant GTK2.GDK_WINDOW_EDGE_SOUTH_WEST

Constant GDK_WINDOW_EDGE_WEST: constant GTK2.GDK_WINDOW_EDGE_WEST

Constant GDK_WINDOW_FOREIGN: constant GTK2.GDK_WINDOW_FOREIGN

Constant GDK_WINDOW_ROOT: constant GTK2.GDK_WINDOW_ROOT

Constant GDK_WINDOW_STATE: constant GTK2.GDK_WINDOW_STATE

Constant GDK_WINDOW_STATE_ABOVE: constant GTK2.GDK_WINDOW_STATE_ABOVE

Constant GDK_WINDOW_STATE_BELOW: constant GTK2.GDK_WINDOW_STATE_BELOW

Constant GDK_WINDOW_STATE_FULLSCREEN: constant GTK2.GDK_WINDOW_STATE_FULLSCREEN

Constant GDK_WINDOW_STATE_ICONIFIED: constant GTK2.GDK_WINDOW_STATE_ICONIFIED

Constant GDK_WINDOW_STATE_MAXIMIZED: constant GTK2.GDK_WINDOW_STATE_MAXIMIZED

Constant GDK_WINDOW_STATE_STICKY: constant GTK2.GDK_WINDOW_STATE_STICKY

Constant GDK_WINDOW_STATE_WITHDRAWN: constant GTK2.GDK_WINDOW_STATE_WITHDRAWN

Constant GDK_WINDOW_TEMP: constant GTK2.GDK_WINDOW_TEMP

Constant GDK_WINDOW_TOPLEVEL: constant GTK2.GDK_WINDOW_TOPLEVEL

Constant GDK_WINDOW_TYPE_HINT_DESKTOP: constant GTK2.GDK_WINDOW_TYPE_HINT_DESKTOP

Constant GDK_WINDOW_TYPE_HINT_DIALOG: constant GTK2.GDK_WINDOW_TYPE_HINT_DIALOG

Constant GDK_WINDOW_TYPE_HINT_DOCK: constant GTK2.GDK_WINDOW_TYPE_HINT_DOCK

Constant GDK_WINDOW_TYPE_HINT_MENU: constant GTK2.GDK_WINDOW_TYPE_HINT_MENU

Constant GDK_WINDOW_TYPE_HINT_NORMAL: constant GTK2.GDK_WINDOW_TYPE_HINT_NORMAL

Constant GDK_WINDOW_TYPE_HINT_SPLASHSCREEN: constant GTK2.GDK_WINDOW_TYPE_HINT_SPLASHSCREEN

Constant GDK_WINDOW_TYPE_HINT_TOOLBAR: constant GTK2.GDK_WINDOW_TYPE_HINT_TOOLBAR

Constant GDK_WINDOW_TYPE_HINT_UTILITY: constant GTK2.GDK_WINDOW_TYPE_HINT_UTILITY

Constant GDK_XOR: constant GTK2.GDK_XOR

Constant GDK_XTERM: constant GTK2.GDK_XTERM

Constant GDK_X_CURSOR: constant GTK2.GDK_X_CURSOR

Constant GNOME_CLIENT_IS_CONNECTED: constant GTK2.GNOME_CLIENT_IS_CONNECTED

Constant GNOME_CLIENT_RESTARTED: constant GTK2.GNOME_CLIENT_RESTARTED

Constant GNOME_CLIENT_RESTORED: constant GTK2.GNOME_CLIENT_RESTORED

Constant GNOME_DATE_EDIT_24_HR: constant GTK2.GNOME_DATE_EDIT_24_HR

Constant GNOME_DATE_EDIT_SHOW_TIME: constant GTK2.GNOME_DATE_EDIT_SHOW_TIME

Constant GNOME_DATE_EDIT_WEEK_STARTS_ON_MONDAY: constant GTK2.GNOME_DATE_EDIT_WEEK_STARTS_ON_MONDAY

Constant GNOME_DIALOG_ERROR: constant GTK2.GNOME_DIALOG_ERROR

Constant GNOME_DIALOG_NORMAL: constant GTK2.GNOME_DIALOG_NORMAL

Constant GNOME_DOCK_BOTTOM: constant GTK2.GNOME_DOCK_BOTTOM

Constant GNOME_DOCK_ITEM_BEH_EXCLUSIVE: constant GTK2.GNOME_DOCK_ITEM_BEH_EXCLUSIVE

Constant GNOME_DOCK_ITEM_BEH_LOCKED: constant GTK2.GNOME_DOCK_ITEM_BEH_LOCKED

Constant GNOME_DOCK_ITEM_BEH_NEVER_FLOATING: constant GTK2.GNOME_DOCK_ITEM_BEH_NEVER_FLOATING

Constant GNOME_DOCK_ITEM_BEH_NEVER_HORIZONTAL: constant GTK2.GNOME_DOCK_ITEM_BEH_NEVER_HORIZONTAL

Constant GNOME_DOCK_ITEM_BEH_NEVER_VERTICAL: constant GTK2.GNOME_DOCK_ITEM_BEH_NEVER_VERTICAL

Constant GNOME_DOCK_ITEM_BEH_NORMAL: constant GTK2.GNOME_DOCK_ITEM_BEH_NORMAL

Constant GNOME_DOCK_LEFT: constant GTK2.GNOME_DOCK_LEFT

Constant GNOME_DOCK_RIGHT: constant GTK2.GNOME_DOCK_RIGHT

Constant GNOME_DOCK_TOP: constant GTK2.GNOME_DOCK_TOP

Constant GNOME_EDGE_FINISH: constant GTK2.GNOME_EDGE_FINISH

Constant GNOME_EDGE_LAST: constant GTK2.GNOME_EDGE_LAST

Constant GNOME_EDGE_OTHER: constant GTK2.GNOME_EDGE_OTHER

Constant GNOME_EDGE_START: constant GTK2.GNOME_EDGE_START

Constant GNOME_FONT_PICKER_MODE_FONT_INFO: constant GTK2.GNOME_FONT_PICKER_MODE_FONT_INFO

Constant GNOME_FONT_PICKER_MODE_PIXMAP: constant GTK2.GNOME_FONT_PICKER_MODE_PIXMAP

Constant GNOME_FONT_PICKER_MODE_UNKNOWN: constant GTK2.GNOME_FONT_PICKER_MODE_UNKNOWN

Constant GNOME_FONT_PICKER_MODE_USER_WIDGET: constant GTK2.GNOME_FONT_PICKER_MODE_USER_WIDGET

Constant GNOME_INTERACT_ANY: constant GTK2.GNOME_INTERACT_ANY

Constant GNOME_INTERACT_ERRORS: constant GTK2.GNOME_INTERACT_ERRORS

Constant GNOME_INTERACT_NONE: constant GTK2.GNOME_INTERACT_NONE

Constant GNOME_PREFERENCES_ALWAYS: constant GTK2.GNOME_PREFERENCES_ALWAYS

Constant GNOME_PREFERENCES_NEVER: constant GTK2.GNOME_PREFERENCES_NEVER

Constant GNOME_PREFERENCES_USER: constant GTK2.GNOME_PREFERENCES_USER

Constant GNOME_RESTART_ANYWAY: constant GTK2.GNOME_RESTART_ANYWAY

Constant GNOME_RESTART_IF_RUNNING: constant GTK2.GNOME_RESTART_IF_RUNNING

Constant GNOME_RESTART_IMMEDIATELY: constant GTK2.GNOME_RESTART_IMMEDIATELY

Constant GNOME_RESTART_NEVER: constant GTK2.GNOME_RESTART_NEVER

Constant GNOME_SAVE_BOTH: constant GTK2.GNOME_SAVE_BOTH

Constant GNOME_SAVE_GLOBAL: constant GTK2.GNOME_SAVE_GLOBAL

Constant GNOME_SAVE_LOCAL: constant GTK2.GNOME_SAVE_LOCAL

Constant GNOME_STOCK_BUTTON_APPLY: constant GTK2.GNOME_STOCK_BUTTON_APPLY

Constant GNOME_STOCK_BUTTON_CANCEL: constant GTK2.GNOME_STOCK_BUTTON_CANCEL

Constant GNOME_STOCK_BUTTON_CLOSE: constant GTK2.GNOME_STOCK_BUTTON_CLOSE

Constant GNOME_STOCK_BUTTON_DOWN: constant GTK2.GNOME_STOCK_BUTTON_DOWN

Constant GNOME_STOCK_BUTTON_FONT: constant GTK2.GNOME_STOCK_BUTTON_FONT

Constant GNOME_STOCK_BUTTON_HELP: constant GTK2.GNOME_STOCK_BUTTON_HELP

Constant GNOME_STOCK_BUTTON_NEXT: constant GTK2.GNOME_STOCK_BUTTON_NEXT

Constant GNOME_STOCK_BUTTON_NO: constant GTK2.GNOME_STOCK_BUTTON_NO

Constant GNOME_STOCK_BUTTON_OK: constant GTK2.GNOME_STOCK_BUTTON_OK

Constant GNOME_STOCK_BUTTON_PREV: constant GTK2.GNOME_STOCK_BUTTON_PREV

Constant GNOME_STOCK_BUTTON_UP: constant GTK2.GNOME_STOCK_BUTTON_UP

Constant GNOME_STOCK_BUTTON_YES: constant GTK2.GNOME_STOCK_BUTTON_YES

Constant GNOME_STOCK_MENU_ABOUT: constant GTK2.GNOME_STOCK_MENU_ABOUT

Constant GNOME_STOCK_MENU_ALIGN_CENTER: constant GTK2.GNOME_STOCK_MENU_ALIGN_CENTER

Constant GNOME_STOCK_MENU_ALIGN_JUSTIFY: constant GTK2.GNOME_STOCK_MENU_ALIGN_JUSTIFY

Constant GNOME_STOCK_MENU_ALIGN_LEFT: constant GTK2.GNOME_STOCK_MENU_ALIGN_LEFT

Constant GNOME_STOCK_MENU_ALIGN_RIGHT: constant GTK2.GNOME_STOCK_MENU_ALIGN_RIGHT

Constant GNOME_STOCK_MENU_ATTACH: constant GTK2.GNOME_STOCK_MENU_ATTACH

Constant GNOME_STOCK_MENU_BACK: constant GTK2.GNOME_STOCK_MENU_BACK

Constant GNOME_STOCK_MENU_BLANK: constant GTK2.GNOME_STOCK_MENU_BLANK

Constant GNOME_STOCK_MENU_BOOK_BLUE: constant GTK2.GNOME_STOCK_MENU_BOOK_BLUE

Constant GNOME_STOCK_MENU_BOOK_GREEN: constant GTK2.GNOME_STOCK_MENU_BOOK_GREEN

Constant GNOME_STOCK_MENU_BOOK_OPEN: constant GTK2.GNOME_STOCK_MENU_BOOK_OPEN

Constant GNOME_STOCK_MENU_BOOK_RED: constant GTK2.GNOME_STOCK_MENU_BOOK_RED

Constant GNOME_STOCK_MENU_BOOK_YELLOW: constant GTK2.GNOME_STOCK_MENU_BOOK_YELLOW

Constant GNOME_STOCK_MENU_BOTTOM: constant GTK2.GNOME_STOCK_MENU_BOTTOM

Constant GNOME_STOCK_MENU_CDROM: constant GTK2.GNOME_STOCK_MENU_CDROM

Constant GNOME_STOCK_MENU_CLOSE: constant GTK2.GNOME_STOCK_MENU_CLOSE

Constant GNOME_STOCK_MENU_CONVERT: constant GTK2.GNOME_STOCK_MENU_CONVERT

Constant GNOME_STOCK_MENU_COPY: constant GTK2.GNOME_STOCK_MENU_COPY

Constant GNOME_STOCK_MENU_CUT: constant GTK2.GNOME_STOCK_MENU_CUT

Constant GNOME_STOCK_MENU_DOWN: constant GTK2.GNOME_STOCK_MENU_DOWN

Constant GNOME_STOCK_MENU_EXEC: constant GTK2.GNOME_STOCK_MENU_EXEC

Constant GNOME_STOCK_MENU_EXIT: constant GTK2.GNOME_STOCK_MENU_EXIT

Constant GNOME_STOCK_MENU_FIRST: constant GTK2.GNOME_STOCK_MENU_FIRST

Constant GNOME_STOCK_MENU_FONT: constant GTK2.GNOME_STOCK_MENU_FONT

Constant GNOME_STOCK_MENU_FORWARD: constant GTK2.GNOME_STOCK_MENU_FORWARD

Constant GNOME_STOCK_MENU_HOME: constant GTK2.GNOME_STOCK_MENU_HOME

Constant GNOME_STOCK_MENU_INDEX: constant GTK2.GNOME_STOCK_MENU_INDEX

Constant GNOME_STOCK_MENU_JUMP_TO: constant GTK2.GNOME_STOCK_MENU_JUMP_TO

Constant GNOME_STOCK_MENU_LAST: constant GTK2.GNOME_STOCK_MENU_LAST

Constant GNOME_STOCK_MENU_LINE_IN: constant GTK2.GNOME_STOCK_MENU_LINE_IN

Constant GNOME_STOCK_MENU_MAIL: constant GTK2.GNOME_STOCK_MENU_MAIL

Constant GNOME_STOCK_MENU_MAIL_FWD: constant GTK2.GNOME_STOCK_MENU_MAIL_FWD

Constant GNOME_STOCK_MENU_MAIL_NEW: constant GTK2.GNOME_STOCK_MENU_MAIL_NEW

Constant GNOME_STOCK_MENU_MAIL_RCV: constant GTK2.GNOME_STOCK_MENU_MAIL_RCV

Constant GNOME_STOCK_MENU_MAIL_RPL: constant GTK2.GNOME_STOCK_MENU_MAIL_RPL

Constant GNOME_STOCK_MENU_MAIL_SND: constant GTK2.GNOME_STOCK_MENU_MAIL_SND

Constant GNOME_STOCK_MENU_MIC: constant GTK2.GNOME_STOCK_MENU_MIC

Constant GNOME_STOCK_MENU_MIDI: constant GTK2.GNOME_STOCK_MENU_MIDI

Constant GNOME_STOCK_MENU_NEW: constant GTK2.GNOME_STOCK_MENU_NEW

Constant GNOME_STOCK_MENU_OPEN: constant GTK2.GNOME_STOCK_MENU_OPEN

Constant GNOME_STOCK_MENU_PASTE: constant GTK2.GNOME_STOCK_MENU_PASTE

Constant GNOME_STOCK_MENU_PREF: constant GTK2.GNOME_STOCK_MENU_PREF

Constant GNOME_STOCK_MENU_PRINT: constant GTK2.GNOME_STOCK_MENU_PRINT

Constant GNOME_STOCK_MENU_PROP: constant GTK2.GNOME_STOCK_MENU_PROP

Constant GNOME_STOCK_MENU_QUIT: constant GTK2.GNOME_STOCK_MENU_QUIT

Constant GNOME_STOCK_MENU_REDO: constant GTK2.GNOME_STOCK_MENU_REDO

Constant GNOME_STOCK_MENU_REFRESH: constant GTK2.GNOME_STOCK_MENU_REFRESH

Constant GNOME_STOCK_MENU_REVERT: constant GTK2.GNOME_STOCK_MENU_REVERT

Constant GNOME_STOCK_MENU_SAVE: constant GTK2.GNOME_STOCK_MENU_SAVE

Constant GNOME_STOCK_MENU_SAVE_AS: constant GTK2.GNOME_STOCK_MENU_SAVE_AS

Constant GNOME_STOCK_MENU_SCORES: constant GTK2.GNOME_STOCK_MENU_SCORES

Constant GNOME_STOCK_MENU_SEARCH: constant GTK2.GNOME_STOCK_MENU_SEARCH

Constant GNOME_STOCK_MENU_SPELLCHECK: constant GTK2.GNOME_STOCK_MENU_SPELLCHECK

Constant GNOME_STOCK_MENU_SRCHRPL: constant GTK2.GNOME_STOCK_MENU_SRCHRPL

Constant GNOME_STOCK_MENU_STOP: constant GTK2.GNOME_STOCK_MENU_STOP

Constant GNOME_STOCK_MENU_TEXT_BOLD: constant GTK2.GNOME_STOCK_MENU_TEXT_BOLD

Constant GNOME_STOCK_MENU_TEXT_ITALIC: constant GTK2.GNOME_STOCK_MENU_TEXT_ITALIC

Constant GNOME_STOCK_MENU_TEXT_STRIKEOUT: constant GTK2.GNOME_STOCK_MENU_TEXT_STRIKEOUT

Constant GNOME_STOCK_MENU_TEXT_UNDERLINE: constant GTK2.GNOME_STOCK_MENU_TEXT_UNDERLINE

Constant GNOME_STOCK_MENU_TIMER: constant GTK2.GNOME_STOCK_MENU_TIMER

Constant GNOME_STOCK_MENU_TIMER_STOP: constant GTK2.GNOME_STOCK_MENU_TIMER_STOP

Constant GNOME_STOCK_MENU_TOP: constant GTK2.GNOME_STOCK_MENU_TOP

Constant GNOME_STOCK_MENU_TRASH: constant GTK2.GNOME_STOCK_MENU_TRASH

Constant GNOME_STOCK_MENU_TRASH_FULL: constant GTK2.GNOME_STOCK_MENU_TRASH_FULL

Constant GNOME_STOCK_MENU_UNDELETE: constant GTK2.GNOME_STOCK_MENU_UNDELETE

Constant GNOME_STOCK_MENU_UNDO: constant GTK2.GNOME_STOCK_MENU_UNDO

Constant GNOME_STOCK_MENU_UP: constant GTK2.GNOME_STOCK_MENU_UP

Constant GNOME_STOCK_MENU_VOLUME: constant GTK2.GNOME_STOCK_MENU_VOLUME

Constant GNOME_STOCK_PIXMAP_ABOUT: constant GTK2.GNOME_STOCK_PIXMAP_ABOUT

Constant GNOME_STOCK_PIXMAP_ADD: constant GTK2.GNOME_STOCK_PIXMAP_ADD

Constant GNOME_STOCK_PIXMAP_ALIGN_CENTER: constant GTK2.GNOME_STOCK_PIXMAP_ALIGN_CENTER

Constant GNOME_STOCK_PIXMAP_ALIGN_JUSTIFY: constant GTK2.GNOME_STOCK_PIXMAP_ALIGN_JUSTIFY

Constant GNOME_STOCK_PIXMAP_ALIGN_LEFT: constant GTK2.GNOME_STOCK_PIXMAP_ALIGN_LEFT

Constant GNOME_STOCK_PIXMAP_ALIGN_RIGHT: constant GTK2.GNOME_STOCK_PIXMAP_ALIGN_RIGHT

Constant GNOME_STOCK_PIXMAP_ATTACH: constant GTK2.GNOME_STOCK_PIXMAP_ATTACH

Constant GNOME_STOCK_PIXMAP_BACK: constant GTK2.GNOME_STOCK_PIXMAP_BACK

Constant GNOME_STOCK_PIXMAP_BOOK_BLUE: constant GTK2.GNOME_STOCK_PIXMAP_BOOK_BLUE

Constant GNOME_STOCK_PIXMAP_BOOK_GREEN: constant GTK2.GNOME_STOCK_PIXMAP_BOOK_GREEN

Constant GNOME_STOCK_PIXMAP_BOOK_OPEN: constant GTK2.GNOME_STOCK_PIXMAP_BOOK_OPEN

Constant GNOME_STOCK_PIXMAP_BOOK_RED: constant GTK2.GNOME_STOCK_PIXMAP_BOOK_RED

Constant GNOME_STOCK_PIXMAP_BOOK_YELLOW: constant GTK2.GNOME_STOCK_PIXMAP_BOOK_YELLOW

Constant GNOME_STOCK_PIXMAP_BOTTOM: constant GTK2.GNOME_STOCK_PIXMAP_BOTTOM

Constant GNOME_STOCK_PIXMAP_CDROM: constant GTK2.GNOME_STOCK_PIXMAP_CDROM

Constant GNOME_STOCK_PIXMAP_CLEAR: constant GTK2.GNOME_STOCK_PIXMAP_CLEAR

Constant GNOME_STOCK_PIXMAP_CLOSE: constant GTK2.GNOME_STOCK_PIXMAP_CLOSE

Constant GNOME_STOCK_PIXMAP_COLORSELECTOR: constant GTK2.GNOME_STOCK_PIXMAP_COLORSELECTOR

Constant GNOME_STOCK_PIXMAP_CONVERT: constant GTK2.GNOME_STOCK_PIXMAP_CONVERT

Constant GNOME_STOCK_PIXMAP_COPY: constant GTK2.GNOME_STOCK_PIXMAP_COPY

Constant GNOME_STOCK_PIXMAP_CUT: constant GTK2.GNOME_STOCK_PIXMAP_CUT

Constant GNOME_STOCK_PIXMAP_DISABLED: constant GTK2.GNOME_STOCK_PIXMAP_DISABLED

Constant GNOME_STOCK_PIXMAP_DOWN: constant GTK2.GNOME_STOCK_PIXMAP_DOWN

Constant GNOME_STOCK_PIXMAP_EXEC: constant GTK2.GNOME_STOCK_PIXMAP_EXEC

Constant GNOME_STOCK_PIXMAP_EXIT: constant GTK2.GNOME_STOCK_PIXMAP_EXIT

Constant GNOME_STOCK_PIXMAP_FIRST: constant GTK2.GNOME_STOCK_PIXMAP_FIRST

Constant GNOME_STOCK_PIXMAP_FOCUSED: constant GTK2.GNOME_STOCK_PIXMAP_FOCUSED

Constant GNOME_STOCK_PIXMAP_FONT: constant GTK2.GNOME_STOCK_PIXMAP_FONT

Constant GNOME_STOCK_PIXMAP_FORWARD: constant GTK2.GNOME_STOCK_PIXMAP_FORWARD

Constant GNOME_STOCK_PIXMAP_HELP: constant GTK2.GNOME_STOCK_PIXMAP_HELP

Constant GNOME_STOCK_PIXMAP_HOME: constant GTK2.GNOME_STOCK_PIXMAP_HOME

Constant GNOME_STOCK_PIXMAP_INDEX: constant GTK2.GNOME_STOCK_PIXMAP_INDEX

Constant GNOME_STOCK_PIXMAP_JUMP_TO: constant GTK2.GNOME_STOCK_PIXMAP_JUMP_TO

Constant GNOME_STOCK_PIXMAP_LAST: constant GTK2.GNOME_STOCK_PIXMAP_LAST

Constant GNOME_STOCK_PIXMAP_LINE_IN: constant GTK2.GNOME_STOCK_PIXMAP_LINE_IN

Constant GNOME_STOCK_PIXMAP_MAIL: constant GTK2.GNOME_STOCK_PIXMAP_MAIL

Constant GNOME_STOCK_PIXMAP_MAIL_FWD: constant GTK2.GNOME_STOCK_PIXMAP_MAIL_FWD

Constant GNOME_STOCK_PIXMAP_MAIL_NEW: constant GTK2.GNOME_STOCK_PIXMAP_MAIL_NEW

Constant GNOME_STOCK_PIXMAP_MAIL_RCV: constant GTK2.GNOME_STOCK_PIXMAP_MAIL_RCV

Constant GNOME_STOCK_PIXMAP_MAIL_RPL: constant GTK2.GNOME_STOCK_PIXMAP_MAIL_RPL

Constant GNOME_STOCK_PIXMAP_MAIL_SND: constant GTK2.GNOME_STOCK_PIXMAP_MAIL_SND

Constant GNOME_STOCK_PIXMAP_MIC: constant GTK2.GNOME_STOCK_PIXMAP_MIC

Constant GNOME_STOCK_PIXMAP_MIDI: constant GTK2.GNOME_STOCK_PIXMAP_MIDI

Constant GNOME_STOCK_PIXMAP_MULTIPLE: constant GTK2.GNOME_STOCK_PIXMAP_MULTIPLE

Constant GNOME_STOCK_PIXMAP_NEW: constant GTK2.GNOME_STOCK_PIXMAP_NEW

Constant GNOME_STOCK_PIXMAP_NOT: constant GTK2.GNOME_STOCK_PIXMAP_NOT

Constant GNOME_STOCK_PIXMAP_OPEN: constant GTK2.GNOME_STOCK_PIXMAP_OPEN

Constant GNOME_STOCK_PIXMAP_PASTE: constant GTK2.GNOME_STOCK_PIXMAP_PASTE

Constant GNOME_STOCK_PIXMAP_PREFERENCES: constant GTK2.GNOME_STOCK_PIXMAP_PREFERENCES

Constant GNOME_STOCK_PIXMAP_PRINT: constant GTK2.GNOME_STOCK_PIXMAP_PRINT

Constant GNOME_STOCK_PIXMAP_PROPERTIES: constant GTK2.GNOME_STOCK_PIXMAP_PROPERTIES

Constant GNOME_STOCK_PIXMAP_QUIT: constant GTK2.GNOME_STOCK_PIXMAP_QUIT

Constant GNOME_STOCK_PIXMAP_REDO: constant GTK2.GNOME_STOCK_PIXMAP_REDO

Constant GNOME_STOCK_PIXMAP_REFRESH: constant GTK2.GNOME_STOCK_PIXMAP_REFRESH

Constant GNOME_STOCK_PIXMAP_REGULAR: constant GTK2.GNOME_STOCK_PIXMAP_REGULAR

Constant GNOME_STOCK_PIXMAP_REMOVE: constant GTK2.GNOME_STOCK_PIXMAP_REMOVE

Constant GNOME_STOCK_PIXMAP_REVERT: constant GTK2.GNOME_STOCK_PIXMAP_REVERT

Constant GNOME_STOCK_PIXMAP_SAVE: constant GTK2.GNOME_STOCK_PIXMAP_SAVE

Constant GNOME_STOCK_PIXMAP_SAVE_AS: constant GTK2.GNOME_STOCK_PIXMAP_SAVE_AS

Constant GNOME_STOCK_PIXMAP_SCORES: constant GTK2.GNOME_STOCK_PIXMAP_SCORES

Constant GNOME_STOCK_PIXMAP_SEARCH: constant GTK2.GNOME_STOCK_PIXMAP_SEARCH

Constant GNOME_STOCK_PIXMAP_SPELLCHECK: constant GTK2.GNOME_STOCK_PIXMAP_SPELLCHECK

Constant GNOME_STOCK_PIXMAP_SRCHRPL: constant GTK2.GNOME_STOCK_PIXMAP_SRCHRPL

Constant GNOME_STOCK_PIXMAP_STOP: constant GTK2.GNOME_STOCK_PIXMAP_STOP

Constant GNOME_STOCK_PIXMAP_TABLE_BORDERS: constant GTK2.GNOME_STOCK_PIXMAP_TABLE_BORDERS

Constant GNOME_STOCK_PIXMAP_TABLE_FILL: constant GTK2.GNOME_STOCK_PIXMAP_TABLE_FILL

Constant GNOME_STOCK_PIXMAP_TEXT_BOLD: constant GTK2.GNOME_STOCK_PIXMAP_TEXT_BOLD

Constant GNOME_STOCK_PIXMAP_TEXT_BULLETED_LIST: constant GTK2.GNOME_STOCK_PIXMAP_TEXT_BULLETED_LIST

Constant GNOME_STOCK_PIXMAP_TEXT_INDENT: constant GTK2.GNOME_STOCK_PIXMAP_TEXT_INDENT

Constant GNOME_STOCK_PIXMAP_TEXT_ITALIC: constant GTK2.GNOME_STOCK_PIXMAP_TEXT_ITALIC

Constant GNOME_STOCK_PIXMAP_TEXT_NUMBERED_LIST: constant GTK2.GNOME_STOCK_PIXMAP_TEXT_NUMBERED_LIST

Constant GNOME_STOCK_PIXMAP_TEXT_STRIKEOUT: constant GTK2.GNOME_STOCK_PIXMAP_TEXT_STRIKEOUT

Constant GNOME_STOCK_PIXMAP_TEXT_UNDERLINE: constant GTK2.GNOME_STOCK_PIXMAP_TEXT_UNDERLINE

Constant GNOME_STOCK_PIXMAP_TEXT_UNINDENT: constant GTK2.GNOME_STOCK_PIXMAP_TEXT_UNINDENT

Constant GNOME_STOCK_PIXMAP_TIMER: constant GTK2.GNOME_STOCK_PIXMAP_TIMER

Constant GNOME_STOCK_PIXMAP_TIMER_STOP: constant GTK2.GNOME_STOCK_PIXMAP_TIMER_STOP

Constant GNOME_STOCK_PIXMAP_TOP: constant GTK2.GNOME_STOCK_PIXMAP_TOP

Constant GNOME_STOCK_PIXMAP_TRASH: constant GTK2.GNOME_STOCK_PIXMAP_TRASH

Constant GNOME_STOCK_PIXMAP_TRASH_FULL: constant GTK2.GNOME_STOCK_PIXMAP_TRASH_FULL

Constant GNOME_STOCK_PIXMAP_TYPE_DATA: constant GTK2.GNOME_STOCK_PIXMAP_TYPE_DATA

Constant GNOME_STOCK_PIXMAP_TYPE_FILE: constant GTK2.GNOME_STOCK_PIXMAP_TYPE_FILE

Constant GNOME_STOCK_PIXMAP_TYPE_GPIXMAP: constant GTK2.GNOME_STOCK_PIXMAP_TYPE_GPIXMAP

Constant GNOME_STOCK_PIXMAP_TYPE_IMLIB: constant GTK2.GNOME_STOCK_PIXMAP_TYPE_IMLIB

Constant GNOME_STOCK_PIXMAP_TYPE_IMLIB_SCALED: constant GTK2.GNOME_STOCK_PIXMAP_TYPE_IMLIB_SCALED

Constant GNOME_STOCK_PIXMAP_TYPE_NONE: constant GTK2.GNOME_STOCK_PIXMAP_TYPE_NONE

Constant GNOME_STOCK_PIXMAP_TYPE_PATH: constant GTK2.GNOME_STOCK_PIXMAP_TYPE_PATH

Constant GNOME_STOCK_PIXMAP_TYPE_WIDGET: constant GTK2.GNOME_STOCK_PIXMAP_TYPE_WIDGET

Constant GNOME_STOCK_PIXMAP_UNDELETE: constant GTK2.GNOME_STOCK_PIXMAP_UNDELETE

Constant GNOME_STOCK_PIXMAP_UNDO: constant GTK2.GNOME_STOCK_PIXMAP_UNDO

Constant GNOME_STOCK_PIXMAP_UP: constant GTK2.GNOME_STOCK_PIXMAP_UP

Constant GNOME_STOCK_PIXMAP_VOLUME: constant GTK2.GNOME_STOCK_PIXMAP_VOLUME

Constant HAS_DEFAULT: constant GTK2.HAS_DEFAULT

Constant HAS_FOCUS: constant GTK2.HAS_FOCUS

Constant HAS_GRAB: constant GTK2.HAS_GRAB

Constant ICON_LOOKUP_FORCE_SVG: constant GTK2.ICON_LOOKUP_FORCE_SVG

Constant ICON_LOOKUP_NO_SVG: constant GTK2.ICON_LOOKUP_NO_SVG

Constant ICON_LOOKUP_USE_BUILTIN: constant GTK2.ICON_LOOKUP_USE_BUILTIN

Constant ICON_SIZE_BUTTON: constant GTK2.ICON_SIZE_BUTTON

Constant ICON_SIZE_DIALOG: constant GTK2.ICON_SIZE_DIALOG

Constant ICON_SIZE_DND: constant GTK2.ICON_SIZE_DND

Constant ICON_SIZE_INVALID: constant GTK2.ICON_SIZE_INVALID

Constant ICON_SIZE_LARGE_TOOLBAR: constant GTK2.ICON_SIZE_LARGE_TOOLBAR

Constant ICON_SIZE_MENU: constant GTK2.ICON_SIZE_MENU

Constant ICON_SIZE_SMALL_TOOLBAR: constant GTK2.ICON_SIZE_SMALL_TOOLBAR

Constant ICON_THEME_FAILED: constant GTK2.ICON_THEME_FAILED

Constant ICON_THEME_NOT_FOUND: constant GTK2.ICON_THEME_NOT_FOUND

Constant IMAGE_ANIMATION: constant GTK2.IMAGE_ANIMATION

Constant IMAGE_EMPTY: constant GTK2.IMAGE_EMPTY

Constant IMAGE_ICON_NAME: constant GTK2.IMAGE_ICON_NAME

Constant IMAGE_ICON_SET: constant GTK2.IMAGE_ICON_SET

Constant IMAGE_IMAGE: constant GTK2.IMAGE_IMAGE

Constant IMAGE_PIXBUF: constant GTK2.IMAGE_PIXBUF

Constant IMAGE_PIXMAP: constant GTK2.IMAGE_PIXMAP

Constant IMAGE_STOCK: constant GTK2.IMAGE_STOCK

Constant IM_PREEDIT_CALLBACK: constant GTK2.IM_PREEDIT_CALLBACK

Constant IM_PREEDIT_NONE: constant GTK2.IM_PREEDIT_NONE

Constant IM_PREEDIT_NOTHING: constant GTK2.IM_PREEDIT_NOTHING

Constant IM_STATUS_CALLBACK: constant GTK2.IM_STATUS_CALLBACK

Constant IM_STATUS_NONE: constant GTK2.IM_STATUS_NONE

Constant IM_STATUS_NOTHING: constant GTK2.IM_STATUS_NOTHING

Constant INCHES: constant GTK2.INCHES

Constant IN_DESTRUCTION: constant GTK2.IN_DESTRUCTION

Constant JUSTIFY_CENTER: constant GTK2.JUSTIFY_CENTER

Constant JUSTIFY_FILL: constant GTK2.JUSTIFY_FILL

Constant JUSTIFY_LEFT: constant GTK2.JUSTIFY_LEFT

Constant JUSTIFY_RIGHT: constant GTK2.JUSTIFY_RIGHT

Constant MAJOR_VERSION: constant GTK2.MAJOR_VERSION

Constant MAPPED: constant GTK2.MAPPED

Constant MENU_DIR_CHILD: constant GTK2.MENU_DIR_CHILD

Constant MENU_DIR_NEXT: constant GTK2.MENU_DIR_NEXT

Constant MENU_DIR_PARENT: constant GTK2.MENU_DIR_PARENT

Constant MENU_DIR_PREV: constant GTK2.MENU_DIR_PREV

Constant MESSAGE_ERROR: constant GTK2.MESSAGE_ERROR

Constant MESSAGE_INFO: constant GTK2.MESSAGE_INFO

Constant MESSAGE_QUESTION: constant GTK2.MESSAGE_QUESTION

Constant MESSAGE_WARNING: constant GTK2.MESSAGE_WARNING

Constant MICRO_VERSION: constant GTK2.MICRO_VERSION

Constant MINOR_VERSION: constant GTK2.MINOR_VERSION

Constant MOVEMENT_BUFFER_ENDS: constant GTK2.MOVEMENT_BUFFER_ENDS

Constant MOVEMENT_DISPLAY_LINES: constant GTK2.MOVEMENT_DISPLAY_LINES

Constant MOVEMENT_DISPLAY_LINE_ENDS: constant GTK2.MOVEMENT_DISPLAY_LINE_ENDS

Constant MOVEMENT_HORIZONTAL_PAGES: constant GTK2.MOVEMENT_HORIZONTAL_PAGES

Constant MOVEMENT_LOGICAL_POSITIONS: constant GTK2.MOVEMENT_LOGICAL_POSITIONS

Constant MOVEMENT_PAGES: constant GTK2.MOVEMENT_PAGES

Constant MOVEMENT_PARAGRAPHS: constant GTK2.MOVEMENT_PARAGRAPHS

Constant MOVEMENT_PARAGRAPH_ENDS: constant GTK2.MOVEMENT_PARAGRAPH_ENDS

Constant MOVEMENT_VISUAL_POSITIONS: constant GTK2.MOVEMENT_VISUAL_POSITIONS

Constant MOVEMENT_WORDS: constant GTK2.MOVEMENT_WORDS

Constant NO_REPARENT: constant GTK2.NO_REPARENT

Constant NO_SHOW_ALL: constant GTK2.NO_SHOW_ALL

Constant NO_WINDOW: constant GTK2.NO_WINDOW

Constant ORIENTATION_HORIZONTAL: constant GTK2.ORIENTATION_HORIZONTAL

Constant ORIENTATION_VERTICAL: constant GTK2.ORIENTATION_VERTICAL

Constant PACK_DIRECTION_BTT: constant GTK2.PACK_DIRECTION_BTT

Constant PACK_DIRECTION_LTR: constant GTK2.PACK_DIRECTION_LTR

Constant PACK_DIRECTION_RTL: constant GTK2.PACK_DIRECTION_RTL

Constant PACK_DIRECTION_TTB: constant GTK2.PACK_DIRECTION_TTB

Constant PACK_END: constant GTK2.PACK_END

Constant PACK_START: constant GTK2.PACK_START

Constant PAGE_ORIENTATION_LANDSCAPE: constant GTK2.PAGE_ORIENTATION_LANDSCAPE

Constant PAGE_ORIENTATION_PORTRAIT: constant GTK2.PAGE_ORIENTATION_PORTRAIT

Constant PAGE_ORIENTATION_REVERSE_LANDSCAPE: constant GTK2.PAGE_ORIENTATION_REVERSE_LANDSCAPE

Constant PAGE_ORIENTATION_REVERSE_PORTRAIT: constant GTK2.PAGE_ORIENTATION_REVERSE_PORTRAIT

Constant PAGE_SET_ALL: constant GTK2.PAGE_SET_ALL

Constant PAGE_SET_EVEN: constant GTK2.PAGE_SET_EVEN

Constant PAGE_SET_ODD: constant GTK2.PAGE_SET_ODD

Constant PANGO_ALIGN_CENTER: constant GTK2.PANGO_ALIGN_CENTER

Constant PANGO_ALIGN_LEFT: constant GTK2.PANGO_ALIGN_LEFT

Constant PANGO_ALIGN_RIGHT: constant GTK2.PANGO_ALIGN_RIGHT

Constant PANGO_ATTR_BACKGROUND: constant GTK2.PANGO_ATTR_BACKGROUND

Constant PANGO_ATTR_FALLBACK: constant GTK2.PANGO_ATTR_FALLBACK

Constant PANGO_ATTR_FAMILY: constant GTK2.PANGO_ATTR_FAMILY

Constant PANGO_ATTR_FONT_DESC: constant GTK2.PANGO_ATTR_FONT_DESC

Constant PANGO_ATTR_FOREGROUND: constant GTK2.PANGO_ATTR_FOREGROUND

Constant PANGO_ATTR_INVALID: constant GTK2.PANGO_ATTR_INVALID

Constant PANGO_ATTR_LANGUAGE: constant GTK2.PANGO_ATTR_LANGUAGE

Constant PANGO_ATTR_LETTER_SPACING: constant GTK2.PANGO_ATTR_LETTER_SPACING

Constant PANGO_ATTR_RISE: constant GTK2.PANGO_ATTR_RISE

Constant PANGO_ATTR_SCALE: constant GTK2.PANGO_ATTR_SCALE

Constant PANGO_ATTR_SHAPE: constant GTK2.PANGO_ATTR_SHAPE

Constant PANGO_ATTR_SIZE: constant GTK2.PANGO_ATTR_SIZE

Constant PANGO_ATTR_STRETCH: constant GTK2.PANGO_ATTR_STRETCH

Constant PANGO_ATTR_STRIKETHROUGH: constant GTK2.PANGO_ATTR_STRIKETHROUGH

Constant PANGO_ATTR_STYLE: constant GTK2.PANGO_ATTR_STYLE

Constant PANGO_ATTR_UNDERLINE: constant GTK2.PANGO_ATTR_UNDERLINE

Constant PANGO_ATTR_VARIANT: constant GTK2.PANGO_ATTR_VARIANT

Constant PANGO_ATTR_WEIGHT: constant GTK2.PANGO_ATTR_WEIGHT

Constant PANGO_ELLIPSIZE_END: constant GTK2.PANGO_ELLIPSIZE_END

Constant PANGO_ELLIPSIZE_MIDDLE: constant GTK2.PANGO_ELLIPSIZE_MIDDLE

Constant PANGO_ELLIPSIZE_NONE: constant GTK2.PANGO_ELLIPSIZE_NONE

Constant PANGO_ELLIPSIZE_START: constant GTK2.PANGO_ELLIPSIZE_START

Constant PANGO_FONT_MASK_FAMILY: constant GTK2.PANGO_FONT_MASK_FAMILY

Constant PANGO_FONT_MASK_SIZE: constant GTK2.PANGO_FONT_MASK_SIZE

Constant PANGO_FONT_MASK_STRETCH: constant GTK2.PANGO_FONT_MASK_STRETCH

Constant PANGO_FONT_MASK_STYLE: constant GTK2.PANGO_FONT_MASK_STYLE

Constant PANGO_FONT_MASK_VARIANT: constant GTK2.PANGO_FONT_MASK_VARIANT

Constant PANGO_FONT_MASK_WEIGHT: constant GTK2.PANGO_FONT_MASK_WEIGHT

Constant PANGO_SCALE: constant GTK2.PANGO_SCALE

Constant PANGO_SCALE_LARGE: constant GTK2.PANGO_SCALE_LARGE

Constant PANGO_SCALE_MEDIUM: constant GTK2.PANGO_SCALE_MEDIUM

Constant PANGO_SCALE_SMALL: constant GTK2.PANGO_SCALE_SMALL

Constant PANGO_SCALE_XX_LARGE: constant GTK2.PANGO_SCALE_XX_LARGE

Constant PANGO_SCALE_XX_SMALL: constant GTK2.PANGO_SCALE_XX_SMALL

Constant PANGO_SCALE_X_LARGE: constant GTK2.PANGO_SCALE_X_LARGE

Constant PANGO_SCALE_X_SMALL: constant GTK2.PANGO_SCALE_X_SMALL

Constant PANGO_STRETCH_CONDENSED: constant GTK2.PANGO_STRETCH_CONDENSED

Constant PANGO_STRETCH_EXPANDED: constant GTK2.PANGO_STRETCH_EXPANDED

Constant PANGO_STRETCH_EXTRA_CONDENSED: constant GTK2.PANGO_STRETCH_EXTRA_CONDENSED

Constant PANGO_STRETCH_EXTRA_EXPANDED: constant GTK2.PANGO_STRETCH_EXTRA_EXPANDED

Constant PANGO_STRETCH_NORMAL: constant GTK2.PANGO_STRETCH_NORMAL

Constant PANGO_STRETCH_SEMI_CONDENSED: constant GTK2.PANGO_STRETCH_SEMI_CONDENSED

Constant PANGO_STRETCH_SEMI_EXPANDED: constant GTK2.PANGO_STRETCH_SEMI_EXPANDED

Constant PANGO_STRETCH_ULTRA_CONDENSED: constant GTK2.PANGO_STRETCH_ULTRA_CONDENSED

Constant PANGO_STRETCH_ULTRA_EXPANDED: constant GTK2.PANGO_STRETCH_ULTRA_EXPANDED

Constant PANGO_STYLE_ITALIC: constant GTK2.PANGO_STYLE_ITALIC

Constant PANGO_STYLE_NORMAL: constant GTK2.PANGO_STYLE_NORMAL

Constant PANGO_STYLE_OBLIQUE: constant GTK2.PANGO_STYLE_OBLIQUE

Constant PANGO_TAB_LEFT: constant GTK2.PANGO_TAB_LEFT

Constant PANGO_UNDERLINE_DOUBLE: constant GTK2.PANGO_UNDERLINE_DOUBLE

Constant PANGO_UNDERLINE_ERROR: constant GTK2.PANGO_UNDERLINE_ERROR

Constant PANGO_UNDERLINE_LOW: constant GTK2.PANGO_UNDERLINE_LOW

Constant PANGO_UNDERLINE_NONE: constant GTK2.PANGO_UNDERLINE_NONE

Constant PANGO_UNDERLINE_SINGLE: constant GTK2.PANGO_UNDERLINE_SINGLE

Constant PANGO_VARIANT_NORMAL: constant GTK2.PANGO_VARIANT_NORMAL

Constant PANGO_VARIANT_SMALL_CAPS: constant GTK2.PANGO_VARIANT_SMALL_CAPS

Constant PANGO_WEIGHT_BOLD: constant GTK2.PANGO_WEIGHT_BOLD

Constant PANGO_WEIGHT_HEAVY: constant GTK2.PANGO_WEIGHT_HEAVY

Constant PANGO_WEIGHT_LIGHT: constant GTK2.PANGO_WEIGHT_LIGHT

Constant PANGO_WEIGHT_NORMAL: constant GTK2.PANGO_WEIGHT_NORMAL

Constant PANGO_WEIGHT_ULTRABOLD: constant GTK2.PANGO_WEIGHT_ULTRABOLD

Constant PANGO_WEIGHT_ULTRALIGHT: constant GTK2.PANGO_WEIGHT_ULTRALIGHT

Constant PANGO_WRAP_CHAR: constant GTK2.PANGO_WRAP_CHAR

Constant PANGO_WRAP_WORD: constant GTK2.PANGO_WRAP_WORD

Constant PANGO_WRAP_WORD_CHAR: constant GTK2.PANGO_WRAP_WORD_CHAR

Constant PARENT_SENSITIVE: constant GTK2.PARENT_SENSITIVE

Constant PATH_CLASS: constant GTK2.PATH_CLASS

Constant PATH_PRIO_APPLICATION: constant GTK2.PATH_PRIO_APPLICATION

Constant PATH_PRIO_GTK: constant GTK2.PATH_PRIO_GTK

Constant PATH_PRIO_HIGHEST: constant GTK2.PATH_PRIO_HIGHEST

Constant PATH_PRIO_LOWEST: constant GTK2.PATH_PRIO_LOWEST

Constant PATH_PRIO_RC: constant GTK2.PATH_PRIO_RC

Constant PATH_PRIO_THEME: constant GTK2.PATH_PRIO_THEME

Constant PATH_WIDGET: constant GTK2.PATH_WIDGET

Constant PATH_WIDGET_CLASS: constant GTK2.PATH_WIDGET_CLASS

Constant PIXELS: constant GTK2.PIXELS

Constant POLICY_ALWAYS: constant GTK2.POLICY_ALWAYS

Constant POLICY_AUTOMATIC: constant GTK2.POLICY_AUTOMATIC

Constant POLICY_NEVER: constant GTK2.POLICY_NEVER

Constant POS_BOTTOM: constant GTK2.POS_BOTTOM

Constant POS_LEFT: constant GTK2.POS_LEFT

Constant POS_RIGHT: constant GTK2.POS_RIGHT

Constant POS_TOP: constant GTK2.POS_TOP

Constant PRINT_DUPLEX_HORIZONTAL: constant GTK2.PRINT_DUPLEX_HORIZONTAL

Constant PRINT_DUPLEX_SIMPLEX: constant GTK2.PRINT_DUPLEX_SIMPLEX

Constant PRINT_DUPLEX_VERTICAL: constant GTK2.PRINT_DUPLEX_VERTICAL

Constant PRINT_ERROR_GENERAL: constant GTK2.PRINT_ERROR_GENERAL

Constant PRINT_ERROR_INTERNAL_ERROR: constant GTK2.PRINT_ERROR_INTERNAL_ERROR

Constant PRINT_ERROR_NOMEM: constant GTK2.PRINT_ERROR_NOMEM

Constant PRINT_OPERATION_ACTION_EXPORT: constant GTK2.PRINT_OPERATION_ACTION_EXPORT

Constant PRINT_OPERATION_ACTION_PREVIEW: constant GTK2.PRINT_OPERATION_ACTION_PREVIEW

Constant PRINT_OPERATION_ACTION_PRINT: constant GTK2.PRINT_OPERATION_ACTION_PRINT

Constant PRINT_OPERATION_ACTION_PRINT_DIALOG: constant GTK2.PRINT_OPERATION_ACTION_PRINT_DIALOG

Constant PRINT_OPERATION_RESULT_APPLY: constant GTK2.PRINT_OPERATION_RESULT_APPLY

Constant PRINT_OPERATION_RESULT_CANCEL: constant GTK2.PRINT_OPERATION_RESULT_CANCEL

Constant PRINT_OPERATION_RESULT_ERROR: constant GTK2.PRINT_OPERATION_RESULT_ERROR

Constant PRINT_OPERATION_RESULT_IN_PROGRESS: constant GTK2.PRINT_OPERATION_RESULT_IN_PROGRESS

Constant PRINT_PAGES_ALL: constant GTK2.PRINT_PAGES_ALL

Constant PRINT_PAGES_CURRENT: constant GTK2.PRINT_PAGES_CURRENT

Constant PRINT_PAGES_RANGES: constant GTK2.PRINT_PAGES_RANGES

Constant PRINT_QUALITY_DRAFT: constant GTK2.PRINT_QUALITY_DRAFT

Constant PRINT_QUALITY_HIGH: constant GTK2.PRINT_QUALITY_HIGH

Constant PRINT_QUALITY_LOW: constant GTK2.PRINT_QUALITY_LOW

Constant PRINT_QUALITY_NORMAL: constant GTK2.PRINT_QUALITY_NORMAL

Constant PRINT_SETTINGS_COLLATE: constant GTK2.PRINT_SETTINGS_COLLATE

Constant PRINT_SETTINGS_DEFAULT_SOURCE: constant GTK2.PRINT_SETTINGS_DEFAULT_SOURCE

Constant PRINT_SETTINGS_DITHER: constant GTK2.PRINT_SETTINGS_DITHER

Constant PRINT_SETTINGS_DUPLEX: constant GTK2.PRINT_SETTINGS_DUPLEX

Constant PRINT_SETTINGS_FINISHINGS: constant GTK2.PRINT_SETTINGS_FINISHINGS

Constant PRINT_SETTINGS_MEDIA_TYPE: constant GTK2.PRINT_SETTINGS_MEDIA_TYPE

Constant PRINT_SETTINGS_NUMBER_UP: constant GTK2.PRINT_SETTINGS_NUMBER_UP

Constant PRINT_SETTINGS_N_COPIES: constant GTK2.PRINT_SETTINGS_N_COPIES

Constant PRINT_SETTINGS_ORIENTATION: constant GTK2.PRINT_SETTINGS_ORIENTATION

Constant PRINT_SETTINGS_OUTPUT_BIN: constant GTK2.PRINT_SETTINGS_OUTPUT_BIN

Constant PRINT_SETTINGS_OUTPUT_FILE_FORMAT: constant GTK2.PRINT_SETTINGS_OUTPUT_FILE_FORMAT

Constant PRINT_SETTINGS_OUTPUT_URI: constant GTK2.PRINT_SETTINGS_OUTPUT_URI

Constant PRINT_SETTINGS_PAGE_RANGES: constant GTK2.PRINT_SETTINGS_PAGE_RANGES

Constant PRINT_SETTINGS_PAGE_SET: constant GTK2.PRINT_SETTINGS_PAGE_SET

Constant PRINT_SETTINGS_PAPER_FORMAT: constant GTK2.PRINT_SETTINGS_PAPER_FORMAT

Constant PRINT_SETTINGS_PAPER_HEIGHT: constant GTK2.PRINT_SETTINGS_PAPER_HEIGHT

Constant PRINT_SETTINGS_PAPER_WIDTH: constant GTK2.PRINT_SETTINGS_PAPER_WIDTH

Constant PRINT_SETTINGS_PRINT_PAGES: constant GTK2.PRINT_SETTINGS_PRINT_PAGES

Constant PRINT_SETTINGS_QUALITY: constant GTK2.PRINT_SETTINGS_QUALITY

Constant PRINT_SETTINGS_RESOLUTION: constant GTK2.PRINT_SETTINGS_RESOLUTION

Constant PRINT_SETTINGS_REVERSE: constant GTK2.PRINT_SETTINGS_REVERSE

Constant PRINT_SETTINGS_SCALE: constant GTK2.PRINT_SETTINGS_SCALE

Constant PRINT_SETTINGS_USE_COLOR: constant GTK2.PRINT_SETTINGS_USE_COLOR

Constant PRINT_SETTINGS_WIN32_DRIVER_EXTRA: constant GTK2.PRINT_SETTINGS_WIN32_DRIVER_EXTRA

Constant PRINT_SETTINGS_WIN32_DRIVER_VERSION: constant GTK2.PRINT_SETTINGS_WIN32_DRIVER_VERSION

Constant PRINT_STATUS_FINISHED: constant GTK2.PRINT_STATUS_FINISHED

Constant PRINT_STATUS_FINISHED_ABORTED: constant GTK2.PRINT_STATUS_FINISHED_ABORTED

Constant PRINT_STATUS_GENERATING_DATA: constant GTK2.PRINT_STATUS_GENERATING_DATA

Constant PRINT_STATUS_INITIAL: constant GTK2.PRINT_STATUS_INITIAL

Constant PRINT_STATUS_PENDING: constant GTK2.PRINT_STATUS_PENDING

Constant PRINT_STATUS_PENDING_ISSUE: constant GTK2.PRINT_STATUS_PENDING_ISSUE

Constant PRINT_STATUS_PREPARING: constant GTK2.PRINT_STATUS_PREPARING

Constant PRINT_STATUS_PRINTING: constant GTK2.PRINT_STATUS_PRINTING

Constant PRINT_STATUS_SENDING_DATA: constant GTK2.PRINT_STATUS_SENDING_DATA

Constant PROGRESS_BOTTOM_TO_TOP: constant GTK2.PROGRESS_BOTTOM_TO_TOP

Constant PROGRESS_CONTINUOUS: constant GTK2.PROGRESS_CONTINUOUS

Constant PROGRESS_DISCRETE: constant GTK2.PROGRESS_DISCRETE

Constant PROGRESS_LEFT_TO_RIGHT: constant GTK2.PROGRESS_LEFT_TO_RIGHT

Constant PROGRESS_RIGHT_TO_LEFT: constant GTK2.PROGRESS_RIGHT_TO_LEFT

Constant PROGRESS_TOP_TO_BOTTOM: constant GTK2.PROGRESS_TOP_TO_BOTTOM

Constant RC_BASE: constant GTK2.RC_BASE

Constant RC_BG: constant GTK2.RC_BG

Constant RC_FG: constant GTK2.RC_FG

Constant RC_STYLE: constant GTK2.RC_STYLE

Constant RC_TEXT: constant GTK2.RC_TEXT

Constant RC_TOKEN_ACTIVE: constant GTK2.RC_TOKEN_ACTIVE

Constant RC_TOKEN_APPLICATION: constant GTK2.RC_TOKEN_APPLICATION

Constant RC_TOKEN_BASE: constant GTK2.RC_TOKEN_BASE

Constant RC_TOKEN_BG: constant GTK2.RC_TOKEN_BG

Constant RC_TOKEN_BG_PIXMAP: constant GTK2.RC_TOKEN_BG_PIXMAP

Constant RC_TOKEN_BIND: constant GTK2.RC_TOKEN_BIND

Constant RC_TOKEN_BINDING: constant GTK2.RC_TOKEN_BINDING

Constant RC_TOKEN_CLASS: constant GTK2.RC_TOKEN_CLASS

Constant RC_TOKEN_ENGINE: constant GTK2.RC_TOKEN_ENGINE

Constant RC_TOKEN_FG: constant GTK2.RC_TOKEN_FG

Constant RC_TOKEN_FONT: constant GTK2.RC_TOKEN_FONT

Constant RC_TOKEN_FONTSET: constant GTK2.RC_TOKEN_FONTSET

Constant RC_TOKEN_FONT_NAME: constant GTK2.RC_TOKEN_FONT_NAME

Constant RC_TOKEN_GTK: constant GTK2.RC_TOKEN_GTK

Constant RC_TOKEN_HIGHEST: constant GTK2.RC_TOKEN_HIGHEST

Constant RC_TOKEN_IM_MODULE_FILE: constant GTK2.RC_TOKEN_IM_MODULE_FILE

Constant RC_TOKEN_IM_MODULE_PATH: constant GTK2.RC_TOKEN_IM_MODULE_PATH

Constant RC_TOKEN_INCLUDE: constant GTK2.RC_TOKEN_INCLUDE

Constant RC_TOKEN_INSENSITIVE: constant GTK2.RC_TOKEN_INSENSITIVE

Constant RC_TOKEN_INVALID: constant GTK2.RC_TOKEN_INVALID

Constant RC_TOKEN_LAST: constant GTK2.RC_TOKEN_LAST

Constant RC_TOKEN_LOWEST: constant GTK2.RC_TOKEN_LOWEST

Constant RC_TOKEN_LTR: constant GTK2.RC_TOKEN_LTR

Constant RC_TOKEN_MODULE_PATH: constant GTK2.RC_TOKEN_MODULE_PATH

Constant RC_TOKEN_NORMAL: constant GTK2.RC_TOKEN_NORMAL

Constant RC_TOKEN_PIXMAP_PATH: constant GTK2.RC_TOKEN_PIXMAP_PATH

Constant RC_TOKEN_PRELIGHT: constant GTK2.RC_TOKEN_PRELIGHT

Constant RC_TOKEN_RC: constant GTK2.RC_TOKEN_RC

Constant RC_TOKEN_RTL: constant GTK2.RC_TOKEN_RTL

Constant RC_TOKEN_SELECTED: constant GTK2.RC_TOKEN_SELECTED

Constant RC_TOKEN_STOCK: constant GTK2.RC_TOKEN_STOCK

Constant RC_TOKEN_STYLE: constant GTK2.RC_TOKEN_STYLE

Constant RC_TOKEN_TEXT: constant GTK2.RC_TOKEN_TEXT

Constant RC_TOKEN_THEME: constant GTK2.RC_TOKEN_THEME

Constant RC_TOKEN_WIDGET: constant GTK2.RC_TOKEN_WIDGET

Constant RC_TOKEN_WIDGET_CLASS: constant GTK2.RC_TOKEN_WIDGET_CLASS

Constant RC_TOKEN_XTHICKNESS: constant GTK2.RC_TOKEN_XTHICKNESS

Constant RC_TOKEN_YTHICKNESS: constant GTK2.RC_TOKEN_YTHICKNESS

Constant REALIZED: constant GTK2.REALIZED

Constant RECEIVES_DEFAULT: constant GTK2.RECEIVES_DEFAULT

Constant RECENT_CHOOSER_ERROR_INVALID_URI: constant GTK2.RECENT_CHOOSER_ERROR_INVALID_URI

Constant RECENT_CHOOSER_ERROR_NOT_FOUND: constant GTK2.RECENT_CHOOSER_ERROR_NOT_FOUND

Constant RECENT_FILTER_AGE: constant GTK2.RECENT_FILTER_AGE

Constant RECENT_FILTER_APPLICATION: constant GTK2.RECENT_FILTER_APPLICATION

Constant RECENT_FILTER_DISPLAY_NAME: constant GTK2.RECENT_FILTER_DISPLAY_NAME

Constant RECENT_FILTER_GROUP: constant GTK2.RECENT_FILTER_GROUP

Constant RECENT_FILTER_MIME_TYPE: constant GTK2.RECENT_FILTER_MIME_TYPE

Constant RECENT_FILTER_URI: constant GTK2.RECENT_FILTER_URI

Constant RECENT_MANAGER_ERROR_INVALID_ENCODING: constant GTK2.RECENT_MANAGER_ERROR_INVALID_ENCODING

Constant RECENT_MANAGER_ERROR_INVALID_URI: constant GTK2.RECENT_MANAGER_ERROR_INVALID_URI

Constant RECENT_MANAGER_ERROR_NOT_FOUND: constant GTK2.RECENT_MANAGER_ERROR_NOT_FOUND

Constant RECENT_MANAGER_ERROR_NOT_REGISTERED: constant GTK2.RECENT_MANAGER_ERROR_NOT_REGISTERED

Constant RECENT_MANAGER_ERROR_READ: constant GTK2.RECENT_MANAGER_ERROR_READ

Constant RECENT_MANAGER_ERROR_UNKNOWN: constant GTK2.RECENT_MANAGER_ERROR_UNKNOWN

Constant RECENT_MANAGER_ERROR_WRITE: constant GTK2.RECENT_MANAGER_ERROR_WRITE

Constant RECENT_SORT_CUSTOM: constant GTK2.RECENT_SORT_CUSTOM

Constant RECENT_SORT_LRU: constant GTK2.RECENT_SORT_LRU

Constant RECENT_SORT_MRU: constant GTK2.RECENT_SORT_MRU

Constant RECENT_SORT_NONE: constant GTK2.RECENT_SORT_NONE

Constant RELIEF_HALF: constant GTK2.RELIEF_HALF

Constant RELIEF_NONE: constant GTK2.RELIEF_NONE

Constant RELIEF_NORMAL: constant GTK2.RELIEF_NORMAL

Constant RESERVED_1: constant GTK2.RESERVED_1

Constant RESERVED_2: constant GTK2.RESERVED_2

Constant RESIZE_IMMEDIATE: constant GTK2.RESIZE_IMMEDIATE

Constant RESIZE_PARENT: constant GTK2.RESIZE_PARENT

Constant RESIZE_QUEUE: constant GTK2.RESIZE_QUEUE

Constant RESPONSE_ACCEPT: constant GTK2.RESPONSE_ACCEPT

Constant RESPONSE_APPLY: constant GTK2.RESPONSE_APPLY

Constant RESPONSE_CANCEL: constant GTK2.RESPONSE_CANCEL

Constant RESPONSE_CLOSE: constant GTK2.RESPONSE_CLOSE

Constant RESPONSE_DELETE_EVENT: constant GTK2.RESPONSE_DELETE_EVENT

Constant RESPONSE_HELP: constant GTK2.RESPONSE_HELP

Constant RESPONSE_NO: constant GTK2.RESPONSE_NO

Constant RESPONSE_NONE: constant GTK2.RESPONSE_NONE

Constant RESPONSE_OK: constant GTK2.RESPONSE_OK

Constant RESPONSE_REJECT: constant GTK2.RESPONSE_REJECT

Constant RESPONSE_YES: constant GTK2.RESPONSE_YES

Constant SCROLL_END: constant GTK2.SCROLL_END

Constant SCROLL_ENDS: constant GTK2.SCROLL_ENDS

Constant SCROLL_HORIZONTAL_ENDS: constant GTK2.SCROLL_HORIZONTAL_ENDS

Constant SCROLL_HORIZONTAL_PAGES: constant GTK2.SCROLL_HORIZONTAL_PAGES

Constant SCROLL_HORIZONTAL_STEPS: constant GTK2.SCROLL_HORIZONTAL_STEPS

Constant SCROLL_JUMP: constant GTK2.SCROLL_JUMP

Constant SCROLL_NONE: constant GTK2.SCROLL_NONE

Constant SCROLL_PAGES: constant GTK2.SCROLL_PAGES

Constant SCROLL_PAGE_BACKWARD: constant GTK2.SCROLL_PAGE_BACKWARD

Constant SCROLL_PAGE_DOWN: constant GTK2.SCROLL_PAGE_DOWN

Constant SCROLL_PAGE_FORWARD: constant GTK2.SCROLL_PAGE_FORWARD

Constant SCROLL_PAGE_LEFT: constant GTK2.SCROLL_PAGE_LEFT

Constant SCROLL_PAGE_RIGHT: constant GTK2.SCROLL_PAGE_RIGHT

Constant SCROLL_PAGE_UP: constant GTK2.SCROLL_PAGE_UP

Constant SCROLL_START: constant GTK2.SCROLL_START

Constant SCROLL_STEPS: constant GTK2.SCROLL_STEPS

Constant SCROLL_STEP_BACKWARD: constant GTK2.SCROLL_STEP_BACKWARD

Constant SCROLL_STEP_DOWN: constant GTK2.SCROLL_STEP_DOWN

Constant SCROLL_STEP_FORWARD: constant GTK2.SCROLL_STEP_FORWARD

Constant SCROLL_STEP_LEFT: constant GTK2.SCROLL_STEP_LEFT

Constant SCROLL_STEP_RIGHT: constant GTK2.SCROLL_STEP_RIGHT

Constant SCROLL_STEP_UP: constant GTK2.SCROLL_STEP_UP

Constant SELECTION_BROWSE: constant GTK2.SELECTION_BROWSE

Constant SELECTION_MULTIPLE: constant GTK2.SELECTION_MULTIPLE

Constant SELECTION_NONE: constant GTK2.SELECTION_NONE

Constant SELECTION_SINGLE: constant GTK2.SELECTION_SINGLE

Constant SENSITIVE: constant GTK2.SENSITIVE

Constant SENSITIVITY_AUTO: constant GTK2.SENSITIVITY_AUTO

Constant SENSITIVITY_OFF: constant GTK2.SENSITIVITY_OFF

Constant SENSITIVITY_ON: constant GTK2.SENSITIVITY_ON

Constant SHADOW_ETCHED_IN: constant GTK2.SHADOW_ETCHED_IN

Constant SHADOW_ETCHED_OUT: constant GTK2.SHADOW_ETCHED_OUT

Constant SHADOW_IN: constant GTK2.SHADOW_IN

Constant SHADOW_NONE: constant GTK2.SHADOW_NONE

Constant SHADOW_OUT: constant GTK2.SHADOW_OUT

Constant SHRINK: constant GTK2.SHRINK

Constant SIZE_GROUP_BOTH: constant GTK2.SIZE_GROUP_BOTH

Constant SIZE_GROUP_HORIZONTAL: constant GTK2.SIZE_GROUP_HORIZONTAL

Constant SIZE_GROUP_NONE: constant GTK2.SIZE_GROUP_NONE

Constant SIZE_GROUP_VERTICAL: constant GTK2.SIZE_GROUP_VERTICAL

Constant SORT_ASCENDING: constant GTK2.SORT_ASCENDING

Constant SORT_DESCENDING: constant GTK2.SORT_DESCENDING

Constant SOURCE_SEARCH_CASE_INSENSITIVE: constant GTK2.SOURCE_SEARCH_CASE_INSENSITIVE

Constant SOURCE_SEARCH_TEXT_ONLY: constant GTK2.SOURCE_SEARCH_TEXT_ONLY

Constant SOURCE_SEARCH_VISIBLE_ONLY: constant GTK2.SOURCE_SEARCH_VISIBLE_ONLY

Constant SPIN_END: constant GTK2.SPIN_END

Constant SPIN_HOME: constant GTK2.SPIN_HOME

Constant SPIN_PAGE_BACKWARD: constant GTK2.SPIN_PAGE_BACKWARD

Constant SPIN_PAGE_FORWARD: constant GTK2.SPIN_PAGE_FORWARD

Constant SPIN_STEP_BACKWARD: constant GTK2.SPIN_STEP_BACKWARD

Constant SPIN_STEP_FORWARD: constant GTK2.SPIN_STEP_FORWARD

Constant SPIN_USER_DEFINED: constant GTK2.SPIN_USER_DEFINED

Constant STATE_ACTIVE: constant GTK2.STATE_ACTIVE

Constant STATE_INSENSITIVE: constant GTK2.STATE_INSENSITIVE

Constant STATE_NORMAL: constant GTK2.STATE_NORMAL

Constant STATE_PRELIGHT: constant GTK2.STATE_PRELIGHT

Constant STATE_SELECTED: constant GTK2.STATE_SELECTED

Constant STOCK_ABOUT: constant GTK2.STOCK_ABOUT

Constant STOCK_ADD: constant GTK2.STOCK_ADD

Constant STOCK_APPLY: constant GTK2.STOCK_APPLY

Constant STOCK_BOLD: constant GTK2.STOCK_BOLD

Constant STOCK_CANCEL: constant GTK2.STOCK_CANCEL

Constant STOCK_CDROM: constant GTK2.STOCK_CDROM

Constant STOCK_CLEAR: constant GTK2.STOCK_CLEAR

Constant STOCK_CLOSE: constant GTK2.STOCK_CLOSE

Constant STOCK_COLOR_PICKER: constant GTK2.STOCK_COLOR_PICKER

Constant STOCK_CONNECT: constant GTK2.STOCK_CONNECT

Constant STOCK_CONVERT: constant GTK2.STOCK_CONVERT

Constant STOCK_COPY: constant GTK2.STOCK_COPY

Constant STOCK_CUT: constant GTK2.STOCK_CUT

Constant STOCK_DELETE: constant GTK2.STOCK_DELETE

Constant STOCK_DIALOG_AUTHENTICATION: constant GTK2.STOCK_DIALOG_AUTHENTICATION

Constant STOCK_DIALOG_ERROR: constant GTK2.STOCK_DIALOG_ERROR

Constant STOCK_DIALOG_INFO: constant GTK2.STOCK_DIALOG_INFO

Constant STOCK_DIALOG_QUESTION: constant GTK2.STOCK_DIALOG_QUESTION

Constant STOCK_DIALOG_WARNING: constant GTK2.STOCK_DIALOG_WARNING

Constant STOCK_DIRECTORY: constant GTK2.STOCK_DIRECTORY

Constant STOCK_DISCONNECT: constant GTK2.STOCK_DISCONNECT

Constant STOCK_DND: constant GTK2.STOCK_DND

Constant STOCK_DND_MULTIPLE: constant GTK2.STOCK_DND_MULTIPLE

Constant STOCK_EDIT: constant GTK2.STOCK_EDIT

Constant STOCK_EXECUTE: constant GTK2.STOCK_EXECUTE

Constant STOCK_FILE: constant GTK2.STOCK_FILE

Constant STOCK_FIND: constant GTK2.STOCK_FIND

Constant STOCK_FIND_AND_REPLACE: constant GTK2.STOCK_FIND_AND_REPLACE

Constant STOCK_FLOPPY: constant GTK2.STOCK_FLOPPY

Constant STOCK_FULLSCREEN: constant GTK2.STOCK_FULLSCREEN

Constant STOCK_GOTO_BOTTOM: constant GTK2.STOCK_GOTO_BOTTOM

Constant STOCK_GOTO_FIRST: constant GTK2.STOCK_GOTO_FIRST

Constant STOCK_GOTO_LAST: constant GTK2.STOCK_GOTO_LAST

Constant STOCK_GOTO_TOP: constant GTK2.STOCK_GOTO_TOP

Constant STOCK_GO_BACK: constant GTK2.STOCK_GO_BACK

Constant STOCK_GO_DOWN: constant GTK2.STOCK_GO_DOWN

Constant STOCK_GO_FORWARD: constant GTK2.STOCK_GO_FORWARD

Constant STOCK_GO_UP: constant GTK2.STOCK_GO_UP

Constant STOCK_HARDDISK: constant GTK2.STOCK_HARDDISK

Constant STOCK_HELP: constant GTK2.STOCK_HELP

Constant STOCK_HOME: constant GTK2.STOCK_HOME

Constant STOCK_INDENT: constant GTK2.STOCK_INDENT

Constant STOCK_INDEX: constant GTK2.STOCK_INDEX

Constant STOCK_INFO: constant GTK2.STOCK_INFO

Constant STOCK_ITALIC: constant GTK2.STOCK_ITALIC

Constant STOCK_JUMP_TO: constant GTK2.STOCK_JUMP_TO

Constant STOCK_JUSTIFY_CENTER: constant GTK2.STOCK_JUSTIFY_CENTER

Constant STOCK_JUSTIFY_FILL: constant GTK2.STOCK_JUSTIFY_FILL

Constant STOCK_JUSTIFY_LEFT: constant GTK2.STOCK_JUSTIFY_LEFT

Constant STOCK_JUSTIFY_RIGHT: constant GTK2.STOCK_JUSTIFY_RIGHT

Constant STOCK_LEAVE_FULLSCREEN: constant GTK2.STOCK_LEAVE_FULLSCREEN

Constant STOCK_MEDIA_FORWARD: constant GTK2.STOCK_MEDIA_FORWARD

Constant STOCK_MEDIA_NEXT: constant GTK2.STOCK_MEDIA_NEXT

Constant STOCK_MEDIA_PAUSE: constant GTK2.STOCK_MEDIA_PAUSE

Constant STOCK_MEDIA_PLAY: constant GTK2.STOCK_MEDIA_PLAY

Constant STOCK_MEDIA_PREVIOUS: constant GTK2.STOCK_MEDIA_PREVIOUS

Constant STOCK_MEDIA_RECORD: constant GTK2.STOCK_MEDIA_RECORD

Constant STOCK_MEDIA_REWIND: constant GTK2.STOCK_MEDIA_REWIND

Constant STOCK_MEDIA_STOP: constant GTK2.STOCK_MEDIA_STOP

Constant STOCK_MISSING_IMAGE: constant GTK2.STOCK_MISSING_IMAGE

Constant STOCK_NETWORK: constant GTK2.STOCK_NETWORK

Constant STOCK_NEW: constant GTK2.STOCK_NEW

Constant STOCK_NO: constant GTK2.STOCK_NO

Constant STOCK_OK: constant GTK2.STOCK_OK

Constant STOCK_OPEN: constant GTK2.STOCK_OPEN

Constant STOCK_PASTE: constant GTK2.STOCK_PASTE

Constant STOCK_PREFERENCES: constant GTK2.STOCK_PREFERENCES

Constant STOCK_PRINT: constant GTK2.STOCK_PRINT

Constant STOCK_PRINT_PREVIEW: constant GTK2.STOCK_PRINT_PREVIEW

Constant STOCK_PROPERTIES: constant GTK2.STOCK_PROPERTIES

Constant STOCK_QUIT: constant GTK2.STOCK_QUIT

Constant STOCK_REDO: constant GTK2.STOCK_REDO

Constant STOCK_REFRESH: constant GTK2.STOCK_REFRESH

Constant STOCK_REMOVE: constant GTK2.STOCK_REMOVE

Constant STOCK_REVERT_TO_SAVED: constant GTK2.STOCK_REVERT_TO_SAVED

Constant STOCK_SAVE: constant GTK2.STOCK_SAVE

Constant STOCK_SAVE_AS: constant GTK2.STOCK_SAVE_AS

Constant STOCK_SELECT_COLOR: constant GTK2.STOCK_SELECT_COLOR

Constant STOCK_SELECT_FONT: constant GTK2.STOCK_SELECT_FONT

Constant STOCK_SORT_ASCENDING: constant GTK2.STOCK_SORT_ASCENDING

Constant STOCK_SORT_DESCENDING: constant GTK2.STOCK_SORT_DESCENDING

Constant STOCK_SPELL_CHECK: constant GTK2.STOCK_SPELL_CHECK

Constant STOCK_STOP: constant GTK2.STOCK_STOP

Constant STOCK_STRIKETHROUGH: constant GTK2.STOCK_STRIKETHROUGH

Constant STOCK_UNDELETE: constant GTK2.STOCK_UNDELETE

Constant STOCK_UNDERLINE: constant GTK2.STOCK_UNDERLINE

Constant STOCK_UNDO: constant GTK2.STOCK_UNDO

Constant STOCK_UNINDENT: constant GTK2.STOCK_UNINDENT

Constant STOCK_YES: constant GTK2.STOCK_YES

Constant STOCK_ZOOM_100: constant GTK2.STOCK_ZOOM_100

Constant STOCK_ZOOM_FIT: constant GTK2.STOCK_ZOOM_FIT

Constant STOCK_ZOOM_IN: constant GTK2.STOCK_ZOOM_IN

Constant STOCK_ZOOM_OUT: constant GTK2.STOCK_ZOOM_OUT

Constant TARGET_SAME_APP: constant GTK2.TARGET_SAME_APP

Constant TARGET_SAME_WIDGET: constant GTK2.TARGET_SAME_WIDGET

Constant TEXT_DIR_LTR: constant GTK2.TEXT_DIR_LTR

Constant TEXT_DIR_NONE: constant GTK2.TEXT_DIR_NONE

Constant TEXT_DIR_RTL: constant GTK2.TEXT_DIR_RTL

Constant TEXT_SEARCH_TEXT_ONLY: constant GTK2.TEXT_SEARCH_TEXT_ONLY

Constant TEXT_SEARCH_VISIBLE_ONLY: constant GTK2.TEXT_SEARCH_VISIBLE_ONLY

Constant TEXT_WINDOW_BOTTOM: constant GTK2.TEXT_WINDOW_BOTTOM

Constant TEXT_WINDOW_LEFT: constant GTK2.TEXT_WINDOW_LEFT

Constant TEXT_WINDOW_PRIVATE: constant GTK2.TEXT_WINDOW_PRIVATE

Constant TEXT_WINDOW_RIGHT: constant GTK2.TEXT_WINDOW_RIGHT

Constant TEXT_WINDOW_TEXT: constant GTK2.TEXT_WINDOW_TEXT

Constant TEXT_WINDOW_TOP: constant GTK2.TEXT_WINDOW_TOP

Constant TEXT_WINDOW_WIDGET: constant GTK2.TEXT_WINDOW_WIDGET

Constant TOOLBAR_BOTH: constant GTK2.TOOLBAR_BOTH

Constant TOOLBAR_BOTH_HORIZ: constant GTK2.TOOLBAR_BOTH_HORIZ

Constant TOOLBAR_ICONS: constant GTK2.TOOLBAR_ICONS

Constant TOOLBAR_SPACE_EMPTY: constant GTK2.TOOLBAR_SPACE_EMPTY

Constant TOOLBAR_SPACE_LINE: constant GTK2.TOOLBAR_SPACE_LINE

Constant TOOLBAR_TEXT: constant GTK2.TOOLBAR_TEXT

Constant TOPLEVEL: constant GTK2.TOPLEVEL

Constant TREE_MODEL_ITERS_PERSIST: constant GTK2.TREE_MODEL_ITERS_PERSIST

Constant TREE_MODEL_LIST_ONLY: constant GTK2.TREE_MODEL_LIST_ONLY

Constant TREE_VIEW_COLUMN_AUTOSIZE: constant GTK2.TREE_VIEW_COLUMN_AUTOSIZE

Constant TREE_VIEW_COLUMN_FIXED: constant GTK2.TREE_VIEW_COLUMN_FIXED

Constant TREE_VIEW_COLUMN_GROW_ONLY: constant GTK2.TREE_VIEW_COLUMN_GROW_ONLY

Constant TREE_VIEW_DROP_AFTER: constant GTK2.TREE_VIEW_DROP_AFTER

Constant TREE_VIEW_DROP_BEFORE: constant GTK2.TREE_VIEW_DROP_BEFORE

Constant TREE_VIEW_DROP_INTO_OR_AFTER: constant GTK2.TREE_VIEW_DROP_INTO_OR_AFTER

Constant TREE_VIEW_DROP_INTO_OR_BEFORE: constant GTK2.TREE_VIEW_DROP_INTO_OR_BEFORE

Constant TREE_VIEW_GRID_LINES_BOTH: constant GTK2.TREE_VIEW_GRID_LINES_BOTH

Constant TREE_VIEW_GRID_LINES_HORIZONTAL: constant GTK2.TREE_VIEW_GRID_LINES_HORIZONTAL

Constant TREE_VIEW_GRID_LINES_NONE: constant GTK2.TREE_VIEW_GRID_LINES_NONE

Constant TREE_VIEW_GRID_LINES_VERTICAL: constant GTK2.TREE_VIEW_GRID_LINES_VERTICAL

Constant TRUE: constant GTK2.TRUE

Constant UI_MANAGER_ACCELERATOR: constant GTK2.UI_MANAGER_ACCELERATOR

Constant UI_MANAGER_AUTO: constant GTK2.UI_MANAGER_AUTO

Constant UI_MANAGER_MENU: constant GTK2.UI_MANAGER_MENU

Constant UI_MANAGER_MENUBAR: constant GTK2.UI_MANAGER_MENUBAR

Constant UI_MANAGER_MENUITEM: constant GTK2.UI_MANAGER_MENUITEM

Constant UI_MANAGER_PLACEHOLDER: constant GTK2.UI_MANAGER_PLACEHOLDER

Constant UI_MANAGER_POPUP: constant GTK2.UI_MANAGER_POPUP

Constant UI_MANAGER_SEPARATOR: constant GTK2.UI_MANAGER_SEPARATOR

Constant UI_MANAGER_TOOLBAR: constant GTK2.UI_MANAGER_TOOLBAR

Constant UI_MANAGER_TOOLITEM: constant GTK2.UI_MANAGER_TOOLITEM

Constant UNIT_INCH: constant GTK2.UNIT_INCH

Constant UNIT_MM: constant GTK2.UNIT_MM

Constant UNIT_PIXEL: constant GTK2.UNIT_PIXEL

Constant UNIT_POINTS: constant GTK2.UNIT_POINTS

Constant UPDATE_ALWAYS: constant GTK2.UPDATE_ALWAYS

Constant UPDATE_CONTINUOUS: constant GTK2.UPDATE_CONTINUOUS

Constant UPDATE_DELAYED: constant GTK2.UPDATE_DELAYED

Constant UPDATE_DISCONTINUOUS: constant GTK2.UPDATE_DISCONTINUOUS

Constant UPDATE_IF_VALID: constant GTK2.UPDATE_IF_VALID

Constant VISIBILITY_FULL: constant GTK2.VISIBILITY_FULL

Constant VISIBILITY_NONE: constant GTK2.VISIBILITY_NONE

Constant VISIBILITY_PARTIAL: constant GTK2.VISIBILITY_PARTIAL

Constant VISIBLE: constant GTK2.VISIBLE

Constant WIDGET_HELP_TOOLTIP: constant GTK2.WIDGET_HELP_TOOLTIP

Constant WIDGET_HELP_WHATS_THIS: constant GTK2.WIDGET_HELP_WHATS_THIS

Constant WINDOW_POPUP: constant GTK2.WINDOW_POPUP

Constant WINDOW_TOPLEVEL: constant GTK2.WINDOW_TOPLEVEL

Constant WIN_POS_CENTER: constant GTK2.WIN_POS_CENTER

Constant WIN_POS_CENTER_ALWAYS: constant GTK2.WIN_POS_CENTER_ALWAYS

Constant WIN_POS_CENTER_ON_PARENT: constant GTK2.WIN_POS_CENTER_ON_PARENT

Constant WIN_POS_MOUSE: constant GTK2.WIN_POS_MOUSE

Constant WIN_POS_NONE: constant GTK2.WIN_POS_NONE

Constant WRAP_CHAR: constant GTK2.WRAP_CHAR

Constant WRAP_NONE: constant GTK2.WRAP_NONE

Constant WRAP_WORD: constant GTK2.WRAP_WORD

Constant WRAP_WORD_CHAR: constant GTK2.WRAP_WORD_CHAR

Method add_builtin_icon

void add_builtin_icon(string name, int size, GTK2.GdkPixbuf pixbuf)

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 false: int false()
Description: Always returns false.

Method flush: void flush()
Description: Flush GDK. Not normally needed, can be useful while doing calculations.

Method get_default_icon_list: array get_default_icon_list()
Description: Gets the value set by set_default_icon_list().

Method get_default_icon_theme: GTK2.IconTheme get_default_icon_theme()
Description: Gets the icon theme.

Method get_file_info: mapping get_file_info(string filename)
Description: Parses an image file far enough to determine its format and size.

Method get_formats: array get_formats()
Description: Get information about the image formats supported.

Method gnome_init: array gnome_init(string app_id, string app_version, array argv)
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 grab_add: void grab_add(GTK2.Widget widget)
Description: Grab a widget.

Method grab_remove: void grab_remove(GTK2.Widget widget)
Description: Remove the grab.

Method gtk_init: array gtk_init(array|void argc, int|void no_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_signals: array list_signals()
Description: Enumerates all recognized signals for all types.

Method list_toplevels: array list_toplevels()
Description: Returns a list of all existing toplevel windows.

Method low_flush: void low_flush()
Description: Flush, but do not process events. Not normally needed.

Method main: void main()
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: int main_iteration_do(int block)
Description: Run one iteration in the mainloop. If block is true, wait for an event before returning.

Method main_level: int main_level()
Description: Return the current recursion depth.

Method main_quit: void main_quit()
Description: Exit from the gtk_main function on the next iteration.

Method move_cursor

void move_cursor(int dx, int dy)

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

void move_cursor_abs(GTK2.GdkWindow w, int dx, int dy)

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 parse_rc: void parse_rc(string rc)
Description: Takes a string and reads it as a gtkrc file.

Method root_window: GTK2.GdkWindow root_window()
Description: Returns the root window of the current display

Method saver_disable: void saver_disable()
Description: Disable the screensaver. This is a low-level X11 function, and thus only works when GDK uses X11

Method saver_enable: void saver_enable()
Description: Enable the screensaver again after saver_disable has been called. This is a low-level X11 function, and thus only works when GDK uses X11.

Method set_auto_startup_notification

void set_auto_startup_notification(int setting)

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: void set_default_icon(GTK2.GdkPixbuf pix)
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: void set_default_icon_from_file(string filename)
Description: Sets an icon to be used as fallback from a file on disk.

Method set_default_icon_list: void set_default_icon_list(array list)
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: void set_default_icon_name(string name)
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

array setup_gtk(array|void argv, int|void do_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);

Method true: int true()
Description: Always returns true.

Method version: array version()
Description: Returns the version of the GTK library.

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

Inherit Dialog: inherit GTK2.Dialog : Dialog

Method create: GTK2.AboutDialog GTK2.AboutDialog(mapping|void props)
Description: Create a new GTK2.AboutDialog.

Method get_artists: array get_artists()
Description: Returns the strings which are displayed in the artists tab of the secondary credits dialog.

Method get_authors: array get_authors()
Description: Returns the strings which are displayed in the authors tab of the secondary credits dialog.

Method get_comments: string get_comments()
Description: Returns the comments string.

Method get_copyright: string get_copyright()
Description: Returns the copyright string.

Method get_documenters: array get_documenters()
Description: Returns the strings which are displayed in the documenters tab of the secondary credits dialog.

Method get_license: string get_license()
Description: Returns the license information.

Method get_logo: GTK2.GdkPixbuf get_logo()
Description: Returns the pixbuf displayed as logo.

Method get_logo_icon_name: string get_logo_icon_name()
Description: Returns the icon name.

Method get_program_name: string get_program_name()
Description: Returns the program name.

Method get_property: mixed get_property(string property)
Description: Get property.

Method get_translator_credits: string get_translator_credits()
Description: Returns the translator credis.

Method get_version: string get_version()
Description: Returns the version string.

Method get_website: string get_website()
Description: Returns the website URL.

Method get_website_label: string get_website_label()
Description: Returns the label used for the website link.

Method get_wrap_license: int get_wrap_license()
Description: Returns whether the license text is automatically wrapped.

Method set_artists: GTK2.AboutDialog set_artists(array art)
Description: Sets the strings which are displayed in the artists tab of the secondary credits dialog.

Method set_authors: GTK2.AboutDialog set_authors(array auth)
Description: Sets the strings which are displayed in the authors tab of the secondary credits dialog.

Method set_comments: GTK2.AboutDialog set_comments(string comments)
Description: Sets the comment string.

Method set_copyright: GTK2.AboutDialog set_copyright(string copyright)
Description: Sets the copyright string.

Method set_documenters: GTK2.AboutDialog set_documenters(array doc)
Description: Sets the strings which are displayed in the documenters tab of the secondary credits dialog.

Method set_license: GTK2.AboutDialog set_license(string license)
Description: Sets the license information.

Method set_logo: GTK2.AboutDialog set_logo(GTK2.GdkPixbuf logo)
Description: Sets the pixbuf to be displayed as the logo.

Method set_logo_icon_name: GTK2.AboutDialog set_logo_icon_name(string name)
Description: Sets the icon name.

Method set_program_name: GTK2.AboutDialog set_program_name(string name)
Description: Sets the name to display in the dialog.

Method set_translator_credits: GTK2.AboutDialog set_translator_credits(string credits)
Description: Sets the translator credits.

Method set_version: GTK2.AboutDialog set_version(string version)
Description: Sets the version string.

Method set_website: GTK2.AboutDialog set_website(string website)
Description: Sets the URL to use for the website link.

Method set_website_label: GTK2.AboutDialog set_website_label(string label)
Description: Sets the label used for the website link. Defaults to the website URL.

Method set_wrap_license: GTK2.AboutDialog set_wrap_license(int setting)
Description: Sets whether the license text is automatically wrapped.

Class GTK2.AccelGroup

Description

An AccelGroup stores keybindings. A group is automatically created by W(MenuFactory)

NOIMG

Signals: accel_activate

accel_changed

Inherit Object: inherit G.Object : Object

Method connect: GTK2.AccelGroup connect(int accel_key, int accel_mods, int accel_flags, function(:void) cb, mixed user_data)
Description: Installs an accelerator in this group.

Method connect_by_path: GTK2.AccelGroup connect_by_path(string accel_path, function(:void) cb, mixed user_data)
Description: Installs an accelerator in this group, using an accelerator path to look up the appropriate key and modifiers.

Method create: GTK2.AccelGroup GTK2.AccelGroup()
Description: Create a new accelerator group

Method disconnect: GTK2.AccelGroup disconnect(int accel_key, int accel_mods)
Description: Removes an accelerator previously installed.

Method lock: GTK2.AccelGroup lock()
Description: Locks the group.

Method unlock: GTK2.AccelGroup unlock()
Description: Undoes the last call to lock().

Class GTK2.AccelLabel

Description: A label for accelerators. Properties: GTK2.Widget accel-widget

Inherit Label: inherit GTK2.Label : Label

Method create: GTK2.AccelLabel GTK2.AccelLabel(string|mapping text_or_props)
Description: Creates a new W(AccelLabel).

Method get_accel_widget: GTK2.Widget get_accel_widget()
Description: Fetches the widget monitored by this accelerator label.

Method get_accel_width: int get_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: int refetch()
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.

Method set_accel_widget: GTK2.AccelLabel set_accel_widget(GTK2.Widget accel_widget)
Description: Sets the widget to be monitored.

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

Inherit Object: inherit G.Object : Object

Method activate: GTK2.Action activate()
Description: Emits the "activate" signal, if it isn't insensitive.

Method block_activate_from: GTK2.Action block_activate_from(GTK2.Widget proxy)
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.Action connect_accelerator()
Description: Installs the accelerator if this action widget has an accel path and group.

Method connect_proxy: GTK2.Action connect_proxy(GTK2.Widget proxy)
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.Action GTK2.Action(string|mapping name_or_props, string|void label, string|void tooltip, string|void stock_id)
Description: Creates a new object.

Method create_icon: GTK2.Widget create_icon(int icon_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_MENU and ICON_SIZE_SMALL_TOOLBAR.

Method create_menu: GTK2.Widget create_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.Widget create_menu_item()
Description: Creates a menu item widget that proxies for the action.

Method create_tool_item: GTK2.Widget create_tool_item()
Description: Creates a toolbar item widget that proxies for the action.

Method disconnect_accelerator: GTK2.Action disconnect_accelerator()
Description: Undoes the effect of one call to connect_accelerator().

Method disconnect_proxy: GTK2.Action disconnect_proxy(GTK2.Widget proxy)
Description: Disconnects a proxy widget. Does not destroy the widget.

Method get_accel_path: string get_accel_path()
Description: Returns the accel path for this action.

Method get_name: string get_name()
Description: Returns the name of the action.

Method get_proxies: array get_proxies()
Description: Returns the proxy widgets.

Method get_sensitive: int get_sensitive()
Description: Returns whether the action itself is sensitive. Note that this doesn't necessarily mean effective sensitivity.

Method get_visible: int get_visible()
Description: Returns whether the action itself is visible.

Method is_sensitive: int is_sensitive()
Description: Returns whether the action is effectively sensitive.

Method is_visible: int is_visible()
Description: Returns whether the action is effectively visible.

Method set_accel_group: GTK2.Action set_accel_group(GTK2.AccelGroup group)
Description: Sets the GTK2.AccelGroup in which the accelerator for this action will be installed.

Method set_accel_path: GTK2.Action set_accel_path(string accel_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.

Method set_sensitive: GTK2.Action set_sensitive(int setting)
Description: Sets the sensitive property.

Method set_visible: GTK2.Action set_visible(int setting)
Description: Sets the visible property.

Method unblock_activate_from: GTK2.Action unblock_activate_from(GTK2.Widget proxy)
Description: Re-enables calls to the activate() function.

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

Inherit Object: inherit G.Object : Object

Method add_action

GTK2.ActionGroup add_action(GTK2.Action action, string|void accelerator)

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.ActionGroup add_actions(array entries)

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.ActionGroup add_radio_actions(array entries, function(:void) cb, mixed user_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.ActionGroup add_toggle_actions(array entries)

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.ActionGroup GTK2.ActionGroup(string|mapping name_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.Action get_action(string name)
Description: Looks up an action in the action group by name.

Method get_name: string get_name()
Description: Gets the name of the action group.

Method get_sensitive: int get_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: int get_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 list_actions: array list_actions()
Description: Lists the actions in the action group.

Method remove_action: GTK2.ActionGroup remove_action(GTK2.Action action)
Description: Removes an action object.

Method set_sensitive: GTK2.ActionGroup set_sensitive(int setting)
Description: Changes the sensitivity.

Method set_visible: GTK2.ActionGroup set_visible(int setting)
Description: Changes the visibility.

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_related_action: GTK2.Action get_related_action()
Description: Gets the related action

Method get_use_action_appearance: int get_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.Activatable set_related_action(GTK2.Action a)
Description: Sets the related action

Method set_use_action_appearance: GTK2.Activatable set_use_action_appearance(int use_apperance)
Description: Sets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance

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

Inherit Data: inherit GTK2.Data : Data

Method changed: GTK2.Adjustment changed()
Description: Emites a "changed" signal.

Method clamp_page: GTK2.Adjustment clamp_page(float lower, float upper)
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

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 get_value: float get_value()
Description: Gets the current value.

Method set_value

GTK2.Adjustment set_value(float to)

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.

Method value_changed: GTK2.Adjustment value_changed()
Description: Emits a "value-changed" signal.

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

Inherit Bin: inherit GTK2.Bin : Bin

Method create

GTK2.Alignment GTK2.Alignment(float|mapping xalign_or_props, float|void yalign, float|void xscale, float|void yscale)

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.Alignment set(float xalign, float yalign, float xscale, float yscale)

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_padding: GTK2.Alignment set_padding(int padding_top, int padding_bottom, int padding_left, int padding_right)
Description: Sets the padding on the different sides.

Class GTK2.Allocation

Inherit Rectangle: inherit GDK2.Rectangle : Rectangle

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_RIGHT and ARROW_UP int shadow-type SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_NONE and SHADOW_OUT

Inherit Misc: inherit GTK2.Misc : Misc

Method create: GTK2.Arrow GTK2.Arrow(int|mapping arrow_type_or_props, int|void shadow_type)
Description: First argument is one of ARROW_DOWN, ARROW_LEFT, ARROW_RIGHT and ARROW_UP, second one of SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_NONE and SHADOW_OUT.

Method set: GTK2.Arrow set(int arrow_type, int shadow_type)
Description: First argument is one of ARROW_DOWN, ARROW_LEFT, ARROW_RIGHT and ARROW_UP, second one of SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_NONE and SHADOW_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

Inherit Frame: inherit GTK2.Frame : Frame

Method create: GTK2.AspectFrame GTK2.AspectFrame(mapping|string label, float|void xalign, float|void yalign, float|void ratio, int|void obey_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.AspectFrame set(float xalign, float yalign, float ratio, int obey_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.

Inherit Window: inherit GTK2.Window : Window

Method add_action_widget: GTK2.Assistant add_action_widget(GTK2.Widget child)
Description: Adds a widget to the action area.

Method append_page: int append_page(GTK2.Widget page)
Description: Appends a page to the assistant.

Method create: GTK2.Assistant GTK2.Assistant(mapping|void props)
Description: Create a new assistant.

Method get_current_page: int get_current_page()
Description: Returns the page number of the current page. Returns -1 if there are no pages.

Method get_n_pages: int get_n_pages()
Description: Returns the number of pages.

Method get_nth_page: GTK2.Widget get_nth_page(int page_num)
Description: Returnss the child widget contained in page number page_num.

Method get_page_complete: int get_page_complete(GTK2.Widget page)
Description: Gets whether page is complete.

Method get_page_header_image: GTK2.GdkPixbuf get_page_header_image(GTK2.Widget page)
Description: Gets the header image for page.

Method get_page_side_image: GTK2.GdkPixbuf get_page_side_image(GTK2.Widget page)
Description: Gets the side image for page.

Method get_page_title: string get_page_title(GTK2.Widget page)
Description: Gets the title for page.

Method get_page_type: int get_page_type(GTK2.Widget page)
Description: Gets the page type of page.

Method insert_page: int insert_page(GTK2.Widget page, int pos)
Description: Inserts a page at a given position. If pos equals -1 it will append the page.

Method prepend_page: int prepend_page(GTK2.Widget page)
Description: Prepends a page to the assistant.

Method remove_action_widget: GTK2.Assistant remove_action_widget(GTK2.Widget child)
Description: Removes a widget from the action area.

Method set_current_page: GTK2.Assistant set_current_page(int page_num)
Description: Switches the page to page_num.

Method set_forward_page_func: GTK2.Assistant set_forward_page_func(function(:void) f, mixed data)
Description: Set the forward page function.

Method set_page_complete: GTK2.Assistant set_page_complete(GTK2.Widget page, int complete)
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.Assistant set_page_header_image(GTK2.Widget page, GTK2.GdkPixbuf pixbuf)
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.Assistant set_page_side_image(GTK2.Widget page, GTK2.GdkPixbuf pixbuf)
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.Assistant set_page_title(GTK2.Widget page, string title)
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.Assistant set_page_type(GTK2.Widget page, int type)
Description: Sets the page type for page. The page type determines the page behavior.

Method update_buttons_state

GTK2.Assistant update_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.

Inherit Container: inherit GTK2.Container : Container

Method get_child: GTK2.Widget get_child()
Description: Return the 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

Inherit Container: inherit GTK2.Container : Container

Method get_homogeneous: int get_homogeneous()
Description: Returns whether the box is homogeneous.

Method get_spacing: int get_spacing()
Description: Gets the spacing.

Method pack_end: GTK2.Box pack_end(GTK2.Widget widget, int expandp, int fillp, int padding)
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.Box pack_end_defaults(GTK2.Widget widget)
Description: The argument is the widget to add.

Method pack_start: GTK2.Box pack_start(GTK2.Widget widget, int expandp, int fillp, int padding)
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.Box pack_start_defaults(GTK2.Widget widget)
Description: The argument is the widget to add. This function is equivalent to 'add'

Method query_child_packing: mapping query_child_packing(GTK2.Widget child)
Description: Return a mapping: ([ "expand":expandp, "fill":fillp, "padding":paddingp, "type":type ])

Method reorder_child: GTK2.Box reorder_child(GTK2.Widget child, int new_position)
Description: Move widget to pos, pos is an integer, between 0 and sizeof(box->children())-1

Method set_child_packing

GTK2.Box set_child_packing(GTK2.Widget child_widget, int expandp, int fillp, int padding, int pack_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_END and PACK_START.

You can emulate pack_start and pack_end with add and set_child_packing.

Method set_homogeneous: GTK2.Box set_homogeneous(int homogeneousp)
Description: If true, all widgets in the box will get exactly the same amount of space

Method set_spacing: GTK2.Box set_spacing(int spacing)
Description: This is the amount of spacing (in pixels) inserted beween all widgets

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

Inherit Activatable: inherit GTK2.Activatable : Activatable

Inherit Bin: inherit GTK2.Bin : Bin

Method clicked: GTK2.Button clicked()
Description: Emulate a 'clicked' event (press followed by release).

Method create: GTK2.Button GTK2.Button(string|mapping label_or_props)
Description: If a string is supplied, a W(Label) is created and added to the button.

Method enter: GTK2.Button enter()
Description: Emulate a 'enter' event.

Method get_alignment: mapping get_alignment()
Description: Gets the alignment of the child.

Method get_focus_on_click: int get_focus_on_click()
Description: Returns whether the button grabs focus when it is clicked.

Method get_image: GTK2.Widget get_image()
Description: Gets the widget that is currently set as the image of the button.

Method get_image_position: int get_image_position()
Description: Gets the position of the image relative to the text inside the button.

Method get_label: string get_label()
Description: Get the text from the label of the button.

Method get_relief: int get_relief()
Description: One of RELIEF_HALF, RELIEF_NONE and RELIEF_NORMAL, set with set_relief()

Method get_use_stock: int get_use_stock()
Description: Returns whether the button label is a stock item.

Method get_use_underline: int get_use_underline()
Description: Returns whether an embedded underline in the button indicates a mnemonic.

Method leave: GTK2.Button leave()
Description: Emulate a 'leave' event.

Method pressed: GTK2.Button pressed()
Description: Emulate a 'press' event.

Method released: GTK2.Button released()
Description: Emulate a 'release' event.

Method set_alignment: GTK2.Button set_alignment(float xalign, float yalign)
Description: Sets the alignment of the child.

Method set_focus_on_click: GTK2.Button set_focus_on_click(int focus_on_click)
Description: Sets whether the button will grab focus when it is clicked.

Method set_image: GTK2.Button set_image(GTK2.Widget widget)
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.Button set_image_position(int position)
Description: Sets the position of the image relative to the text inside the button.

Method set_label: GTK2.Button set_label(string label)
Description: Set the text of the label.

Method set_relief: GTK2.Button set_relief(int newstyle)
Description: One of RELIEF_HALF, RELIEF_NONE and RELIEF_NORMAL

Method set_use_stock: GTK2.Button set_use_stock(int use_stock)
Description: If true, the label set on the button is used as a stock id to select the stock item for the button.

Method set_use_underline: GTK2.Button set_use_underline(int use_underline)
Description: If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key.

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

Inherit Box: inherit GTK2.Box : Box

Method get_child_secondary: int get_child_secondary(GTK2.Widget child)
Description: Returns whether child should appear in a secondary group of children.

Method get_layout: int get_layout()
Description: Returns the currently configured layout. One of BUTTONBOX_DEFAULT_STYLE, BUTTONBOX_EDGE, BUTTONBOX_END, BUTTONBOX_SPREAD and BUTTONBOX_START

Method set_child_secondary: GTK2.ButtonBox set_child_secondary(GTK2.Widget child, int is_secondary)
Description: Sets whether child should appear in a secondary group of children.

Method set_layout: GTK2.ButtonBox set_layout(int layout)
Description: layout is one of BUTTONBOX_DEFAULT_STYLE, BUTTONBOX_EDGE, BUTTONBOX_END, BUTTONBOX_SPREAD and BUTTONBOX_START

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

Inherit Widget: inherit GTK2.Widget : Widget

Method clear_marks: GTK2.Calendar clear_marks()
Description: Remove all day markers

Method create: GTK2.Calendar GTK2.Calendar(mapping|void props)
Description: Create a new calendar widget

Method freeze: GTK2.Calendar freeze()
Description: Suspend all dynamic updating of the widget

Method get_date: mapping get_date()
Description: returns a mapping: ([ "year":year, "month":month, "day":day ])

Method get_display_options: int get_display_options()
Description: Returns the current display options.

Method get_marked_dates: array get_marked_dates()
Description: Returns an array (with 31 elements) with 1es and 0es.

Method mark_day: GTK2.Calendar mark_day(int day_of_month)
Description: Mark a day

Method select_day: GTK2.Calendar select_day(int day_of_month)
Description: Select a certain day of the currently selected month

Method select_month: int select_month(int month, int year)
Description: Select the month to be viewed.

Method set_display_options: GTK2.Calendar set_display_options(int options)
Description: Bitwise or of one or more of CALENDAR_NO_MONTH_CHANGE, CALENDAR_SHOW_DAY_NAMES, CALENDAR_SHOW_HEADING, CALENDAR_SHOW_WEEK_NUMBERS and CALENDAR_WEEK_START_MONDAY.

Method thaw: GTK2.Calendar thaw()
Description: Resume dynamic updating of the widget

Method unmark_day: GTK2.Calendar unmark_day(int day_of_month)
Description: Unmark a day

Class GTK2.CellEditable

Description

Interface for widgets which are used for editing cells.

Signals: editing_done

remove_widget

Method editing_done: GTK2.CellEditable editing_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.CellEditable remove_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.

Method start_editing: GTK2.CellEditable start_editing(GTK2.GdkEvent event)
Description: Begins editing. event is the GDK2.Event that began the editing process. It may be empty, in the instance that editing was initiated through programmatic means.

Class GTK2.CellLayout

Description: An interface for packing cells.

Method add_attribute: GTK2.CellLayout add_attribute(GTK2.CellRenderer cell, string attribute, int column)
Description: Adds an attribute mapping.

Method clear: GTK2.CellLayout clear()
Description: Unsets all the mappings on all renderers and removes all renderers.

Method clear_attributes: GTK2.CellLayout clear_attributes(GTK2.CellRenderer cell)
Description: Clears all existing attributes.

Method pack_end: GTK2.CellLayout pack_end(GTK2.CellRenderer cell, int expand)
Description: See pack_start().

Method pack_start: GTK2.CellLayout pack_start(GTK2.CellRenderer cell, int expand)
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.CellLayout reorder(GTK2.CellRenderer cell, int position)
Description: Re-inserts cell at position.

Method set_cell_data_func: GTK2.CellLayout set_cell_data_func(GTK2.CellRenderer cell, function(:void) f, mixed user_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_EDITABLE and CELL_RENDERER_MODE_INERT int sensitive int visible int width float xalign int xpad float yalign int ypad

Signals: editing_canceled

editing_started

Inherit Data: inherit GTK2.Data : Data

Method activate: int activate(GTK2.GdkEvent event, GTK2.Widget widget, string path, GTK2.GdkRectangle background_area, GTK2.GdkRectangle cell_area, int flags)
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: mapping get_fixed_size()
Description: Fills in width and height with the appropriate size of the cell.

Method get_size: mapping get_size(GTK2.Widget widget, GTK2.GdkRectangle cell_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.CellRenderer render(GTK2.GdkWindow window, GTK2.Widget widget, GTK2.GdkRectangle background_area, GTK2.GdkRectangle cell_area, GTK2.GdkRectangle expose_area, int flags)
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_SELECTED and CELL_RENDERER_SORTED.

Method set_fixed_size: GTK2.CellRenderer set_fixed_size(int width, int height)
Description: Sets the renderer size to be explicit, independent of the properties set.

Method start_editing: GTK2.CellRenderer start_editing(GTK2.GdkEvent event, GTK2.Widget widget, string path, GTK2.GdkRectangle background_area, GTK2.GdkRectangle cell_area, int flags)
Description: Passes an activate event to the cell renderer for possible processing.

Method stop_editing: GTK2.CellRenderer stop_editing(int canceled)
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

Inherit CellRendererText: inherit GTK2.CellRendererText : CellRendererText

Method create: GTK2.CellRendererAccel GTK2.CellRendererAccel(mapping|void props)
Description: Create a new GTK2.CellRendererAccel.

Class GTK2.CellRendererCombo

Description: Properties: int has-entry GTK2.TreeModel model int text-column

Inherit CellRendererText: inherit GTK2.CellRendererText : CellRendererText

Method create: GTK2.CellRendererCombo GTK2.CellRendererCombo(mapping|void props)
Description: Creates a new W(CellRendererCombo).

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

Inherit CellRenderer: inherit GTK2.CellRenderer : CellRenderer

Method create: GTK2.CellRendererPixbuf GTK2.CellRendererPixbuf(mapping|void props)
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

Inherit CellRenderer: inherit GTK2.CellRenderer : CellRenderer

Method create: GTK2.CellRendererProgress GTK2.CellRendererProgress(mapping|void props)
Description: Create a new W(CellRendererProgress).

Class GTK2.CellRendererSpin

Description: Properties: int digits GTK2.Adjustment adjustment float climb-rate

Inherit CellRendererText: inherit GTK2.CellRendererText : CellRendererText

Method create: GTK2.CellRendererSpin GTK2.CellRendererSpin(mapping|void props)
Description: Create a new GTK2.CellRendererSpin.

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_NONE and PANGO_ELLIPSIZE_START int 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 stretch 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_CONDENSED and PANGO_STRETCH_ULTRA_EXPANDED int stretch-set int strikethrough int strikethrough-set int style PANGO_STYLE_ITALIC, PANGO_STYLE_NORMAL and PANGO_STYLE_OBLIQUE int style-set string text int underline PANGO_UNDERLINE_DOUBLE, PANGO_UNDERLINE_ERROR, PANGO_UNDERLINE_LOW, PANGO_UNDERLINE_NONE and PANGO_UNDERLINE_SINGLE int underline-set int variant PANGO_VARIANT_NORMAL and PANGO_VARIANT_SMALL_CAPS int variant-set int weight int weight-set int width-chars

Signals: edited

Inherit CellRenderer: inherit GTK2.CellRenderer : CellRenderer

Method create: GTK2.CellRendererText GTK2.CellRendererText(mapping|void props)
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.CellRendererText set_fixed_height_from_font(int number_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

Inherit CellRenderer: inherit GTK2.CellRenderer : CellRenderer

Method create: GTK2.CellRendererToggle GTK2.CellRendererToggle(mapping|void props)
Description: Creates a new W(CellRendererToggle). Adjust rendering parameters using object properties. Object properties can be set globally with set().

Method get_active: int get_active()
Description: Returns whether the cell renderer is active.

Method get_radio: int get_radio()
Description: Returns whether we're rendering radio toggles rather than checkboxes.

Method set_active: GTK2.CellRendererToggle set_active(int setting)
Description: Activates or deactivates a cell renderer.

Method set_radio: GTK2.CellRendererToggle set_radio(int radio)
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

Inherit CellLayout: inherit GTK2.CellLayout : CellLayout

Inherit Widget: inherit GTK2.Widget : Widget

Method create: GTK2.CellView GTK2.CellView(string|GdkPixbuf|mapping text, int|void markup)
Description: Create a new W(CellView) widget.

Method get_cell_renderers: array get_cell_renderers()
Description: Returns the cell renderers which have been added to this view.

Method get_displayed_row: GTK2.TreePath get_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: mapping get_size_of_row(GTK2.TreePath path)
Description: Returns width and height of the size needed to display the model row pointed to by path.

Method set_background_color: GTK2.CellView set_background_color(GTK2.GdkColor color)
Description: Sets the background color.

Method set_displayed_row: GTK2.CellView set_displayed_row(GTK2.TreePath path)
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.

Method set_model: GTK2.CellView set_model(GTK2.TreeModel model)
Description: Sets the model. If this view already has a model set, it will remove it before setting the new model.

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

Inherit ToggleButton: inherit GTK2.ToggleButton : ToggleButton

Method create: GTK2.CheckButton GTK2.CheckButton(string|mapping label_or_props, int|void mnemonic)
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)

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

Inherit MenuItem: inherit GTK2.MenuItem : MenuItem

Method create: GTK2.CheckMenuItem GTK2.CheckMenuItem(string|mapping label_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_active: int get_active()
Description: Get whether item is active.

Method get_draw_as_radio: int get_draw_as_radio()
Description: Get whether check menu item is drawn like a radio button.

Method get_inconsistent: int get_inconsistent()
Description: Retrieves the value set by set_inconsistent().

Method set_active: GTK2.CheckMenuItem set_active(int new_state)
Description: State is either 1 or 0. If 1, the button will be 'pressed'.

Method set_draw_as_radio: GTK2.CheckMenuItem set_draw_as_radio(int draw_as_radio)
Description: Set whether check menu item is drawn like a radio button.

Method set_inconsistent: GTK2.CheckMenuItem set_inconsistent(int setting)
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.

Method toggled: GTK2.CheckMenuItem toggled()
Description: Emulate a toggled event

Class GTK2.Clipboard

Description: Clipboard implementation.

Inherit Object: inherit G.Object : Object

Method clear: GTK2.Clipboard clear()
Description: Clears the contents of the clipboard.

Method get: GTK2.Clipboard get(GDK2.Atom selection)
Description: Returns the clipboard object for the given selection.

Method get_display: GTK2.GdkDisplay get_display()
Description: Gets the GDK2.Display associated with this clipboard.

Method get_for_display: GTK2.Clipboard get_for_display(GTK2.GdkDisplay display, GDK2.Atom selection)
Description: Returns the clipboard object for the given selection.

Method set_image: GTK2.Clipboard set_image(GTK2.GdkPixbuf pixbuf)
Description: Sets the contents of the clipboard to the given GDK2(Pixbuf).

Method set_text: GTK2.Clipboard set_text(sprintf_format text, 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.GdkPixbuf wait_for_image()
Description: Requests the contents of the clipboard as image and converts the result to a GDK2.Pixbuf.

Method wait_for_rich_text: string wait_for_rich_text(GTK2.TextBuffer buffer)
Description: Requests the contents of the clipboard as rich text.

Method wait_for_text: string wait_for_text()
Description: Requests the contents of the clipboard as text

Method wait_is_image_available: int wait_is_image_available()
Description: Test to see if tehre is an image available to be pasted.

Method wait_is_rich_text_available: int wait_is_rich_text_available(GTK2.TextBuffer buffer)
Description: Test to see if there is rich text available to be pasted.

Method wait_is_text_available: int wait_is_text_available()
Description: Test to see if there is text available to be pasted. This is done by requesting the TARGETS atom and checking if it contains any of the supported text targets.

Class GTK2.ColorButton

Description

Properties: int alpha GDK2.Color color string title int use-alpha

Signals: color_set When a user selects a color.

Inherit Button: inherit GTK2.Button : Button

Method create: GTK2.ColorButton GTK2.ColorButton(GTK2.GdkColor red_or_props, int|void green, int|void blue)
Description: Create a new W(ColorButton).

Method get_alpha: int get_alpha()
Description: Get the current alpha value.

Method get_color: GTK2.GdkColor get_color()
Description: Returns the current color.

Method get_title: string get_title()
Description: Get the title.

Method get_use_alpha: int get_use_alpha()
Description: Gets whether the color button uses the alpha channel.

Method set_alpha: GTK2.ColorButton set_alpha(int alpha)
Description: Sets the current opacity to alpha.

Method set_color: GTK2.ColorButton set_color(int|GdkColor red, int|void green, int|void blue)
Description: Sets the current color.

Method set_title: GTK2.ColorButton set_title(string title)
Description: Sets the title for the color selection dialog.

Method set_use_alpha: GTK2.ColorButton set_use_alpha(int use_alpha)
Description: Sets whether or not the color button should use the alpha channel.

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

Inherit Vbox: inherit GTK2.Vbox : Vbox

Method create: GTK2.ColorSelection GTK2.ColorSelection(mapping|void props)
Description: Create a new color selection.

Method get_current_alpha: int get_current_alpha()
Description: Returns the current alpha value.

Method get_current_color: mapping get_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: int get_has_opacity_control()
Description: Determines whether the colorsel has an opacity control.

Method get_has_palette: int get_has_palette()
Description: Determines whether the color selector has a color palette.

Method get_previous_alpha: int get_previous_alpha()
Description: Returns the previous alpha value.

Method get_previous_color: mapping get_previous_color()
Description: Returns the original color value.

Method is_adjusting: int is_adjusting()
Description: Gets the current state of the colorsel.

Method set_current_alpha: GTK2.ColorSelection set_current_alpha(int alpha)
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.ColorSelection set_current_color(mapping color)
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.ColorSelection set_has_opacity_control(int setting)
Description: Sets whether or not to use opacity.

Method set_has_palette: GTK2.ColorSelection set_has_palette(int has_palette)
Description: Shows and hides the palette based upon the value of has_palette

Method set_previous_alpha: GTK2.ColorSelection set_previous_alpha(int alpha)
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.

Method set_previous_color: GTK2.ColorSelection set_previous_color(mapping colors)
Description: Sets the 'previous' color to be color.

Class GTK2.ColorSelectionDialog

Description: Color Selection Dialog

Inherit Dialog: inherit GTK2.Dialog : Dialog

Method create: GTK2.ColorSelectionDialog GTK2.ColorSelectionDialog(string|mapping title_or_props)
Description: Create a new Color Selection Dialog

Method get_cancel_button: GTK2.Widget get_cancel_button()
Description: The Cancel button.

Method get_colorsel: GTK2.Widget get_colorsel()
Description: The Color Selection widget contained within the dialog

Method get_help_button: GTK2.Widget get_help_button()
Description: The Help button.

Method get_ok_button: GTK2.Widget get_ok_button()
Description: The OK button.

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

Inherit Bin: inherit GTK2.Bin : Bin

Inherit CellEditable: inherit GTK2.CellEditable : CellEditable

Inherit CellLayout: inherit GTK2.CellLayout : CellLayout

Method append_text: GTK2.ComboBox append_text(string text)
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.ComboBox GTK2.ComboBox(GTK2.TreeModel model_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: int get_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_iter: GTK2.TreeIter get_active_iter()
Description: Get the current active item.

Method get_active_text: string get_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: int get_add_tearoffs()
Description: Gets whether the popup menu has tearoff items.

Method get_column_span_column: int get_column_span_column()
Description: Returns the column with column span information.

Method get_focus_on_click: int get_focus_on_click()
Description: Returns whether the combo box grabs focus when it is clicked with the mouse.

Method get_model: GTK2.TreeModel get_model()
Description: Get the GTK2.TreeModel which is acting as a data source.

Method get_row_span_column: int get_row_span_column()
Description: Returns the column with row span information.

Method get_title: string get_title()
Description: Gets the current title of the menu in tearoff mode.

Method get_wrap_width: int get_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.ComboBox insert_text(int position, string text)
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 popdown: GTK2.ComboBox popdown()
Description: Hides the menu or dropdown list.

Method popup: GTK2.ComboBox popup()
Description: Pops up the menu or dropdown list.

Method prepend_text: GTK2.ComboBox prepend_text(string text)
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.ComboBox remove_text(int position)
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: GTK2.ComboBox set_active(int index_)
Description: Sets the active item.

Method set_active_iter: GTK2.ComboBox set_active_iter(GTK2.TreeIter iter)
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.ComboBox set_add_tearoffs(int setting)
Description: Sets whether the popup menu should have a tearoff menu item.

Method set_column_span_column: GTK2.ComboBox set_column_span_column(int column_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.ComboBox set_focus_on_click(int setting)
Description: Sets whether the combo box will grab focus when it is clicked with the mouse.

Method set_model: GTK2.ComboBox set_model(GTK2.TreeModel model)
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.ComboBox set_row_separator_func(function(:void) f, mixed user_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.ComboBox set_row_span_column(int row_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.ComboBox set_title(string title)
Description: Sets the menu's title in tearoff mode.

Method set_wrap_width: GTK2.ComboBox set_wrap_width(int width)
Description: Sets the wrap width. The wrap width is basically the preferred number of columns when you want the popup to be layed out in a table.

Class GTK2.ComboBoxEntry

Description: Properties: int text-column

Inherit CellEditable: inherit GTK2.CellEditable : CellEditable

Inherit CellLayout: inherit GTK2.CellLayout : CellLayout

Inherit ComboBox: inherit GTK2.ComboBox : ComboBox

Method create: GTK2.ComboBoxEntry GTK2.ComboBoxEntry(string|TreeModel|mapping model, int|void text_column)
Description: Create a new ComboBoxEntry, either empty or with a model.

Method entry: GTK2.Widget entry()
Description: Returns the GTK2.Entry widget

Method get_text_column: int get_text_column()
Description: Returns the column which this widget is using to get the strings from.

Method set_text_column: GTK2.ComboBoxEntry set_text_column(int text_column)
Description: Sets the model column which this widget should use to get strings from.

Class GTK2.Container

Description

The basic container class. Properties: int border-width GTK2.Widget child int resize-mode RESIZE_IMMEDIATE, RESIZE_PARENT and RESIZE_QUEUE

Signals: 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

Inherit Widget: inherit GTK2.Widget : Widget

Method add: GTK2.Container add(GTK2.Widget widget)
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 check_resize: GTK2.Container check_resize()
Description: Undocumented

Method get_border_width: int get_border_width()
Description: Retrieves the border width.

Method get_children: array get_children()
Description: This function returns all children of the container as an array.

Method get_focus_chain: array get_focus_chain()
Description: Returns the focus chain.

Method get_focus_hadjustment: GTK2.Adjustment get_focus_hadjustment()
Description: Retrieves the horizontal focus adjustment.

Method get_focus_vadjustment: GTK2.Adjustment get_focus_vadjustment()
Description: Retrieves the vertical focus adjustment.

Method get_resize_mode: int get_resize_mode()
Description: Returns the resize mode.

Method remove: GTK2.Container remove(GTK2.Widget widget)
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 resize_children: GTK2.Container resize_children()
Description: Undocumented.

Method set_border_width: GTK2.Container set_border_width(int width)
Description: Sets the border width.

Method set_focus_chain

GTK2.Container set_focus_chain(array focusable_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.Container set_focus_child(GTK2.Widget child)
Description: Emulate a set_focus_child signal. Focus on the specified child.

Method set_focus_hadjustment: GTK2.Container set_focus_hadjustment(GTK2.Adjustment adj)
Description: Set the hadjustment used to focus children.

Method set_focus_vadjustment: GTK2.Container set_focus_vadjustment(GTK2.Adjustment adj)
Description: Set the vadjustment used to focus children.

Method set_reallocate_redraws: GTK2.Container set_reallocate_redraws(int setting)
Description: Sets the reallocate_redraws flag.

Method set_resize_mode: GTK2.Container set_resize_mode(int mode)
Description: One of RESIZE_IMMEDIATE, RESIZE_PARENT and RESIZE_QUEUE

Class GTK2.Data

Description

A class inherited by all objects used to store data (they are not widgets)

Signals: disconnect

Inherit Object: inherit GTK2.Object : Object

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

Inherit Vbox: inherit GTK2.Vbox : Vbox

Method create: GTK2.Databox GTK2.Databox()
Description: Create a new databox widget

Method data_add: int data_add(int nelems, array x, array y, GTK2.GdkColor color, int type, int dot_size)
Description: Type is one of DATABOX_BARS, DATABOX_CROSS_SIMPLE, DATABOX_GRID, DATABOX_LINES, DATABOX_NOT_DISPLAYED and DATABOX_POINTS

Method data_get_color: GTK2.GdkColor data_get_color(int index)
Description: Get the color at index.

Method data_get_extrema: array data_get_extrema()
Description: Get the bounds of the data set (?)

Method data_get_grid_config: int data_get_grid_config(int index)
Description: See data_set_grid_config().

Method data_get_type: array data_get_type(int index)
Description: Return type and dot size at index.

Method data_get_value: mapping data_get_value(int x, int y)
Description: Get the value at the given coordinates.

Method data_get_visible_extrema: array data_get_visible_extrema()
Description: Get the positions of the edges of the display.

Method data_remove: int data_remove(int index)
Description: Remove data at index.

Method data_remove_all: int data_remove_all()
Description: Remove all data.

Method data_set_color: int data_set_color(int index, GTK2.GdkColor color)
Description: Set the color at index.

Method data_set_grid_config: int data_set_grid_config(int index, int hlines, int vlines)
Description: Not useful unless the data type is GTK2.DATABOX_GRID.

Method data_set_type: int data_set_type(int index, int type, int dot_size)
Description: Type is one of DATABOX_BARS, DATABOX_CROSS_SIMPLE, DATABOX_GRID, DATABOX_LINES, DATABOX_NOT_DISPLAYED and DATABOX_POINTS

Method get_rulers_enable: GTK2.Databox get_rulers_enable()
Description: Get whether rulers will be displayed.

Method get_scrollbars_enable: GTK2.Databox get_scrollbars_enable()
Description: Get whether scrollbars will be displayed.

Method get_selection_enable: int get_selection_enable()
Description: Get whether selection is enabled.

Method get_selection_fill_enable: int get_selection_fill_enable()
Description: Get whether the selection will be filled.

Method get_zoom_enable: GTK2.Databox get_zoom_enable()
Description: Get whether zoom is enabled.

Method get_zoom_limit: float get_zoom_limit()
Description: Get the zoom limit.

Method redraw: GTK2.Databox redraw()
Description: Redraw.

Method rescale: GTK2.Databox rescale()
Description: Rescale with automatically-calculated extrema.

Method rescale_inverted: GTK2.Databox rescale_inverted(int invertX, int invertY)
Description: Rescale with an inverted x and/or y direction.

Method rescale_with_values: GTK2.Databox rescale_with_values(float minx, float miny, float maxx, float maxy)
Description: Rescale with specific data extrema.

Method set_background_color: GTK2.Databox set_background_color(GTK2.GdkColor color)
Description: Set the background color.

Method set_rulers_enable: GTK2.Databox set_rulers_enable(int setting)
Description: Set whether rulers will be displayed.

Method set_scrollbars_enable: GTK2.Databox set_scrollbars_enable(int setting)
Description: Set whether scrollbars will be displayed.

Method set_selection_enable: GTK2.Databox set_selection_enable(int setting)
Description: Set whether selection is enabled.

Method set_selection_fill_enable: GTK2.Databox set_selection_fill_enable(int setting)
Description: Set whether the selection will be filled.

Method set_zoom_enable: GTK2.Databox set_zoom_enable(int setting)
Description: Set whether zoom is enabled.

Method set_zoom_limit: GTK2.Databox set_zoom_limit(float limit)
Description: Set the zoom limit. Default is 0.01, which is 100 times.

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

Inherit Window: inherit GTK2.Window : Window

Method add_action_widget: GTK2.Dialog add_action_widget(GTK2.Widget child, int response_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.Widget add_button(string button_text, int response_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 create: GTK2.Dialog GTK2.Dialog(mapping|void props)
Description: Create a new dialog widget.

Method get_action_area: GTK2.HbuttonBox get_action_area()
Description: The action area, this is where the buttons (ok, cancel etc) go

Method get_has_separator: int get_has_separator()
Description: Accessor for whether the dialog has a separator.

Method get_response_for_widget: int get_response_for_widget(GTK2.Widget widget)
Description: Gets the response id of a widget in the action area.

Method get_vbox: GTK2.Vbox get_vbox()
Description: The vertical box that should contain the contents of the dialog

Method response: GTK2.Dialog response(int response_id)
Description: Emits the "response" signal with the given response ID.

Method run: int run()
Description: Run the selected dialog.

Method set_default_response: GTK2.Dialog set_default_response(int response_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.Dialog set_has_separator(int setting)
Description: Sets whether this dialog has a separator above the buttons. True by default.

Method set_response_sensitive: GTK2.Dialog set_response_sensitive(int response_id, int setting)
Description: Calls GTK2.Widget->set_sensitive() for each widget in the dialog's action area with the given response_id.

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)

Inherit Widget: inherit GTK2.Widget : Widget

Method clear: GTK2.DrawingArea clear(int|void x, int|void y, int|void width, int|void height)
Description: Either clears the rectangle defined by the arguments, of if no arguments are specified, the whole drawable.

Method copy_area: GTK2.DrawingArea copy_area(GTK2.GdkGC gc, int xdest, int ydest, GTK2.Widget source, int xsource, int ysource, int width, int height)
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.DrawingArea GTK2.DrawingArea(mapping|void props)
Description: Create a new drawing area.

Method draw_arc: GTK2.DrawingArea draw_arc(GTK2.GdkGC gc, int filledp, int x1, int y1, int x2, int y2, int angle1, int angle2)
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.DrawingArea draw_bitmap(GTK2.GdkGC gc, GTK2.GdkBitmap bitmap, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
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.DrawingArea draw_image(GTK2.GdkGC gc, GTK2.GdkImage image, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
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.DrawingArea draw_line(GTK2.GdkGC gc, int x1, int y1, int x2, int y2)
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.DrawingArea draw_pixbuf(GTK2.GdkGC gc, GTK2.GdkPixbuf pixbuf, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
Description: Draw a GDK2(Pixbuf) in this drawable.

Method draw_pixmap: GTK2.DrawingArea draw_pixmap(GTK2.GdkGC gc, GTK2.GdkPixmap pixmap, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
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.DrawingArea draw_point(GTK2.GdkGC gc, int x, int y)
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.DrawingArea draw_rectangle(GTK2.GdkGC gc, int filledp, int x1, int y1, int x2, int y2)
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.DrawingArea draw_text(GTK2.GdkGC gc, int x, int y, string|PangoLayout text)
Description: y is used as the baseline for the text.

Method set_background: GTK2.DrawingArea set_background(GTK2.GdkColor to)
Description: Set the background color or image. The argument is either a GDK2.Pixmap or a GDK2.Color object.

Class GTK2.Editable

Description

Interface for text-editing widgets.

Signals: changed

delete_text

insert_text

Method copy_clipboard: GTK2.Editable copy_clipboard()
Description: Causes the characters in the current selection to be copied to the clipboard.

Method cut_clipboard: GTK2.Editable cut_clipboard()
Description: Causes the characters in the current selection to be copied to the clipboard and then deleted.

Method delete_selection: GTK2.Editable delete_selection()
Description: Deletes the current contents of the selection.

Method delete_text: GTK2.Editable delete_text(int start, int end)
Description: Deletes a sequence of characters.

Method get_chars: string get_chars(int start, int end)
Description: Retrieves a sequence of characters.

Method get_editable: int get_editable()
Description: Retrieves whether this widget is editable.

Method get_position: int get_position()
Description: Retrieves the current cursor position.

Method get_selection_bounds: array get_selection_bounds()
Description: Returns the selection bounds.

Method insert_text: int insert_text(string text, int length, int pos)
Description: Inserts text at a given position. Returns the position after the new text.

Method paste_clipboard: GTK2.Editable paste_clipboard()
Description: Causes the contents of the clipboard to be pasted into the given widget at the current cursor position.

Method select_region: GTK2.Editable select_region(int start, int end)
Description: Selects a region of text.

Method set_editable: GTK2.Editable set_editable(int setting)
Description: Determines if the user can edit the text or not.

Method set_position: GTK2.Editable set_position(int pos)
Description: Sets the cursor position.

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

Inherit CellEditable: inherit GTK2.CellEditable : CellEditable

Inherit Editable: inherit GTK2.Editable : Editable

Inherit Widget: inherit GTK2.Widget : Widget

Method create: GTK2.Entry GTK2.Entry(int|mapping maxlen_or_props)
Description: Create a new W(Entry) widget.

Method get_activates_default: int get_activates_default()
Description: Retrieves the value set by set_activates_default().

Method get_alignment: float get_alignment()
Description: Gets the value set by set_alignment().

Method get_completion: GTK2.EntryCompletion get_completion()
Description: Returns the completion object.

Method get_cursor_hadjustment: GTK2.Adjustment get_cursor_hadjustment()
Description: Retrieves the horizontal cursor adjustment

Method get_has_frame: int get_has_frame()
Description: Gets the value set by set_has_frame().

Method get_inner_border: array get_inner_border()
Description: This function returns the entry's inner-border property.

Method get_invisible_char: int get_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.Layout get_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

mapping get_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.

Method get_max_length: int get_max_length()
Description: Retrieves the maximum allowed length of the text.

Method get_text: string get_text()
Description: Returns the contents of the entry widget.

Method get_visibility: int get_visibility()
Description: Retrieves whether the text is visible.

Method get_width_chars: int get_width_chars()
Description: Gets the value set by set_width_chars().

Method layout_index_to_text_index: int layout_index_to_text_index(int layout_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.Entry set_activates_default(int setting)
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.Entry set_alignment(float align)
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.Entry set_completion(GTK2.EntryCompletion completion)
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.Entry set_cursor_hadjustment(GTK2.Adjustment adj)
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.Entry set_has_frame(int setting)
Description: Sets whether the entry has a beveled frame around it.

Method set_icon_from_pixbuf: GTK2.Entry set_icon_from_pixbuf(int icon_pos, GTK2.GdkPixbuf b)
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.Entry set_icon_from_stock(int icon_pos, string id)
Description: Set the icon using a stock icon. To remove the icon, use set_icon_from_pixbuf().

Method set_inner_border

GTK2.Entry set_inner_border(int left, int right, int top, int bottom)

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.Entry set_invisible_char(int ch)
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.Entry set_max_length(int maxlen)
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.Entry set_text(sprintf_format text, sprintf_args ... fmt)
Description: Set the text to the specified string, replacing the current contents.

Method set_visibility: GTK2.Entry set_visibility(int visiblep)
Description: 0 indicates invisible text (password boxes, as an example)

Method set_width_chars: GTK2.Entry set_width_chars(int n_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.

Method text_index_to_layout_index: int text_index_to_layout_index(int text_index)
Description: Opposite of layout_index_to_text_index().

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

Inherit CellLayout: inherit GTK2.CellLayout : CellLayout

Inherit Object: inherit G.Object : Object

Method complete: GTK2.EntryCompletion complete()
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.EntryCompletion GTK2.EntryCompletion(mapping|void props)
Description: Creates a new widget.

Method delete_action: GTK2.EntryCompletion delete_action(int index)
Description: Deletes the action at index.

Method get_entry: GTK2.Widget get_entry()
Description: Gets the entry this widget has been attached to.

Method get_inline_completion: int get_inline_completion()
Description: Returns whether the common prefix of the possible completions should be automatically inserted in the entry.

Method get_minimum_key_length: int get_minimum_key_length()
Description: Returns the minimum key length.

Method get_model: GTK2.TreeModel get_model()
Description: Returns the model being used as the data source.

Method get_popup_completion: int get_popup_completion()
Description: Returns whether completions should be presented in a popup window.

Method get_popup_set_width: int get_popup_set_width()
Description: Returns whether the completion popup window will be resized to the width of the entry.

Method get_popup_single_match: int get_popup_single_match()
Description: Returns whether the completion popup window will appear even if there is only a single match.

Method get_text_column: int get_text_column()
Description: Returns the column in the model to get strings from.

Method insert_action_markup: GTK2.EntryCompletion insert_action_markup(int index, string markup)
Description: Inserts an action in the action item list at position index with the specified markup.

Method insert_action_text: GTK2.EntryCompletion insert_action_text(int index, string text)
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 insert_prefix: GTK2.EntryCompletion insert_prefix()
Description: Requests a prefix insertion.

Method set_inline_completion: GTK2.EntryCompletion set_inline_completion(int inline_completion)
Description: Sets whether the common prefix of the possible completions should be automatically inserted in the entry.

Method set_inline_selection: GTK2.EntryCompletion set_inline_selection(int inline_selection)
Description: Sets whether it is possible to cycle through the possible completions inside the entry.

Method set_match_func: GTK2.EntryCompletion set_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.EntryCompletion set_minimum_key_length(int length)
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.EntryCompletion set_model(GTK2.TreeModel model)
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.EntryCompletion set_popup_completion(int setting)
Description: Sets whether the completions should be presented in a popup window.

Method set_popup_set_width: GTK2.EntryCompletion set_popup_set_width(int setting)
Description: Sets whether the completion popup window will be resized to be the same width as the entry.

Method set_popup_single_match: GTK2.EntryCompletion set_popup_single_match(int setting)
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.EntryCompletion set_text_column(int column)
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

Inherit Bin: inherit GTK2.Bin : Bin

Method create: GTK2.EventBox GTK2.EventBox(mapping|void props)
Description: Create a new event box widget

Method get_above_child: int get_above_child()
Description: Returns whether the event box window is above or below the windows of its child.

Method get_visible_window: int get_visible_window()
Description: Returns whether the event box has a visible window.

Method set_above_child

GTK2.EventBox set_above_child(int above_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.

Method set_visible_window: GTK2.EventBox set_visible_window(int visible_window)
Description: Sets whether the event box uses a visible or invisible child window. The default is to use visible windows.

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

Inherit Bin: inherit GTK2.Bin : Bin

Method create: GTK2.Expander GTK2.Expander(string|mapping label)
Description: Create a new GTK2.Expander. Set mnemonic to 1 for a mnemonic expander, otherwise omitting it creates a regular expander.

Method get_expanded: int get_expanded()
Description: Returns true if the child widget is revealed.

Method get_label: string get_label()
Description: Fetches the text from the label of the expander.

Method get_label_widget: GTK2.Widget get_label_widget()
Description: Retrieves the label widget for the frame.

Method get_spacing: int get_spacing()
Description: Returns the spacing.

Method get_use_markup: int get_use_markup()
Description: Returns whether the label's text is interpreted as marked up with the Pango text markup language.

Method get_use_underline: int get_use_underline()
Description: Returns whether an embedded underline in the label indicates a mnemonic.

Method set_expanded: GTK2.Expander set_expanded(int expanded)
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.Expander set_label(string label)
Description: Sets the text of the label of the expander.

Method set_label_widget: GTK2.Expander set_label_widget(GTK2.Widget label)
Description: Set the label widget for the expander. This is the widget that will appear embedded alongside the expander arrow.

Method set_spacing: GTK2.Expander set_spacing(int spacing)
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.Expander set_use_markup(int use_markup)
Description: Sets whether the text of the label contains markup in Pango's text markup language.

Method set_use_underline: GTK2.Expander set_use_underline(int use_underline)
Description: If true, an underline in the text of the label indicates the next character should be used for the mnemonic accelarator key.

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.FileChooser add_filter(GTK2.FileFilter filter)
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: int add_shortcut_folder(string folder)
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: int add_shortcut_folder_uri(string uri)
Description: Adds a folder URI to be displayed with the shortcut folders.

Method get_action: int get_action()
Description: Get the type of action the file chooser is performing.

Method get_current_folder: string get_current_folder()
Description: Gets the current folder as a local filename.

Method get_current_folder_uri: string get_current_folder_uri()
Description: Gets the current folder as a URI.

Method get_do_overwrite_confirmation: int get_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_extra_widget: GTK2.Widget get_extra_widget()
Description: Gets the extra widget.

Method get_filename: string get_filename()
Description: Gets the filename for the currently select file.

Method get_filenames: array get_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_filter: GTK2.FileFilter get_filter()
Description: Gets the current filter.

Method get_local_only: int get_local_only()
Description: Gets whether only local files can be selected in the file selector.

Method get_preview_filename: string get_preview_filename()
Description: Gets the filename that should be previewed in a custom preview widget.

Method get_preview_uri: string get_preview_uri()
Description: Gets the URI that should be previewed in a custom preview widget.

Method get_preview_widget: GTK2.Widget get_preview_widget()
Description: Gets the current preview widget.

Method get_preview_widget_active: int get_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: int get_select_multiple()
Description: Gets whether multiple files can be selected.

Method get_show_hidden: int get_show_hidden()
Description: Gets whether hidden files and folders are displayed.

Method get_uri: string get_uri()
Description: Gets the URI for the currently selected file.

Method get_uris: array get_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: int get_use_preview_label()
Description: Gets whether a stock label should be drawn with the name of the previewed file.

Method list_filters: array list_filters()
Description: Lists the current set of user-selectable filters.

Method list_shortcut_folder_uris: array list_shortcut_folder_uris()
Description: Queries the list of shortcut folders.

Method list_shortcut_folders: array list_shortcut_folders()
Description: Queries the list of shortcut folders.

Method remove_filter: GTK2.FileChooser remove_filter(GTK2.FileFilter filter)
Description: Removes filter from the list of filters that the user can select between.

Method remove_shortcut_folder: GTK2.FileChooser remove_shortcut_folder(string folder)
Description: Removes a folder from the list of shortcut folders.

Method remove_shortcut_folder_uri: GTK2.FileChooser remove_shortcut_folder_uri(string uri)
Description: Removes a folder URI.

Method select_all: GTK2.FileChooser select_all()
Description: Select all files.

Method select_filename: int select_filename(string filename)
Description: Selects a filename.

Method select_uri: int select_uri(string uri)
Description: Selects the file by uri.

Method set_action: GTK2.FileChooser set_action(int action)
Description: Sets type of action, from opening or saving a file, or opening or saving a folder. Options are: FILE_CHOOSER_ACTION_OPEN FILE_CHOOSER_ACTION_SAVE FILE_CHOOSER_ACTION_SELECT_FOLDER FILE_CHOOSER_ACTION_CREATE_FOLDER

Method set_current_folder: int set_current_folder(string folder)
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: int set_current_folder_uri(string uri)
Description: Sets the current folder from a URI.

Method set_current_name: GTK2.FileChooser set_current_name(string filename)
Description: Sets current name.

Method set_do_overwrite_confirmation

GTK2.FileChooser set_do_overwrite_confirmation(int setting)

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.FileChooser set_extra_widget(GTK2.Widget widget)
Description: Sets an application-supplied widget to provide extra options to the user.

Method set_filename: int set_filename(string filename)
Description: Sets filename as the current filename. Same as unselect_all() followed by select_filename();

Method set_filter: GTK2.FileChooser set_filter(GTK2.FileFilter filter)
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.FileChooser set_local_only(int local_only)
Description: Sets whether on local files can be selected.

Method set_preview_widget

GTK2.FileChooser set_preview_widget(GTK2.Widget widget)

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.FileChooser set_preview_widget_active(int setting)
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.FileChooser set_select_multiple(int select_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_OPEN or FILE_CHOOSER_ACTION_SAVE

Method set_show_hidden: GTK2.FileChooser set_show_hidden(int setting)
Description: Sets whether hidden files and folders are displayed.

Method set_uri: int set_uri(string uri)
Description: Sets the uri as the current file.

Method set_use_preview_label: GTK2.FileChooser set_use_preview_label(int setting)
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_all: GTK2.FileChooser unselect_all()
Description: Unselect all files.

Method unselect_filename: GTK2.FileChooser unselect_filename(string filename)
Description: Unselects a currently selected filename.

Method unselect_uri: GTK2.FileChooser unselect_uri(string uri)
Description: Unselect the uri.

Class GTK2.FileChooserButton

Description: Properties: GTK2.FileChooserDialog dialog int focus-on-click string title int width-chars

Inherit FileChooser: inherit GTK2.FileChooser : FileChooser

Inherit Hbox: inherit GTK2.Hbox : Hbox

Method create: GTK2.FileChooserButton GTK2.FileChooserButton(string|mapping title_or_props, int|void action)
Description: Create a new file-selecting button widget. action is one of FILE_CHOOSER_ACTION_CREATE_FOLDER, FILE_CHOOSER_ACTION_OPEN, FILE_CHOOSER_ACTION_SAVE and FILE_CHOOSER_ACTION_SELECT_FOLDER

Method get_focus_on_click: int get_focus_on_click()
Description: Returns whether the button grabs focus when it is clicked.

Method get_title: string get_title()
Description: Retrieves the title of the browse dialog.

Method get_width_chars: int get_width_chars()
Description: Retrieves the width in characters of the button widget's entry and/or label.

Method set_focus_on_click: GTK2.FileChooserButton set_focus_on_click(int focus)
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.FileChooserButton set_title(string title)
Description: Modifies the title of the browse dialog.

Method set_width_chars: GTK2.FileChooserButton set_width_chars(int n_chars)
Description: Sets the width (in characters) that the button will use.

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])}))

Inherit Dialog: inherit GTK2.Dialog : Dialog

Inherit FileChooser: inherit GTK2.FileChooser : FileChooser

Method create: GTK2.FileChooserDialog GTK2.FileChooserDialog(string title, GTK2.Window parent, int mode, array buttons)
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);

Inherit FileChooser: inherit GTK2.FileChooser : FileChooser

Inherit Vbox: inherit GTK2.Vbox : Vbox

Method create: GTK2.FileChooserWidget GTK2.FileChooserWidget(int|mapping action_or_props)
Description: Create a new file chooser widget. action is one of FILE_CHOOSER_ACTION_CREATE_FOLDER, FILE_CHOOSER_ACTION_OPEN, FILE_CHOOSER_ACTION_SAVE and FILE_CHOOSER_ACTION_SELECT_FOLDER

Class GTK2.FileFilter

Description: A filter for selecting a file subset.

Inherit Data: inherit GTK2.Data : Data

Method add_mime_type: GTK2.FileFilter add_mime_type(string mime_type)
Description: Adds a rule allowing a given mime type.

Method add_pattern: GTK2.FileFilter add_pattern(string pattern)
Description: Adds a rule allowing a shell style glob.

Method add_pixbuf_formats: GTK2.FileFilter add_pixbuf_formats()
Description: Adds a rule allowing image files in the formats support by W(Pixbuf).

Method create: GTK2.FileFilter GTK2.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("*").

Method get_name: string get_name()
Description: Gets the human-readable name for the filter.

Method set_name: GTK2.FileFilter set_name(string name)
Description: Sets the human-readable name of the filter; this is the string that will be displayed in the file selector user interface if there is a selectable list of filters.

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*.

GTK2.FileSelection("File selector")

Properties: string filename int select-multiple int show-fileops

Inherit Dialog: inherit GTK2.Dialog : Dialog

Method complete: GTK2.FileSelection complete(string pattern)
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.FileSelection GTK2.FileSelection(string|mapping title_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_action_area: GTK2.Vbox get_action_area()
Description: The action area

Method get_button_area: GTK2.HbuttonBox get_button_area()
Description: The button area

Method get_cancel_button: GTK2.Button get_cancel_button()
Description: The cancel button

Method get_filename: string get_filename()
Description: Return the filename.

Method get_fileop_c_dir: GTK2.Button get_fileop_c_dir()
Description: The create directory button in the file operation button group

Method get_fileop_del_file: GTK2.Button get_fileop_del_file()
Description: The delete file button in the file operation button group

Method get_fileop_dialog: GTK2.Dialog get_fileop_dialog()
Description: Dialog box for GTK2.FileSelection

Method get_fileop_ren_file: GTK2.Button get_fileop_ren_file()
Description: The rename file button in the file operation button group

Method get_help_button: GTK2.Button get_help_button()
Description: The help button

Method get_main_vbox: GTK2.Vbox get_main_vbox()
Description: The main vbox

Method get_ok_button: GTK2.Button get_ok_button()
Description: The ok button

Method get_select_multiple: int get_select_multiple()
Description: Gets whether the user is allowed to select multiple files.

Method get_selection: array get_selection()
Description: Retrieves the list of selections the user has made.

Method hide_fileop_buttons: GTK2.FileSelection hide_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.FileSelection set_filename(string fname)
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.FileSelection set_select_multiple(int select_multiple)
Description: Sets whether the user is allowed to select multiple files.

Method show_fileop_buttons: GTK2.FileSelection show_fileop_buttons()
Description: Shows the file operation buttons, if they have previously been hidden. The rest of the widgets in the dialog will be resized accordingly.

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

Inherit Container: inherit GTK2.Container : Container

Method create: GTK2.Fixed GTK2.Fixed(mapping|void props)
Description: Create a new fixed widget

Method get_children: array get_children()
Description: Get a list of the children and their x,y positions.

Method get_has_window: int get_has_window()
Description: Gets whether GTK2.Fixed has its own GDK2.Window.

Method move: GTK2.Fixed move(GTK2.Widget widget, int new_xpos, int new_ypos)
Description: Move the widget to new_xpos,new_ypos from it's old location.

Method put: GTK2.Fixed put(GTK2.Widget widget, int x, int y)
Description: Place the widget at xpos,ypos.

Method set_has_window: GTK2.Fixed set_has_window(int has_window)
Description: Sets wither a GTK2.Fixed widget is created with a separate GDK2.Window for the window or now.

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

Inherit Button: inherit GTK2.Button : Button

Method create: GTK2.FontButton GTK2.FontButton(string|mapping font_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: string get_font_name()
Description: Retrieves the name of the currently selected font.

Method get_show_size: int get_show_size()
Description: Returns whether the font size will be shown in the label.

Method get_show_style: int get_show_style()
Description: Returns whether the name of the font style will be shown in the label.

Method get_title: string get_title()
Description: Retrieves the title of the font selection dialog.

Method get_use_font: int get_use_font()
Description: Returns whether the selected font is used in the label.

Method get_use_size: int get_use_size()
Description: Returns whether the selected size is used in the label.

Method set_font_name: int set_font_name(string font)
Description: Sets or updates the currently-displayed font.

Method set_show_size: GTK2.FontButton set_show_size(int setting)
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.FontButton set_show_style(int setting)
Description: If setting is true, the font style will be displayed along with the name of the selected font.

Method set_title: GTK2.FontButton set_title(string title)
Description: Sets the title for the font selection dialog.

Method set_use_font: GTK2.FontButton set_use_font(int setting)
Description: If setting is true, the font name will be written using the selected font.

Method set_use_size: GTK2.FontButton set_use_size(int setting)
Description: If setting is true, the font name will be written using the selected size.

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

Inherit Vbox: inherit GTK2.Vbox : Vbox

Method create: GTK2.FontSelection GTK2.FontSelection(mapping|void props)
Description: Create a new GTK2.FontSelection widget.

Method get_font_name: string get_font_name()
Description: Gets the currently-selected font name.

Method get_preview_text: string get_preview_text()
Description: Gets the text displayed in the preview area.

Method set_font_name: GTK2.FontSelection set_font_name(string fontname)
Description: This sets the currently displayed font.

Method set_preview_text: GTK2.FontSelection set_preview_text(string text)
Description: Sets the text displayed in the preview area.

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")

Inherit Dialog: inherit GTK2.Dialog : Dialog

Method create: GTK2.FontSelectionDialog GTK2.FontSelectionDialog(string title)
Description: Create a new font selection dialog with the specified window title

Method get_apply_button: GTK2.Button get_apply_button()
Description: The apply button

Method get_cancel_button: GTK2.Button get_cancel_button()
Description: The cancel button

Method get_font_name: string get_font_name()
Description: Gets the currently-selected font name.

Method get_ok_button: GTK2.Button get_ok_button()
Description: The ok button

Method get_preview_text: string get_preview_text()
Description: Gets the text displayed in the preview area.

Method set_font_name: int set_font_name(string font)
Description: Sets the currently-selected font.

Method set_preview_text: GTK2.FontSelectionDialog set_preview_text(string text)
Description: Sets 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

Inherit Bin: inherit GTK2.Bin : Bin

Method create: GTK2.Frame GTK2.Frame(string|mapping label_or_props)
Description: Create a new W(Frame) widget.

Method get_label: string get_label()
Description: Return the text in the label widget.

Method get_label_align: array get_label_align()
Description: Retrieves the x and y alignment of the label.

Method get_label_widget: GTK2.Widget get_label_widget()
Description: Retrieves the label widget.

Method get_shadow_type: int get_shadow_type()
Description: Return the shadow type.

Method set_label: GTK2.Frame set_label(string|void label_text)
Description: Set the text of the label.

Method set_label_align: GTK2.Frame set_label_align(float xalign, float yalign)
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.Frame set_label_widget(GTK2.Widget label)
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.

Method set_shadow_type: GTK2.Frame set_shadow_type(int shadow_type)
Description: Set the shadow type for the Frame widget. The type is one of SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_NONE and SHADOW_OUT

Class GTK2.GdkBitmap

Description

A bitmap is a black and white pixmap. Most commonly used as masks for images, widgets and pixmaps.

NOIMG

Inherit Drawable: inherit GDK2.Drawable : Drawable

Method create: GTK2.GdkBitmap GTK2.GdkBitmap(int|Image.Image xsize_or_image, int|void ysize, string|void bitmap)
Description: Create a new GDK2.Bitmap object. Argument is either an Image.image object, or {xsisze,ysize,xbitmapdata}.

Method ref: GDK2.Bitmap ref()
Description: Add a reference

Method unref: GDK2.Bitmap unref()
Description: Remove a reference

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: protected GDK2.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 blue: int blue()
Description: Returns the blue color component.

Method create: GTK2.GdkColor GTK2.GdkColor(object|int color_or_r, int|void g, int|void b)
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 green: int green()
Description: Returns the green color component.

Method image_color_object: Image.Color.Color image_color_object()
Description: Return a Image.Color.Color instance. This gives better precision than the rgb function.

Method pixel: int pixel()
Description: Returns the pixel value of the color. See GDK2.Image->set_pixel.

Method red: int red()
Description: Returns the red color component.

Method rgb: array rgb()
Description: Returns the red green and blue color components as an array.

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: int alloc_color(GTK2.GdkColor color, int writeable, int best_match)
Description: Alocates a single color from a colormap.

Method alloc_colors: int alloc_colors(array colors, int writeable, int best_match)
Description: Allocates colors from a colormap.

Method create: GTK2.GdkColormap GTK2.GdkColormap(GTK2.GdkVisual visual, int|void allocate, int|void system)
Description: Creates a new colormap.

Method free_colors: GDK2.Colormap free_colors(array colors)
Description: Free colors.

Method get_screen: GTK2.GdkScreen get_screen()
Description: Returns the screen.

Method get_visual: GTK2.GdkVisual get_visual()
Description: Returns the visual.

Method query_color: GTK2.GdkColor query_color(int pixel)
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

Inherit Object: inherit G.Object : Object

Method beep: GDK2.Display beep()
Description: Emits a short beep on display

Method close: GDK2.Display close()
Description: Closes the connection to the window system for the given display, and cleans up associated resources.

Method create: GTK2.GdkDisplay GTK2.GdkDisplay()
Description: Get the default display.

Method flush: GDK2.Display flush()
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: int get_default_cursor_size()
Description: Returns the default size to use for cursors.

Method get_default_group: GTK2.GdkWindow get_default_group()
Description: Returns the default group leader window for all toplevel windows. This window is implicitly create by GDK.

Method get_default_screen: GTK2.GdkScreen get_default_screen()
Description: Get the default screen.

Method get_event: GTK2.GdkEvent get_event()
Description: Gets the next GDK2.Event to be processed, fetching events from the windowing system if necessary.

Method get_maximal_cursor_size: mapping get_maximal_cursor_size()
Description: Returns the maximal size to use for cursors.

Method get_n_screens: int get_n_screens()
Description: Gets the number of screens managed by the display.

Method get_name: string get_name()
Description: Gets the name of the display.

Method get_pointer: mapping get_pointer()
Description: Gets the current location of the pointer and the current modifier mask.

Method get_screen: GTK2.GdkScreen get_screen(int screen_num)
Description: Returns a screen for one of the screens.

Method get_window_at_pointer: mapping get_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 keyboard_ungrab: GDK2.Display keyboard_ungrab()
Description: Release any keyboard grab.

Method open: GDK2.Display open(string name)
Description: Opens a display.

Method peek_event: GTK2.GdkEvent peek_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 pointer_is_grabbed: int pointer_is_grabbed()
Description: Test if the pointer is grabbed.

Method pointer_ungrab: GDK2.Display pointer_ungrab()
Description: Release any pointer grab.

Method put_event: GDK2.Display put_event(GTK2.GdkEvent event)
Description: Appends a copy of the given event onto the front of the event queue.

Method request_selection_notification: int request_selection_notification(GDK2.Atom selection)
Description: Request GdkEventOwnerChange events for ownership changes of the selection named by the given atom.

Method set_double_click_distance: GDK2.Display set_double_click_distance(int distance)
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.Display set_double_click_time(int msec)
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.Display store_clipboard(GTK2.GdkWindow clipboard_window, array targets)
Description: Issues a request to the clipboard manager to store the clipboard data.

Method supports_clipboard_persistence: int supports_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: int supports_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: int supports_cursor_color()
Description: Returns true if multicolored cursors are supported. Otherwise, cursors have only a foreground and a background color.

Method supports_input_shapes: int supports_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: int supports_selection_notification()
Description: Returns whether GdkEventOwnerChange events will be sent when the owner of a selection changes.

Method supports_shapes: int supports_shapes()
Description: Returns true if GDK2.Window->shape_combine_mask() can be used to create shaped windows.

Method sync

GDK2.Display sync()

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.Display warp_pointer(GTK2.GdkScreen screen, int x, int y)
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_abort: GDK2.DragContext drag_abort(int time)
Description: Abort the drag

Method drag_drop: GDK2.DragContext drag_drop(int time)
Description: Drag drop.

Method drag_finish: GDK2.DragContext drag_finish(int success, int del)
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.DragContext drag_set_icon_default()
Description: Use the default drag icon associated with the source widget.

Method drag_set_icon_pixmap: GDK2.DragContext drag_set_icon_pixmap(GTK2.GdkPixmap p, GTK2.GdkBitmap b, int hot_x, int hot_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.DragContext drag_set_icon_widget(GTK2.Widget widget, int hot_x, int hot_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.DragContext drag_status(int action)
Description: Setting action to -1 means use the suggested action

Method drop_reply: GDK2.DragContext drop_reply(int ok)
Description: Drop reply.

Method get_action: int get_action()
Description: One of GDK_ACTION_ASK, GDK_ACTION_COPY, GDK_ACTION_DEFAULT, GDK_ACTION_LINK, GDK_ACTION_MOVE and GDK_ACTION_PRIVATE;

Method get_actions: int get_actions()
Description: A bitwise or of one or more of GDK_ACTION_ASK, GDK_ACTION_COPY, GDK_ACTION_DEFAULT, GDK_ACTION_LINK, GDK_ACTION_MOVE and GDK_ACTION_PRIVATE;

Method get_is_source: int get_is_source()
Description: Is this application the source?

Method get_protocol: int get_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_DROPFILES and GDK_DRAG_PROTO_XDND

Method get_source_widget: GTK2.Widget get_source_widget()
Description: Return the drag source widget.

Method get_start_time: int get_start_time()
Description: The start time of this drag, as a unix time_t (seconds since 0:00 1/1 1970)

Method get_suggested_action: int get_suggested_action()
Description: One of GDK_ACTION_ASK, GDK_ACTION_COPY, GDK_ACTION_DEFAULT, GDK_ACTION_LINK, GDK_ACTION_MOVE and GDK_ACTION_PRIVATE;

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)

Inherit Object: inherit G.Object : Object

Method clear: GDK2.Drawable clear(int|void x, int|void y, int|void width, int|void height)
Description: Either clears the rectangle defined by the arguments, of if no arguments are specified, the whole drawable.

Method copy_area: GDK2.Drawable copy_area(GTK2.GdkGC gc, int xdest, int ydest, GTK2.Widget source, int xsource, int ysource, int width, int height)
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.Drawable draw_arc(GTK2.GdkGC gc, int filledp, int x1, int y1, int x2, int y2, int angle1, int angle2)
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.Drawable draw_bitmap(GTK2.GdkGC gc, GTK2.GdkBitmap bitmap, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
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.Drawable draw_image(GTK2.GdkGC gc, GTK2.GdkImage image, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
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.Drawable draw_line(GTK2.GdkGC gc, int x1, int y1, int x2, int y2)
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.Drawable draw_pixbuf(GTK2.GdkGC gc, GTK2.GdkPixbuf pixbuf, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
Description: Draw a GDK2(Pixbuf) in this drawable.

Method draw_pixmap: GDK2.Drawable draw_pixmap(GTK2.GdkGC gc, GTK2.GdkPixmap pixmap, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
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.Drawable draw_point(GTK2.GdkGC gc, int x, int y)
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.Drawable draw_rectangle(GTK2.GdkGC gc, int filledp, int x1, int y1, int x2, int y2)
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.Drawable draw_text(GTK2.GdkGC gc, int x, int y, string|PangoLayout text)
Description: y is used as the baseline for the text.

Method get_geometry

mapping get_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.Drawable set_background(GTK2.GdkColor to)
Description: Set the background color or image. The argument is either a GDK2.Pixmap or a GDK2.Color object.

Method xid: int xid()
Description: Return the xwindow id.

Method xsize: int xsize()
Description: Returns the width of the drawable specified in pixels

Method ysize: int ysize()
Description: Returns the height of the drawable specified in pixels

Class GTK2.GdkEvent

Description: Gdk events.

Method _index: protected mixed _index(string ind)
Description: Return an index.

Method cast: (mapping)GTK2.GdkEvent()
Description: Cast to different types.

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

Inherit Object: inherit G.Object : Object

Method copy: GDK2.GC copy(GTK2.GdkGC source)
Description: Copy all attributes from the source GC

Method create: GTK2.GdkGC GTK2.GdkGC(GTK2.Widget context, mapping|void attributes)
Description: The argument is either a W(Widget) or a GDK2(Drawable) in which the gc will be valid.

Method get_screen: GTK2.GdkScreen get_screen()
Description: Gets the screen.

Method get_values: mapping get_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.GC set_background(GTK2.GdkColor color)
Description: Set the background to the specified GDK2.Color.

Method set_clip_mask: GDK2.GC set_clip_mask(GTK2.GdkBitmap mask)
Description: Set the clip mask to the specified GDK2.Bitmap

Method set_clip_origin: GDK2.GC set_clip_origin(int x, int y)
Description: Set the clip mask origin to the specified point.

Method set_clip_rectangle: GDK2.GC set_clip_rectangle(GTK2.GdkRectangle rect)
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.GC set_clip_region(GTK2.GdkRegion rect)
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.GC set_dashes(int offset, array dashes)
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.GC set_exposures(int exp)
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_fill: GDK2.GC set_fill(int fill)
Description: Set the fill method to fill.

Method set_foreground: GDK2.GC set_foreground(GTK2.GdkColor color)
Description: Set the foreground to the specified GDK2.Color.

Method set_function: GDK2.GC set_function(int fun)
Description: Set the function to the specified one. One of GDK2.Xor, GDK2.Invert and GDK2.Copy.

Method set_line_attributes: GDK2.GC set_line_attributes(int line_width, int line_style, int cap_style, int join_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.GC set_stipple(GTK2.GdkBitmap stipple)
Description: Set the background type. Fill must be GDK_STIPPLED or GDK_OPAQUE_STIPPLED.

Method set_subwindow: GDK2.GC set_subwindow(int draw_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.GC set_tile(GTK2.GdkPixmap tile)
Description: Set the background type. Fill must be GDK_TILED

Method set_ts_origin: GDK2.GC set_ts_origin(int x, int y)
Description: Set the origin when using tiles or stipples with the GC. The tile or stipple will be aligned such that the upper left corner of the tile or stipple will coincide with this point.

Class GTK2.GdkImage

Description

A gdk (low level) image. Mainly used for W(Image) objects.

NOIMG

Inherit Object: inherit G.Object : Object

Method create

GTK2.GdkImage GTK2.GdkImage(int|void fast_mode, Image.Image|void image)

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: int get_pixel(int x, int y)
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: string get_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.Image grab(GTK2.Widget widget, int xoffset, int yoffset, int width, int height)
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.Image set(Image.Image|int image_or_xsize, int|void ysize)
Description: Call this to set this image to either the contents of a pike image or a blank image of a specified size.

Method set_pixel: GDK2.Image set_pixel(int x, int y, int pixel)
Description: Set the pixel value of a pixel. Please note that the pixel argument is a X-pixel value, which is not easily gotten from a RGB color. See get_pixel and set.

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

Inherit Object: inherit G.Object : Object

Method add_alpha: GTK2.GdkPixbuf add_alpha(int substitute_color, int r, int g, int b)
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.GdkPixbuf composite(GTK2.GdkPixbuf dest, int dest_x, int dest_y, int dest_width, int dest_height, float offset_x, float offset_y, float scale_x, float scale_y, int type, int overall_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.GdkPixbuf composite_color(GTK2.GdkPixbuf dest, int dest_x, int dest_y, int dest_width, int dest_height, float offset_x, float offset_y, float scale_x, float scale_y, int type, int overall_alpha, int check_x, int check_y, int check_size, int color1, int color2)

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.GdkPixbuf composite_color_simple(int dest_width, int dest_height, int type, int overall_alpha, int check_size, int color1, int color2)
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: GTK2.GdkPixbuf copy()
Description: Creates a new GDK2.Pixbuf with a copy of this one.

Method copy_area: GTK2.GdkPixbuf copy_area(GTK2.GdkPixbuf dest, int src_x, int src_y, int widt, int height, int dest_x, int dest_y)
Description: Copies a rectangular area from this pixbuf to dest. Conversion of pixbuf formats is done automatically.

Method create

GTK2.GdkPixbuf GTK2.GdkPixbuf(string|mapping options)

Description

Create a GDK2.Pixbuf object.

Parameter options

options is either a filename or a mapping of options.

If it is a mapping, it may contain:

`"filename" : string`	Name of file to load.
`"xpm" : string`	If this key exists, then value is xpm data to create from.
`"data" : string`	If this key exists, then value is pixel data.
`"bits" : int`	Number of bits per sample.
`"width" : int`	Width of image.
`"height" : int`	Height of image.
`"alpha" : int`	True if alpha channel.
`"scale" : int`	True if use width and height as scale.
`"preserve" : int`	True if preserve aspect ratio.

The following is additional keys may exist if the member "data" exists:

`"colorspace" : int`	Colorspace, default `GDK2.COLORSPACE_RGB`, currently ignored.
`"rowstride" : int`	Distance in bytes between row starts.

Method flip: GTK2.GdkPixbuf flip(int horizontal)
Description: Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf.

Method get_bits_per_sample: int get_bits_per_sample()
Description: Queries the number of bits per color sample.

Method get_colorspace: int get_colorspace()
Description: Queries the color space.

Method get_has_alpha: int get_has_alpha()
Description: Queries whether a pixbuf has an alpha channel.

Method get_height: int get_height()
Description: Queries the height.

Method get_n_channels: int get_n_channels()
Description: Queries the number of channels.

Method get_option: string get_option(string key)
Description: Looks up key in the list of options that may have been attached to the pixbuf when it was loaded.

Method get_pixels: string get_pixels()
Description: Returns the pixel data as a string.

Method get_rowstride: int get_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 get_width: int get_width()
Description: Queries the width.

Method new_subpixbuf: GTK2.GdkPixbuf new_subpixbuf(int src_x, int src_y, int width, int height)
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 put_pixel: int put_pixel(int x, int y, int r, int g, int b)
Description: Set pixel to value.

Method render_threshold_alpha: GTK2.GdkBitmap render_threshold_alpha(int src_x, int src_y, int dest_c, int dest_y, int width, int height, int alpha_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.GdkPixbuf rotate_simple(int angle)
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_NONE and GDK_PIXBUF_ROTATE_UPSIDEDOWN, which are merely aliases.

Method saturate_and_pixelate: GDK2.Pixbuf saturate_and_pixelate(GTK2.GdkPixbuf dest, float saturation, int pixelate)
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.GdkPixbuf save(string filename, string type, mapping|void options)
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.GdkPixbuf scale(GTK2.GdkPixbuf dest, int dest_x, int dest_y, int dest_width, int dest_height, float offset_x, float offset_y, float scale_x, float scale_y, int type)
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.GdkPixbuf scale_simple(int dest_width, int dest_height, int|void interp_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().

Method set_alpha: int set_alpha(int x, int y, int setting)
Description: Set alpha value.

Method set_option: int set_option(string key, string value)
Description: Attaches a key/value pair as an option. If the key already exists in the list of options, the new value is ignored.

Class GTK2.GdkPixbufAnimation

Description: The GdkPixbufAnimation object. Holds animations, like gifs.

Inherit Object: inherit G.Object : Object

Method create: GTK2.GdkPixbufAnimation GTK2.GdkPixbufAnimation(string filename)
Description: Create a new PixbufAnimation.

Method get_height: int get_height()
Description: Returns the height of the bounding box.

Method get_iter

GTK2.GdkPixbufAnimationIter get_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.GdkPixbuf get_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.

Method get_width: int get_width()
Description: Returns the width of the bounding box.

Method is_static_image: int is_static_image()
Description: If the file turns out to be a plain, unanimated image, this function will return true. Use get_static_image() to retrieve the image.

Class GTK2.GdkPixbufAnimationIter

Description: An iterator for a PixbufAnimation.

Inherit Object: inherit G.Object : Object

Method advance: int advance()
Description: Possibly advance an animation to a new frame.

Method get_delay_time: int get_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.GdkPixbuf get_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.

Method on_currently_loading_frame: int on_currently_loading_frame()
Description: Used to determine how to respond to the area_updated signal on GDK2.PixbufLoader when loading an animation.

Class GTK2.GdkPixbufLoader

Description

Application-driven progressive image loading.

Signals: area_prepared

area_updated

closed

size_prepared

Inherit Object: inherit G.Object : Object

Method close: bool close()
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 create: GTK2.GdkPixbufLoader GTK2.GdkPixbufLoader()

Method get_animation: GTK2.GdkPixbufAnimation get_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.PixbufLoader set_size(int width, int height)
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)

Method write: bool write(string|Stdio.Buffer data)
Description: This will cause a pixbuf loader to parse the more data for an image. It will return TRUE if the data was loaded successfully, and FALSE if an error occurred. In the latter case, the loader will be closed, and will not accept further writes.

Class GTK2.GdkPixbufSimpleAnim

Description: Properties: bool loop

Inherit PixbufAnimation: inherit GDK2.PixbufAnimation : PixbufAnimation

Method add_frame: GDK2.PixbufSimpleAnim add_frame(GTK2.GdkPixbuf frame)
Description: Adds a new frame to animation . The pixbuf must have the dimensions specified when the animation was constructed.

Method get_loop: bool get_loop()
Description: Returns if animation will loop indefinitely when it reaches the end.

Method set_loop: GDK2.PixbufSimpleAnim set_loop(bool loop)
Description: Sets whether animation should 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

Inherit Drawable: inherit GDK2.Drawable : Drawable

Method create: GTK2.GdkPixmap GTK2.GdkPixmap(int|object image)
Description: Create a new GDK2.Pixmap object. Argument is a GDK2.Image object or a Image.Image object

Method ref: GDK2.Pixmap ref()
Description: Ref this object.

Method set: GDK2.Pixmap set(GTK2.GdkImage image)
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.

Method unref: GDK2.Pixmap unref()
Description: Unref this object.

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.GdkRectangle GTK2.GdkRectangle(int x, int y, int width, int height)

Description

Create a new rectangle

NOIMG

Method set: GDK2.Rectangle set(int x, int y, int width, int height)
Description: Set the upper left corner and the size of the rectangle.

Class GTK2.GdkRegion

Description: Region information.

Method create

GTK2.GdkRegion GTK2.GdkRegion()

Description

Create a new (empty) region

NOIMG

Method equal: int equal(GTK2.GdkRegion victim)
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.GdkRegion intersect(GTK2.GdkRegion victim)
Description: Computes the intersection of the given region and the region. Also available as region & region

Method offset: GDK2.Region offset(int dx, int dy)
Description: Offset(move) the region by dx,dy pixels.

Method point_in: int point_in(int x, int y)
Description: Returns true if the given point resides in the given region

Method rect_in: int rect_in(GTK2.GdkRectangle r)
Description: Returns true if the given rectangle resides inside the given region

Method shrink: GDK2.Region shrink(int dx, int dy)
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.GdkRegion subtract(GTK2.GdkRegion victim)
Description: Computes the difference of the given region and the region. Also available as region - region

Method union: GTK2.GdkRegion union(GTK2.GdkRegion victim)
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.

Method xor: GTK2.GdkRegion xor(GTK2.GdkRegion victim)
Description: Computes the exlusive or of the given region and the region. Also available as region ^ region

Class GTK2.GdkScreen

Description

Properties: font-options float resolution

Signals: composited_changed

size_changed

Inherit Object: inherit G.Object : Object

Method create: GTK2.GdkScreen GTK2.GdkScreen()
Description: Gets the default screen.

Method get_active_window: GTK2.GdkWindow get_active_window()
Description: Returns the currently active window.

Method get_default_colormap: GTK2.GdkColormap get_default_colormap()
Description: Gets the default colormap.

Method get_display: GTK2.GdkDisplay get_display()
Description: Gets the display to which this screen belongs.

Method get_height: int get_height()
Description: Gets the height in pixels.

Method get_height_mm: int get_height_mm()
Description: Returns the height in millimeters.

Method get_monitor_at_point: int get_monitor_at_point(int x, int y)
Description: Returns the monitor number in which x,y is located.

Method get_monitor_at_window: int get_monitor_at_window(GTK2.GdkWindow window)
Description: Returns the number of the monitor in which the largest area of the bounding rectangle of window resides.

Method get_monitor_geometry: GTK2.GdkRectangle get_monitor_geometry(int num)
Description: Retrieves the GDK2.Rectangle representing the size and position of the individual monitor within the entire screen area.

Method get_n_monitors: int get_n_monitors()
Description: Returns the number of monitors which this screen consists of.

Method get_number: int get_number()
Description: Gets the index of this screen among the screens in the display to which it belongs.

Method get_resolution: float get_resolution()
Description: Gets the resolution for font handling.

Method get_rgb_colormap: GTK2.GdkColormap get_rgb_colormap()
Description: Gets the preferred colormap for rendering image data.

Method get_rgb_visual: GTK2.GdkVisual get_rgb_visual()
Description: Get a "preferred visual" chosen by GdkRGB for rendering image data.

Method get_rgba_colormap: GTK2.GdkColormap get_rgba_colormap()
Description: Gets a colormap to use for creating windows or pixmaps with an alpha channel.

Method get_rgba_visual: GTK2.GdkVisual get_rgba_visual()
Description: Gets a visual to use for creating windows or pixmaps with an alpha channel.

Method get_root_window: GTK2.GdkWindow get_root_window()
Description: Gets the root window.

Method get_system_colormap: GTK2.GdkColormap get_system_colormap()
Description: Gets the system default colormap.

Method get_system_visual: GTK2.GdkVisual get_system_visual()
Description: Get the default system visual.

Method get_toplevel_windows: array get_toplevel_windows()
Description: Returns a list of all toplevel windows known to GDK on the screen.

Method get_width: int get_width()
Description: Gets the width of the screen in pixels.

Method get_width_mm: int get_width_mm()
Description: Gets the width in millimeters.

Method is_composited: int is_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: array list_visuals(int|void def)
Description: List the available visuals. If def is true, return the available visuals for the default screen.

Method make_display_name: string make_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.Screen set_default_colormap(GTK2.GdkColormap colormap)
Description: Sets the default colormap.

Method set_resolution: GDK2.Screen set_resolution(float dpi)
Description: Sets the resolution for font handling.

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.

Inherit Object: inherit G.Object : Object

Method create

GTK2.GdkVisual GTK2.GdkVisual(int|void best, int|void depth, int|void type)

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_GRAY`	Each pixel value indexes a grayscale value directly.
`GDK_VISUAL_GRAYSCALE`	Each 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_COLOR`	Each pixel value is an index into a predefined, unmodifiable color map that maps pixel values into RGB values.
`GDK_VISUAL_PSEUDO_COLOR`	Each 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_COLOR`	Each 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_COLOR`	Each 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.

Method get_screen: GTK2.GdkScreen get_screen()
Description: Gets the screen to which this visual belongs.

Class GTK2.GdkWindow

Description

a GDK2.Window object.

NOIMG

Inherit Drawable: inherit GDK2.Drawable : Drawable

Method change_property: GDK2.Window change_property(GDK2.Atom property, GDK2.Atom type, int mode, string data)
Description: mode is one of GDK_PROP_MODE_APPEND, GDK_PROP_MODE_PREPEND and GDK_PROP_MODE_REPLACE

Method children: array children()
Description: Returns an array of GDK2.Window objects.

Method create: GTK2.GdkWindow GTK2.GdkWindow(GTK2.GdkWindow parent, mapping|void attributes)
Description: Not for non-experts. I promise.

Method delete_property: GDK2.Window delete_property(GDK2.Atom a)
Description: Delete a property.

Method get_geometry: mapping get_geometry()
Description: Returns ([ "x":xpos, "y":ypos, "width":width, "height":height, "depth":bits_per_pixel ])

Method get_property

mapping get_property(GDK2.Atom atom, int|void offset, int|void delete_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.Window grab_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_viewable: int is_viewable()
Description: Return 1 if the window is mapped.

Method is_visible: int is_visible()
Description: Return 1 if the window, or a part of the window, is visible right now.

Method lower: GDK2.Window lower()
Description: Lower this window if the window manager allows that.

Method move_resize: GDK2.Window move_resize(int x, int y, int w, int h)
Description: Move and resize the window in one call.

Method raise: GDK2.Window raise()
Description: Raise this window if the window manager allows that.

Method set_background: GDK2.Window set_background(GTK2.GdkColor to)
Description: Set the background color or image. The argument is either a GDK2.Pixmap or a GDK2.Color object.

Method set_bitmap_cursor: GDK2.Window set_bitmap_cursor(GTK2.GdkBitmap image, GTK2.GdkBitmap mask, GTK2.GdkColor fg, GTK2.GdkColor bg, int xhot, int yhot)
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.Window set_cursor(int new_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.Window set_events(int events)
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.Window set_icon(GTK2.GdkPixmap pixmap, GTK2.GdkBitmap mask, GTK2.GdkWindow window)
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.Window set_icon_name(string name)
Description: Set the icon name to the specified string.

Method shape_combine_mask: GDK2.Window shape_combine_mask(GTK2.GdkBitmap mask, int xoffset, int yoffset)
Description: Set the shape of the widget, or, rather, it's window, to that of the supplied bitmap.

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_Atom GTK2.Gdk_Atom(string atom_name, int|void only_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).

Method get_name: string get_name()
Description: Returns the name of the atom.

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.

Inherit Object: inherit G.Object : Object

Method create: GTK2.GladeXML GTK2.GladeXML(string filename_or_buffer, int|void size, string|void root, string|void domain)
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: int get_signal_id(GTK2.Widget widget)
Description: Used to get the signal id attached to a GladeXML object.

Method get_widget: GTK2.Widget get_widget(string name)
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: string get_widget_name(GTK2.Widget widget)
Description: Used to get the name of a widget that was generated by a GladeXML object.

Method get_widget_prefix: array get_widget_prefix(string name)
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.GladeXML signal_autoconnect(mapping callbacks, mixed data)
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

Inherit Window: inherit GTK2.Window : Window

Method add_docked

Gnome2.App add_docked(GTK2.Widget widget, string name, int behavior, int placement, int band_num, int band_position, int|void offset)

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_VERTICAL and GNOME_DOCK_ITEM_BEH_NORMAL placement : 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.App add_toolbar(GTK2.Toolbar toolbar, string name, int behavior, int placement, int band_num, int band_position, int|void offset)

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_VERTICAL and GNOME_DOCK_ITEM_BEH_NORMAL placement : 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.Gnome2App GTK2.Gnome2App(string appname, string|void title)
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.App enable_layout_config(int enable)
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.App set_contents(GTK2.Widget contents)
Description: Sets the status bar of the application window.

Method set_menus: Gnome2.App set_menus(GTK2.MenuBar menu_bar)
Description: Sets the menu bar of the application window.

Method set_statusbar: Gnome2.App set_statusbar(GTK2.Widget statusbar)
Description: Sets the status bar of the application window.

Method set_statusbar_custom: Gnome2.App set_statusbar_custom(GTK2.Widget container, GTK2.Widget statusbar)
Description: Sets the status bar of the application window, but use container as its container.

Method set_toolbar: Gnome2.App set_toolbar(GTK2.Toolbar toolbar)
Description: Sets the main toolbar of the application window.

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

Inherit Hbox: inherit GTK2.Hbox : Hbox

Method clear_prompt: Gnome2.Appbar clear_prompt()
Description: Remove any prompt.

Method clear_stack: Gnome2.Appbar clear_stack()
Description: Remove all status messages from appbar, and display default status message (if present).

Method create

GTK2.Gnome2Appbar GTK2.Gnome2Appbar(int has_progress, int has_status, int interactivity)

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.ProgressBar get_progress()
Description: Returns GTK2.ProgressBar widget pointer, so that the progress bar may be manipulated further.

Method get_response: string get_response()
Description: Get the response to the prompt, if any.

Method get_status: GTK2.Widget get_status()
Description: Retrieves the statusbar widget.

Method pop: Gnome2.Appbar pop()
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.Appbar push(string what)
Description: Push a new status message onto the status bar stack, and display it.

Method refresh: Gnome2.Appbar refresh()
Description: Reflect the current state of stack/default. Useful to force a set_status to disappear.

Method set_default: Gnome2.Appbar set_default(string default_status)
Description: What to show when showing nothing else; defaults to "".

Method set_progress_percentage: Gnome2.Appbar set_progress_percentage(float percentage)
Description: Sets progress bar to the given percentage.

Method set_prompt: Gnome2.Appbar set_prompt(string prompt, int modal)
Description: Put a prompt in the appbar and wait for a response. When the user responds or cancels, a "user-response" signal is emitted.

Method set_status: Gnome2.Appbar set_status(string status)
Description: Sets the status label without changing widget state; next set or push will destroy this permanently.

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

Inherit Layout: inherit GTK2.Layout : Layout

Method c2w: array c2w(int cx, int cy)
Description: Converts canvas pixel coordinates to world coordinates.

Method create: GTK2.Gnome2Canvas GTK2.Gnome2Canvas(int|void anti_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: int get_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.GdkColor get_color(string|void spec)
Description: Allocates a color based on the specified X color specification. An omitted or empty string is considered transparent.

Method get_color_pixel: int get_color_pixel(int rgba)
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: int get_dither()
Description: Returns the type of dithering used to render an antialiased canvas.

Method get_item_at: GTK2.Gnome2CanvasItem get_item_at(float x, float y)
Description: Looks for the item that is under the specified position, which must be specified in world coordinates.

Method get_scroll_offsets: array get_scroll_offsets()
Description: Queries the scrolling offsets of a canvas. The values are returned in canvas pixel units.

Method get_scroll_region: mapping get_scroll_region()
Description: Queries the scrolling region of a canvas.

Method root: GTK2.Gnome2CanvasGroup root()
Description: Queries the root group.

Method scroll_to: Gnome2.Canvas scroll_to(int cx, int cy)
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.Canvas set_center_scroll_region(int setting)
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.Canvas set_dither(int dither)
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.Canvas set_pixels_per_unit(float n)

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.Canvas set_scroll_region(float x1, float y1, float x2, float y2)
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: array w2c(float wx, float wy)
Description: Converts world coordinates into canvas pixel coordinates.

Method w2c_affine: array w2c_affine()
Description: Gets the affine transform that converts from world coordinates to canvas pixel coordinates.

Method w2c_d: array w2c_d(float wx, float wy)
Description: Converts world coordinates into canvas pixel coordinates. This version returns coordinates in floating point coordinates, for greater precision.

Method window_to_world: array window_to_world(float winx, float winy)
Description: Converts window-relative coordinates into world coordinates. You can use this when you need to convert mouse coordinates into world coordinates, for example.

Method world_to_window: array world_to_window(float worldx, float worldy)
Description: Converts world coordinates into window-relative coordinates.

Class GTK2.Gnome2CanvasBpath

Inherit CanvasShape: inherit Gnome2.CanvasShape : CanvasShape

Class GTK2.Gnome2CanvasClipgroup

Description: Properties: string path int wind

Inherit CanvasGroup: inherit Gnome2.CanvasGroup : CanvasGroup

Class GTK2.Gnome2CanvasEllipse

Inherit CanvasRE: inherit Gnome2.CanvasRE : CanvasRE

Class GTK2.Gnome2CanvasGroup

Inherit CanvasItem: inherit Gnome2.CanvasItem : CanvasItem

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

Inherit Object: inherit GTK2.Object : Object

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

Inherit CanvasItem: inherit Gnome2.CanvasItem : CanvasItem

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

Inherit CanvasItem: inherit Gnome2.CanvasItem : CanvasItem

Class GTK2.Gnome2CanvasRE

Description: Properties: float x1 float x2 float y1 float y2

Inherit CanvasShape: inherit Gnome2.CanvasShape : CanvasShape

Class GTK2.Gnome2CanvasRect

Inherit CanvasRE: inherit Gnome2.CanvasRE : CanvasRE

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

Inherit CanvasItem: inherit Gnome2.CanvasItem : CanvasItem

Method get_buffer: GTK2.TextBuffer get_buffer()
Description: Get the text buffer.

Method set_buffer: Gnome2.CanvasRichText set_buffer(GTK2.TextBuffer buffer)
Description: Set the text buffer.

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

Inherit CanvasItem: inherit Gnome2.CanvasItem : CanvasItem

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

Inherit CanvasItem: inherit Gnome2.CanvasItem : CanvasItem

Class GTK2.Gnome2CanvasWidget

Description: Properties: int anchor float height int size-pixels GTK2.Widget widget float width float x float y

Inherit CanvasItem: inherit Gnome2.CanvasItem : CanvasItem

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

Inherit Object: inherit GTK2.Object : Object

Method create: GTK2.Gnome2Client GTK2.Gnome2Client()
Description: Gets the master session management client.

Method disconnect: Gnome2.Client disconnect()
Description: Disconnect the client from the session manager.

Method flush: Gnome2.Client flush()
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: string get_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: string get_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_flags: int get_flags()
Description: Determine the client's status with the session manager.

Method get_global_config_prefix

string get_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_id: string get_id()
Description: Returns the session management ID.

Method get_previous_id: string get_previous_id()
Description: Get the session management ID from the previous session.

Method request_phase_2: Gnome2.Client request_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.Client request_save(int save_style, int shutdown, int interact_style, int fast, int global)

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_GLOBAL and GNOME_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_ERRORS and GNOME_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.Client save_any_dialog(GTK2.Dialog dialog)
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.Client save_error_dialog(GTK2.Dialog dialog)
Description: May be called during a "save-yourself" handler when an error has occurred during the save.

Method set_clone_command: Gnome2.Client set_clone_command(array argv)
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.Client set_current_directory(string dir)
Description: Set the directory to be in when running shutdown, discard, restart, etc. commands.

Method set_discard_command: Gnome2.Client set_discard_command(array argv)
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.Client set_environment(string name, string value)
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.Client set_global_config_prefix(string prefix)
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.Client set_priority(int priority)
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.Client set_resign_command(array argv)

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.Client set_restart_command(array argv)
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.Client set_restart_style(int style)
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_IMMEDIATELY and GNOME_RESTART_NEVER

Method set_shutdown_command

Gnome2.Client set_shutdown_command(array argv)

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

Inherit Hbox: inherit GTK2.Hbox : Hbox

Method create: GTK2.Gnome2DateEdit GTK2.Gnome2DateEdit(int the_time, int show_time, int use_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_flags: int get_flags()
Description: Get the flags.

Method get_initial_time: int get_initial_time()
Description: Queries the initial time that was set using set_time() or during creation.

Method get_time: int get_time()
Description: Return the time entered in the widget.

Method set_flags: Gnome2.DateEdit set_flags(int flags)
Description: Bitwise or of GNOME_DATE_EDIT_24_HR, GNOME_DATE_EDIT_SHOW_TIME and GNOME_DATE_EDIT_WEEK_STARTS_ON_MONDAY.

Method set_popup_range: Gnome2.DateEdit set_popup_range(int low_hour, int up_hour)
Description: Sets the range of times that will be provide by the time popup selectors.

Method set_time: Gnome2.DateEdit set_time(int the_time)
Description: Changes the displayed date and time in the GnomeDateEdit widget to be the one represented by the_time.

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

Inherit Container: inherit GTK2.Container : Container

Method append_page: Gnome2.Druid append_page(GTK2.Gnome2DruidPage page)
Description: This will append a GnomeDruidPage into the internal list of pages that the druid has.

Method create: GTK2.Gnome2Druid GTK2.Gnome2Druid()
Description: Create a new druid

Method insert_page: Gnome2.Druid insert_page(GTK2.Gnome2DruidPage back_page, GTK2.Gnome2DruidPage page)
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.Druid prepend_page(GTK2.Gnome2DruidPage page)
Description: This will prepend a GnomeDruidPage into the internal list of pages that the druid has.

Method set_buttons_sensitive: Gnome2.Druid set_buttons_sensitive(int back_sensitive, int next_sensitive, int cancel_sensitive, int help_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.Druid set_page(GTK2.Gnome2DruidPage page)
Description: This will make page the currently showing page in the druid. page must already be in the druid.

Method set_show_finish: Gnome2.Druid set_show_finish(int show_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".

Method set_show_help: Gnome2.Druid set_show_help(int show_help)
Description: Sets the "Help" button on the druid to be visible in the lower left corner of the widget, if show_help is true.

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

Inherit Bin: inherit GTK2.Bin : Bin

Method back: int back()
Description: This will emit the "back" signal for that particular page.

Method cancel: int cancel()
Description: This will emit the "cancel" signal for that particular page.

Method create: GTK2.Gnome2DruidPage GTK2.Gnome2DruidPage()
Description: Creates a new Gnome2.DruidPage.

Method finish: Gnome2.DruidPage finish()
Description: This emits the "finish" signal for the page.

Method next: int next()
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.

Method prepare: Gnome2.DruidPage prepare()
Description: This emits the "prepare" signal for the page. It is called by gnome-druid exclusively. This function is called immediately prior to a druid page being show so that it can "prepare" for display.

Class GTK2.Gnome2DruidPageEdge

Inherit DruidPage: inherit Gnome2.DruidPage : DruidPage

Method create: GTK2.Gnome2DruidPageEdge GTK2.Gnome2DruidPageEdge(int position, int|void anti_alias)
Description: Create a new Gnome2.DruidPageEdge, with optional anti-aliasing.

Method set_bg_color: Gnome2.DruidPageEdge set_bg_color(GTK2.GdkColor color)
Description: This will set the background color.

Method set_logo: Gnome2.DruidPageEdge set_logo(GTK2.GdkPixbuf logo)
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.DruidPageEdge set_logo_bg_color(GTK2.GdkColor color)
Description: Sets the color behind the druid page's logo.

Method set_text: Gnome2.DruidPageEdge set_text(sprintf_format text, sprintf_args ... fmt)
Description: Sets the contents of the text portion.

Method set_text_color: Gnome2.DruidPageEdge set_text_color(GTK2.GdkColor color)
Description: Sets the color of the text in the body of the page.

Method set_textbox_color: Gnome2.DruidPageEdge set_textbox_color(GTK2.GdkColor color)
Description: Sets the color of the background in the main text area of the page.

Method set_title: Gnome2.DruidPageEdge set_title(string title)
Description: Sets the contents of the page's title text.

Method set_title_color: Gnome2.DruidPageEdge set_title_color(GTK2.GdkColor color)
Description: Sets the color of the title text.

Method set_top_watermark: Gnome2.DruidPageEdge set_top_watermark(GTK2.GdkPixbuf watermark)
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 set_watermark: Gnome2.DruidPageEdge set_watermark(GTK2.GdkPixbuf watermark)
Description: Sets a GDK2.Pixbuf as the watermark on the left strip on the druid. If watermark is omitted, it is reset to the normal color.

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

Inherit DruidPage: inherit Gnome2.DruidPage : DruidPage

Method append_item

Gnome2.DruidPageStandard append_item(string question, GTK2.Widget item, string additional_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.Gnome2DruidPageStandard GTK2.Gnome2DruidPageStandard(string|void title, GTK2.GdkPixbuf logo, GTK2.GdkPixbuf top_watermark)
Description: Construct a new Gnome2.DruidPageStandard.

Method set_background: Gnome2.DruidPageStandard set_background(GTK2.GdkColor color)
Description: Sets the background color of the top section.

Method set_contents_background: Gnome2.DruidPageStandard set_contents_background(GTK2.GdkColor color)
Description: Sets the color of the main contents section's background.

Method set_logo: Gnome2.DruidPageStandard set_logo(GTK2.GdkPixbuf logo)
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.DruidPageStandard set_logo_background(GTK2.GdkColor color)
Description: Sets the background color of the logo.

Method set_title: Gnome2.DruidPageStandard set_title(string title)
Description: Sets the title.

Method set_title_foreground: Gnome2.DruidPageStandard set_title_foreground(GTK2.GdkColor color)
Description: Sets the title text to the specified color.

Method set_top_watermark: Gnome2.DruidPageStandard set_top_watermark(GTK2.GdkPixbuf watermark)
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.

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

Inherit Button: inherit GTK2.Button : Button

Method create: GTK2.Gnome2Href GTK2.Gnome2Href(string url, string|void label)
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: string get_text()
Description: Returns the contents of the label widget used to display the link text.

Method get_url: string get_url()
Description: Return the url

Method set_text: Gnome2.Href set_text(sprintf_format text, sprintf_args ... fmt)
Description: Sets the internal label widget text (used to display a URL's link text) to the given value.

Method set_url: Gnome2.Href set_url(string url)
Description: Sets the internal URL

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

Inherit Vbox: inherit GTK2.Vbox : Vbox

Method create: GTK2.Gnome2IconEntry GTK2.Gnome2IconEntry(string history_id, string title)
Description: Creates a new icon entry widget

Method get_filename: string get_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.Widget pick_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.IconEntry set_browse_dialog_title(string title)
Description: Set the title of the browse dialog.

Method set_filename: int set_filename(string filename)
Description: Sets the icon of Gnome2.IconEntry to be the one pointed to by filename.

Method set_history_id: Gnome2.IconEntry set_history_id(string history_id)
Description: Set the history_id of the entry in the browse dialog and reload the history.

Method set_pixmap_subdir: Gnome2.IconEntry set_pixmap_subdir(string subdir)
Description: Sets the subdirectory below gnome's default pixmap directory to use as the default path for the file entry.

Class GTK2.Gnome2IconSelection

Description: An icon listing/chooser display.

Inherit Vbox: inherit GTK2.Vbox : Vbox

Method add_defaults: Gnome2.IconSelection add_defaults()
Description: Adds the default pixmap directory into the selection widget.

Method add_directory: Gnome2.IconSelection add_directory(string dir)
Description: Adds the icons from the directory dir to the selection widget.

Method clear: Gnome2.IconSelection clear(int|void not_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.Gnome2IconSelection GTK2.Gnome2IconSelection()
Description: Creates a new icon selection widget, it uses a W(GnomeIconList) for the listing of icons

Method get_box: GTK2.Widget get_box()
Description: Gets the W(Vbox) widget.

Method get_icon: string get_icon(int full_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.IconSelection select_icon(string filename)
Description: Selects the icon filename. This icon must have already been added and shown

Method show_icons: Gnome2.IconSelection show_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.

Method stop_loading: Gnome2.IconSelection stop_loading()
Description: Stop the loading of images when we are in the loop in show_icons.

Class GTK2.HScrollbar

Description: A horizontal scrollbar. General documentation: See W(Scrollbar) GTK2.HScrollbar(GTK2.Adjustment())->set_size_request(300,15)

Inherit Scrollbar: inherit GTK2.Scrollbar : Scrollbar

Method create: GTK2.HScrollbar GTK2.HScrollbar(GTK2.Adjustment adjustment_or_props)
Description: Used to create a new hscrollbar widget.

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

Inherit Bin: inherit GTK2.Bin : Bin

Method create: GTK2.HandleBox GTK2.HandleBox(mapping|void props)
Description: Create a new handle box widget.

Method get_handle_position: int get_handle_position()
Description: Get the handle position.

Method get_shadow_type: int get_shadow_type()
Description: Get the shadow type.

Method get_snap_edge: int get_snap_edge()
Description: Get the snap edge.

Method set_handle_position: GTK2.HandleBox set_handle_position(int pos)
Description: The position of the handle. One of POS_BOTTOM, POS_LEFT, POS_RIGHT and POS_TOP

Method set_shadow_type: GTK2.HandleBox set_shadow_type(int shadow_type)
Description: One of SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_NONE and SHADOW_OUT

Method set_snap_edge: GTK2.HandleBox set_snap_edge(int pos)
Description: The edge to snap to. One of POS_BOTTOM, POS_LEFT, POS_RIGHT and POS_TOP, or -1 for unset.

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"))

Inherit Box: inherit GTK2.Box : Box

Method create: GTK2.Hbox GTK2.Hbox(int|mapping uniformp_or_props, int|void hpadding)
Description: Create a new horizontal box widget. If all_same_size is true, all widgets will have exactly the same size. hpadding is added to the left and right of the children.

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)

Inherit ButtonBox: inherit GTK2.ButtonBox : ButtonBox

Method create: GTK2.HbuttonBox GTK2.HbuttonBox(mapping|void props)
Description: Create a new horizontal button box

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)

Inherit Paned: inherit GTK2.Paned : Paned

Method create: GTK2.Hpaned GTK2.Hpaned(mapping|void props)
Description: Create a new W(Hpaned) widget.

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)

Inherit Scale: inherit GTK2.Scale : Scale

Method create: GTK2.Hscale GTK2.Hscale(GTK2.Adjustment settings_or_min_props, float|void max, float|void step)
Description: Used to create a new hscale widget. Either pass an W(Adjustment), or three floats representing min, max, and step values.

Class GTK2.Hseparator

Description: Simply creates a horizontal separator. No bells or whistles. GTK2.Hseparator()->set_size_request(300,3)

Inherit Separator: inherit GTK2.Separator : Separator

Method create: GTK2.Hseparator GTK2.Hseparator(mapping|void props)
Description: Used to create a new hseparator widget.

Class GTK2.IconFactory

Description: Icon factory, for holding icon sets.

Inherit Object: inherit G.Object : Object

Method add: GTK2.IconFactory add(string stock_id, GTK2.IconSet icon_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.IconFactory add_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.IconFactory GTK2.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.IconSet lookup(string stock_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.IconSet lookup_default(string stock_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.

Method remove_default: GTK2.IconFactory remove_default()
Description: Removes an icon factory from the list of default icon factories.

Class GTK2.IconInfo

Description: Contains information found when looking up an icon in an icon theme.

Method copy: GTK2.IconInfo copy()
Description: Make a copy.

Method get_base_size: int get_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.GdkPixbuf get_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: string get_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.GdkPixbuf load_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.IconSet add_source(GTK2.IconSource source)

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 copy: GTK2.IconSet copy()
Description: Create a copy.

Method create

GTK2.IconSet GTK2.IconSet(GTK2.GdkPixbuf pixbuf)

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.

Method get_sizes: array get_sizes()
Description: Obtains a list of icon sizes this icon set can render.

Class GTK2.IconSize

Description: Iconsize.

Method from_name: int from_name(string name)
Description: Looks up the icon size associated with name.

Method get_name: string get_name(int size)
Description: Gets the canonical name of the given icon size.

Method register: int register(string name, int width, int height)
Description: Registers a new icon size, along the same lines as GTK2.ICON_SIZE_MENU, etc. Returns the integer value for the size.

Method register_alias: GTK2.IconSize register_alias(string alias, int target)
Description: Registers alias as another name for target. So calling GTK2.IconSize->from_name() with alias will return target.

Class GTK2.IconSource

Description: Iconsource.

Method create

GTK2.IconSource GTK2.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: int get_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: int get_direction_wildcarded()
Description: Gets the value set by set_direction_wildcarded().

Method get_filename: string get_filename()
Description: Retrieves the source filename, or empty.

Method get_icon_name: string get_icon_name()
Description: Retrieves the source icon name, or empty.

Method get_pixbuf: GTK2.GdkPixbuf get_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: int get_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: int get_size_wildcarded()
Description: Gets the value set by set_size_wildcarded().

Method get_state: int get_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: int get_state_wildcarded()
Description: Gets the value set by set_state_wildcarded().

Method set_direction

GTK2.IconSource set_direction(int dir)

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.IconSource set_direction_wildcarded(int setting)

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.IconSource set_filename(string filename)
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.IconSource set_icon_name(string name)
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.IconSource set_pixbuf(GTK2.GdkPixbuf pixbuf)
Description: Sets a pixbuf to use as a base image.

Method set_size: GTK2.IconSource set_size(int size)
Description: Sets the icon size this icon source is intended to be with.

Method set_size_wildcarded: GTK2.IconSource set_size_wildcarded(int setting)
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.IconSource set_state(int state)
Description: Sets the widget state this icon source is intended to be used with.

Method set_state_wildcarded: GTK2.IconSource set_state_wildcarded(int setting)
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

Inherit Object: inherit G.Object : Object

Method append_search_path: GTK2.IconTheme append_search_path(string path)
Description: Appends a directory to the search path.

Method create: GTK2.IconTheme GTK2.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: string get_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: array get_icon_sizes(string name)
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 get_search_path: array get_search_path()
Description: Gets the current search path.

Method has_icon: int has_icon(string icon_name)
Description: Checks whether this icon theme includes an icon for a particular name.

Method list_icons: array list_icons(string|void context)
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.GdkPixbuf load_icon(string name, int size, int flags)
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.IconInfo lookup_icon(string name, int size, int flags)
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.IconTheme prepend_search_path(string path)
Description: Prepends a directory to the search path.

Method rescan_if_needed: int rescan_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.IconTheme set_custom_theme(string theme_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.IconTheme set_search_path(array path)

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

Inherit Container: inherit GTK2.Container : Container

Method create: GTK2.IconView GTK2.IconView(GTK2.TreeModel model_or_props)
Description: Creates a new GTK2.IconView widget Not implemented yet.

Method get_column_spacing: int get_column_spacing()
Description: Returns the value of the column-spacing property.

Method get_columns: int get_columns()
Description: Returns the value of the columns property.

Method get_cursor: array get_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: array get_item_at_pos(int x, int y)
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_item_width: int get_item_width()
Description: Returns the value of the item-width property.

Method get_margin: int get_margin()
Description: Returns the value of the margin property.

Method get_markup_column: int get_markup_column()
Description: Returns the column with markup text.

Method get_model: GTK2.TreeModel get_model()
Description: Gets the model.

Method get_orientation: int get_orientation()
Description: Returns the value of the orientation property.

Method get_path_at_pos: GTK2.TreePath get_path_at_pos(int x, int y)
Description: Finds the path at the point(x,y) relative to widget coordinates.

Method get_pixbuf_column: int get_pixbuf_column()
Description: Returns the column with pixbufs.

Method get_reorderable: int get_reorderable()
Description: Retrieves whether the user can reorder the list via drag-and-drop.

Method get_row_spacing: int get_row_spacing()
Description: Returns the value of the row-spacing property.

Method get_selected_items: array get_selected_items()
Description: Creates a list of paths of all selected items. Not implemented yet.

Method get_selection_mode: int get_selection_mode()
Description: Gets the selection mode.

Method get_spacing: int get_spacing()
Description: Returns the value of the spacing property

Method get_text_column: int get_text_column()
Description: Returns the column with text.

Method get_visible_range: array get_visible_range()
Description: Returns the first and last visible path. Note that there may be invisible paths in between.

Method item_activated: GTK2.IconView item_activated(GTK2.TreePath path)
Description: Activates the item determined by path.

Method path_is_selected: int path_is_selected(GTK2.TreePath path)
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.IconView scroll_to_path(GTK2.TreePath path, int use_align, float row_align, float col_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.IconView select_all()
Description: Selects all the icons. This widget must have its selection mode set to GTK2.SELECTION_MULTIPLE.

Method select_path: GTK2.IconView select_path(GTK2.TreePath path)
Description: Selects the row at path

Method set_column_spacing: GTK2.IconView set_column_spacing(int column_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.IconView set_columns(int columns)
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.IconView set_cursor(GTK2.TreePath path, GTK2.CellRenderer cell, int|void start_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.IconView set_item_width(int item_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_margin: GTK2.IconView set_margin(int margin)
Description: Sets the margin property.

Method set_markup_column: GTK2.IconView set_markup_column(int column)
Description: Sets the column with markup information to be column.

Method set_model: GTK2.IconView set_model(GTK2.TreeModel model)
Description: Sets the model.

Method set_orientation: GTK2.IconView set_orientation(int orientation)
Description: Sets the orientation property which determines whether the labels are drawn beside the icons instead of below. One of ORIENTATION_HORIZONTAL and ORIENTATION_VERTICAL

Method set_pixbuf_column: GTK2.IconView set_pixbuf_column(int column)
Description: Sets the column with pixbufs to be column.

Method set_reorderable: GTK2.IconView set_reorderable(int setting)
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.IconView set_row_spacing(int row_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.IconView set_selection_mode(int mode)
Description: Sets the selection mode. One of SELECTION_BROWSE, SELECTION_MULTIPLE, SELECTION_NONE and SELECTION_SINGLE

Method set_spacing: GTK2.IconView set_spacing(int spacing)
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.IconView set_text_column(int column)
Description: Sets the column with text to be column.

Method unselect_all: GTK2.IconView unselect_all()
Description: Unselects all the icons.

Method unselect_path: GTK2.IconView unselect_path(GTK2.TreePath path)
Description: Unselects the row at path

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_PIXMAP and IMAGE_STOCK

Inherit Misc: inherit GTK2.Misc : Misc

Method clear: GTK2.Image clear()
Description: Resets the image to be empty.

Method create: GTK2.Image GTK2.Image(string|GdkPixbuf|GdkPixbufAnimation|GdkImage|GdkPixmap|mapping file_or_props, GTK2.GdkBitmap mask_or_size)
Description: Create a new W(Image) from either a file or a GDK2.Pixbuf.

Method get_animation: GTK2.GdkPixbufAnimation get_animation()
Description: Gets the GDK2.PixbufAnimation being displayed.

Method get_icon_name: mapping get_icon_name()
Description: Gets the icon name and size.

Method get_image: mapping get_image()
Description: Returns ([ "image":GDK2.Image img, "mask":GDK2.Bitmap mask ])

Method get_pixbuf: GTK2.GdkPixbuf get_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_pixel_size: int get_pixel_size()
Description: Gets the pixel size used for named icons.

Method get_pixmap: mapping get_pixmap()
Description: Gets the pixmap and mask.

Method get_stock: mapping get_stock()
Description: Gets the stock icon name and size.

Method get_storage_type: int get_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_PIXMAP and IMAGE_STOCK

Method set_from_animation: GTK2.Image set_from_animation(GTK2.GdkPixbufAnimation anim)
Description: Causes the W(Image) to display the given animation.

Method set_from_file: GTK2.Image set_from_file(string filename)
Description: Set the image from a file.

Method set_from_icon_name: GTK2.Image set_from_icon_name(string icon_name, int size)
Description: Sets from an icon name.

Method set_from_icon_set: GTK2.Image set_from_icon_set(GTK2.IconSet icon_set, int size)
Description: Set this image from an icon set.

Method set_from_image: GTK2.Image set_from_image(GTK2.GdkImage gdk_image, GTK2.GdkBitmap mask)
Description: Set this image from a GDK2.Image plus optional mask.

Method set_from_pixbuf: GTK2.Image set_from_pixbuf(GTK2.GdkPixbuf pixbuf)
Description: Set image from a pixbuf

Method set_from_pixmap: GTK2.Image set_from_pixmap(GTK2.GdkPixmap pixmap, GTK2.GdkBitmap mask)
Description: Set this image from a GDK2.Pixmap plus optional mask.

Method set_from_stock: GTK2.Image set_from_stock(string stock_id, int size)
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.

Method set_pixel_size: GTK2.Image set_pixel_size(int pixel_size)
Description: Sets the pixel size to use for named icons. If the pixel size is set to a value != -1, it is used instead of the icon size set by set_from_icon_name().

Class GTK2.ImageMenuItem

Description: Properties: GTK2.Widget image

Inherit MenuItem: inherit GTK2.MenuItem : MenuItem

Method create: GTK2.ImageMenuItem GTK2.ImageMenuItem(string|mapping label)
Description: Create a new ImageMenuItem.

Method get_image: GTK2.Widget get_image()
Description: Gets the widget that is currently set as the image.

Method set_image: GTK2.ImageMenuItem set_image(GTK2.Widget image)
Description: Sets the image of the image menu item.

Class GTK2.Invisible

Description: An invisible container, useful, eh? :) Properties: GDK2.Screen screen

Inherit Widget: inherit GTK2.Widget : Widget

Method create: GTK2.Invisible GTK2.Invisible(mapping|void props)
Description: Create a new invisible widget

Method get_screen: GTK2.GdkScreen get_screen()
Description: Gets the screen associated with this object.

Method set_screen: GTK2.Invisible set_screen(GTK2.GdkScreen screen)
Description: Sets the screen where this object will be displayed.

Class GTK2.Item

Description

This class is inherited by all 'item' type of widgets.

Signals: deselect

select

toggle

Inherit Bin: inherit GTK2.Bin : Bin

Method deselect: GTK2.Item deselect()
Description: Emulate a 'deselect' event.

Method select: GTK2.Item select()
Description: Emulate a 'select' event.

Method toggle: GTK2.Item toggle()
Description: Emulate a 'toggle' event.

Class GTK2.KeywordListTag

Inherit SourceTag: inherit GTK2.SourceTag : SourceTag

Method create: GTK2.KeywordListTag GTK2.KeywordListTag(string id, string name, array keywords, int case_sensitive, int match_empty_string_at_beginning, int match_empty_string_at_end, string beginning_regex, string end_regex)
Description: Creates a new keyword list tag object with the provided arguments.

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_NONE and PANGO_ELLIPSIZE_START int justfy JUSTIFY_CENTER, JUSTIFY_FILL, JUSTIFY_LEFT and JUSTIFY_RIGHT string 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 wrap

Signals: copy_clipboard

move_cursor

populate_popup

Inherit Misc: inherit GTK2.Misc : Misc

Method create: GTK2.Label GTK2.Label(string|mapping text_or_props)
Description: Creates a new label.

Method get_angle: float get_angle()
Description: Gets the angle of rotation for the label.

Method get_ellipsize: int get_ellipsize()
Description: Returns the ellipsizing position of the label.

Method get_justify: int get_justify()
Description: Returns the justification of the label.

Method get_label: string get_label()
Description: Fetches the text from a label widget including any underlines indicating mnemonics and Pango markup.

Method get_layout: GTK2.Pango.Layout get_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: mapping get_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: int get_line_wrap()
Description: Returns whether lines in the label are automatically wrapped.

Method get_line_wrap_mode: int get_line_wrap_mode()
Description: Returns line wrap mode used by the label.

Method get_max_width_chars: int get_max_width_chars()
Description: Retrieves the desired maximum width, in characters.

Method get_mnemonic_keyval: int get_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.Widget get_mnemonic_widget()
Description: Retrieves the target of the mnemonic (keyboard shortcut).

Method get_selectable: int get_selectable()
Description: Gets the value set by set_selectable().

Method get_selection_bounds: mapping get_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: int get_single_line_mode()
Description: Returns whether the label is in single line mode.

Method get_text: string get_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: int get_use_markup()
Description: Returns whether the label's text is interpreted as marked up with the Pango text markup language.

Method get_use_underline: int get_use_underline()
Description: Returns whether an embedded underline in the label indicates a mnemonic.

Method get_width_chars: int get_width_chars()
Description: Retrieves the desired width, in characters.

Method select_region: GTK2.Label select_region(int start_offset, int end_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.Label set_angle(int|float angle)
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.Label set_ellipsize(int mode)
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_NONE and PANGO_ELLIPSIZE_START.

Method set_justify: GTK2.Label set_justify(int jtype)
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_LEFT and JUSTIFY_RIGHT.

Method set_label: GTK2.Label set_label(string text)
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.Label set_line_wrap(int wrap)
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.Label set_line_wrap_mode(int wrap_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.Label set_markup(string text)
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.Label set_markup_with_mnemonic(string text)

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.Label set_max_width_chars(int n_chars)
Description: Sets the desired maximum width in characters to n_chars.

Method set_mnemonic_widget

GTK2.Label set_mnemonic_widget(GTK2.Widget widget)

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.Label set_pattern(string pattern_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.Label set_selectable(int setting)
Description: Selectable labels allow the user to select text from the label, for copy and past.

Method set_single_line_mode: GTK2.Label set_single_line_mode(int mode)
Description: Sets whether the label is in single line mode.

Method set_text: GTK2.Label set_text(sprintf_format text, sprintf_args ... fmt)
Description: Set the text in the label

Method set_text_with_mnemonic: GTK2.Label set_text_with_mnemonic(sprintf_format text, 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.Label set_use_markup(int setting)
Description: Sets whether the text of the label contains markup in Pango's text markup language.

Method set_use_underline: GTK2.Label set_use_underline(int setting)
Description: If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key.

Method set_width_chars: GTK2.Label set_width_chars(int n_chars)
Description: Sets the desired width in characters to n_chars.

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

Inherit Container: inherit GTK2.Container : Container

Method create: GTK2.Layout GTK2.Layout(GTK2.Adjustment hadjustment_or_props, GTK2.Adjustment vadjustment)
Description: Creates a new GTK2.Layout.

Method get_hadjustment: GTK2.Adjustment get_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 get_vadjustment: GTK2.Adjustment get_vadjustment()
Description: Gets the vertical GTK2.Adjustment.

Method move: GTK2.Layout move(GTK2.Widget widget, int x, int y)
Description: Moves a current child to a new position.

Method put: GTK2.Layout put(GTK2.Widget widget, int x, int y)
Description: Adds widget to the layout at position (x,y). The layout becomes the new parent.

Method set_hadjustment: GTK2.Layout set_hadjustment(GTK2.Adjustment adj)
Description: Sets the horizontal scroll adjustment for the layout.

Method set_size: GTK2.Layout set_size(int xsize, int ysize)
Description: Sets the size of the scrollable area of the layout.

Method set_vadjustment: GTK2.Layout set_vadjustment(GTK2.Adjustment adj)
Description: Sets the vertical scroll adjustment for the layout.

Class GTK2.LineCommentTag

Inherit SourceTag: inherit GTK2.SourceTag : SourceTag

Method create: GTK2.LineCommentTag GTK2.LineCommentTag(string id, string name, string pattern_start)
Description: Creates a new line comment tag object with the provided arguments.

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.

Inherit Button: inherit GTK2.Button : Button

Method create: GTK2.LinkButton GTK2.LinkButton(string|mapping uri_or_props, string|void label)
Description: Creates a new LinkButton.

Method get_uri: string get_uri()
Description: Retrieves the URI set using set_uri().

Method set_uri: GTK2.LinkButton set_uri(string uri)
Description: Sets uri as the URI.

Class GTK2.ListStore

Description: A list-like data structure that can be used with W(TreeView).

Inherit Object: inherit G.Object : Object

Inherit TreeDragDest: inherit GTK2.TreeDragDest : TreeDragDest

Inherit TreeDragSource: inherit GTK2.TreeDragSource : TreeDragSource

Inherit TreeModel: inherit GTK2.TreeModel : TreeModel

Inherit TreeSortable: inherit GTK2.TreeSortable : TreeSortable

Method append: GTK2.TreeIter append()
Description: Append a new row.

Method clear: GTK2.ListStore clear()
Description: Removes all rows.

Method create: GTK2.ListStore GTK2.ListStore(array types)
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.TreeIter insert(int position)
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.TreeIter insert_after(GTK2.TreeIter sibling)
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.TreeIter insert_before(GTK2.TreeIter sibling)
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.ListStore move_after(GTK2.TreeIter iter, GTK2.TreeIter position)
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.ListStore move_before(GTK2.TreeIter iter, GTK2.TreeIter position)
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.TreeIter prepend()
Description: Prepend a new row.

Method remove: GTK2.ListStore remove(GTK2.TreeIter iter)
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.ListStore set_row(GTK2.TreeIter iter, array values)
Description: Set the data in an entire row.

Method set_value: GTK2.ListStore set_value(GTK2.TreeIter iter, int column, mixed value)
Description: Set the data in the cell specified by iter and column.

Method swap: GTK2.ListStore swap(GTK2.TreeIter a, GTK2.TreeIter b)
Description: Swap 2 rows. Only works if this store is unsorted.

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-title

Child 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

Inherit MenuShell: inherit GTK2.MenuShell : MenuShell

Method attach: GTK2.Menu attach(GTK2.Widget child, int left_attach, int right_attach, int top_attach, int bottom_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 create: GTK2.Menu GTK2.Menu(mapping|void props)
Description: Creates a new GTK2.Menu widget.

Method detach: GTK2.Menu detach()
Description: Detaches the menu from the widget to which it had been attached.

Method get_accel_group: GTK2.AccelGroup get_accel_group()
Description: Gets the W(AccelGroup) which holds global accelerators for the menu.

Method get_active: GTK2.Widget get_active()
Description: Returns the selected menu item from the menu. This is used by the W(OptionMenu).

Method get_attach_widget: GTK2.Widget get_attach_widget()
Description: Returns the W(Widget) that the menu is attached to.

Method get_for_attach_widget: array get_for_attach_widget()
Description: Returns a list of the menus which are attached to this widget.

Method get_tearoff_state: int get_tearoff_state()
Description: Returns whether the menu is torn off.

Method get_title: string get_title()
Description: Returns the title of the menu.

Method popdown: GTK2.Menu popdown()
Description: Removes the menu from the screen.

Method popup: GTK2.Menu popup(int|void button_pressed_to_show_menu)
Description: The default button is 3.

Method reorder_child: GTK2.Menu reorder_child(GTK2.Widget child, int position)
Description: Moves a W(MenuItem) to a new position within the GTK2.Menu.

Method reposition: GTK2.Menu reposition()
Description: Repositions the menu according to its position function.

Method set_accel_group: GTK2.Menu set_accel_group(GTK2.AccelGroup accelerators)
Description: Set the W(AccelGroup) which holds global accelerators for the menu.

Method set_accel_path: GTK2.Menu set_accel_path(string accel_path)
Description: Sets an accelerator path for this menu.

Method set_active: GTK2.Menu set_active(int activep)
Description: Selects the specified menu item within the menu. This is used by the W(OptionMenu).

Method set_screen: GTK2.Menu set_screen(GTK2.GdkScreen screen)
Description: Sets the screen on which the menu is displayed.

Method set_tearoff_state: GTK2.Menu set_tearoff_state(int torn_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.

Method set_title: GTK2.Menu set_title(string new_title)
Description: Sets the title string for the menu. The title is displayed when the menu is shown as a tearoff menu.

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

Inherit MenuShell: inherit GTK2.MenuShell : MenuShell

Method create: GTK2.MenuBar GTK2.MenuBar(mapping|void props)
Description: Create a new menu bar.

Method get_child_pack_direction: int get_child_pack_direction()
Description: Retrieves the current child pack direction.

Method get_pack_direction: int get_pack_direction()
Description: Retrieves the current pack direction of the menubar.

Method set_child_pack_direction: GTK2.MenuBar set_child_pack_direction(int setting)
Description: Sets how widgets should be packed inside the children of a menubar.

Method set_pack_direction: GTK2.MenuBar set_pack_direction(int setting)
Description: Sets how items should be packed inside a menubar. One of PACK_DIRECTION_BTT, PACK_DIRECTION_LTR, PACK_DIRECTION_RTL and PACK_DIRECTION_TTB.

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

Inherit Activatable: inherit GTK2.Activatable : Activatable

Inherit Item: inherit GTK2.Item : Item

Method activate: GTK2.MenuItem activate()
Description: Emulate an activate signal

Method create: GTK2.MenuItem GTK2.MenuItem(string|mapping label_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 deselect: GTK2.MenuItem deselect()
Description: Emulate a deselect signal

Method get_right_justified: int get_right_justified()
Description: Gets whether the menu item appears justified at the right side of the menu bar.

Method get_submenu: GTK2.Widget get_submenu()
Description: Gets the submenu underneath this menu item.

Method select: GTK2.MenuItem select()
Description: Emulate a select signal

Method set_accel_path: GTK2.MenuItem set_accel_path(string path)
Description: Sets the accelerator path.

Method set_right_justified: GTK2.MenuItem set_right_justified(int setting)
Description: Make the menu item stick to the right edge of it's container.

Method set_submenu: GTK2.MenuItem set_submenu(GTK2.Widget menu)
Description: Set the submenu for this menu button.

Method toggle_size_allocate: GTK2.MenuItem toggle_size_allocate(int allocation)
Description: Emits the "toggle-size-allocate" signal on the given item.

Method toggle_size_request: int toggle_size_request(int requisition)
Description: Emits the "toggle-size-request" 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.

Inherit Container: inherit GTK2.Container : Container

Method activate_item: GTK2.MenuShell activate_item(GTK2.Widget menu_item, int force_deactivate)
Description: Activates the menu item within the menu shell.

Method append: GTK2.MenuShell append(GTK2.Widget what)
Description: Adds a new W(MenuItem) to the end of the menu shell's item list. Same as 'add'.

Method cancel: GTK2.MenuShell cancel()
Description: Cancels the selection within the menu shell.

Method deactivate: GTK2.MenuShell deactivate()
Description: Deactivates the menu shell. Typically this results in the menu shell being erased from the screen.

Method deselect: GTK2.MenuShell deselect()
Description: Deselects the currently selected item from the menu shell, if any.

Method get_children: array get_children()
Description: This function returns all children of the menushell as an array.

Method get_take_focus: int get_take_focus()
Description: Returns TRUE if the menu shell will take the keyboard focus on popup.

Method insert: GTK2.MenuShell insert(GTK2.Widget what, int where)
Description: Add a widget after the specified location

Method prepend: GTK2.MenuShell prepend(GTK2.Widget what)
Description: Add a menu item to the start of the widget (for a menu: top, for a bar: left)

Method select_first: GTK2.MenuShell select_first(int search_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.MenuShell select_item(GTK2.Widget menuitem)
Description: Selects the menu item from the menu shell.

Method set_take_focus: GTK2.MenuShell set_take_focus(int setting)
Description: If setting is TRUE (the default), the menu shell will take the keyboard focus so that it will receive all keyboard events which is needed to enable keyboard navigation in menus.

Class GTK2.MenuToolButton

Description

Properties to be notified. GTK2.Menu menu

Signals: show_menu

Inherit ToolButton: inherit GTK2.ToolButton : ToolButton

Method create: GTK2.MenuToolButton GTK2.MenuToolButton(GTK2.Widget icon, string|void label)
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_IN and STOCK_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 get_menu: GTK2.Widget get_menu()
Description: Returns the GTK2.Menu.

Method set_arrow_tooltip: GTK2.MenuToolButton set_arrow_tooltip(GTK2.Tooltips tooltips, string tip_text, string tip_private)
Description: Sets the GTK2.Tooltips object to be used for the arrow button which pops up the menu.

Method set_menu: GTK2.MenuToolButton set_menu(GTK2.Widget menu)
Description: Sets the GTK2.Menu that is popped up when the user clicks on the arrow.

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

Inherit Dialog: inherit GTK2.Dialog : Dialog

Method create: GTK2.MessageDialog GTK2.MessageDialog(mapping|int flags, int|void type, int|void buttons, string|void message, GTK2.Window parent)
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_REJECT and RESPONSE_YES. See GTK2.Dialog for more details.

Method format_secondary_markup

GTK2.MessageDialog format_secondary_markup(string text)

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.MessageDialog format_secondary_text(string text)

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.MessageDialog set_image(GTK2.Widget image)
Description: Sets the dialog's image to image.

Method set_markup: GTK2.MessageDialog set_markup(string text)
Description: Sets the text of the message dialog to be text, which is marked up with the Pango text markup language.

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.

Inherit Widget: inherit GTK2.Widget : Widget

Method get_alignment: mapping get_alignment()
Description: Gets the x and y alignment.

Method get_padding: mapping get_padding()
Description: Gets the x and y padding.

Method set_alignment: GTK2.Misc set_alignment(float xalign, float yalign)
Description: Sets the alignment of the widget. 0.0 is left or topmost, 1.0 is right or bottommost.

Method set_padding: GTK2.Misc set_padding(int xpad, int ypad)
Description: Sets the amount of space to add around the widget. xpad and ypad are specified in pixels.

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

Inherit Container: inherit GTK2.Container : Container

Method append_page: GTK2.Notebook append_page(GTK2.Widget contents, GTK2.Widget label)
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.Notebook append_page_menu(GTK2.Widget contents, GTK2.Widget label, GTK2.Widget menu)
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.Notebook GTK2.Notebook(mapping|void props)
Description: Create a W(Notebook) widget with no pages.

Method get_current_page: int get_current_page()
Description: Returns the index of the currently selected page

Method get_group_id: int get_group_id()
Description: Gets the current group identifier.

Method get_menu_label: GTK2.Widget get_menu_label(GTK2.Widget page)
Description: Return the menu label widget.

Method get_menu_label_text: string get_menu_label_text(GTK2.Widget child)
Description: Retrieves the text of the menu label for the page containing child.

Method get_n_pages: int get_n_pages()
Description: Get the number of pages.

Method get_nth_page: GTK2.Widget get_nth_page(int index)
Description: Returns the page for the specified index

Method get_scrollable: int get_scrollable()
Description: Returns whether the tab label area has arrows for scrolling.

Method get_show_border: int get_show_border()
Description: Returns whether a bevel will be drawn around the pages.

Method get_show_tabs: int get_show_tabs()
Description: Returns whether the tabs of the notebook are shown.

Method get_tab_detachable: int get_tab_detachable(GTK2.Widget child)
Description: Returns whether the tab contents can be detached.

Method get_tab_label: GTK2.Widget get_tab_label(GTK2.Widget page)
Description: Returns the tab label widget.

Method get_tab_label_text: string get_tab_label_text(GTK2.Widget child)
Description: Retrieves the text of the tab label for the page containing child.

Method get_tab_pos: int get_tab_pos()
Description: Gets the edge at which the tabs are located.

Method get_tab_reorderable: int get_tab_reorderable(GTK2.Widget child)
Description: Gets whether the tab can be reordered via drag and drop or not.

Method insert_page: GTK2.Notebook insert_page(GTK2.Widget contents, GTK2.Widget label, int pos)
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.Notebook insert_page_menu(GTK2.Widget contents, GTK2.Widget label, GTK2.Widget menu, int pos)
Description: Insert a page at the specified location, arguments as for append_page_menu, but an additional integer specifies the location.

Method next_page: GTK2.Notebook next_page()
Description: Go to the next page

Method page_num: int page_num(GTK2.Widget widget)
Description: Returns the index for the specified page.

Method popup_disable: GTK2.Notebook popup_disable()
Description: Disable the popup menu (set with insert_page_menu).

Method popup_enable: GTK2.Notebook popup_enable()
Description: Enable the popup menu (set with insert_page_menu).

Method prepend_page: GTK2.Notebook prepend_page(GTK2.Widget contents, GTK2.Widget label)
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.Notebook prepend_page_menu(GTK2.Widget contents, GTK2.Widget label, GTK2.Widget menu)
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 prev_page: GTK2.Notebook prev_page()
Description: Go to the previous page

Method query_tab_label_packing: mapping query_tab_label_packing(GTK2.Widget page)
Description: Returns ([ "expand":expandp, "fill":fillp, "pack_type":type ])

Method remove_page: GTK2.Notebook remove_page(int pos)
Description: Remove a page.

Method reorder_child: GTK2.Notebook reorder_child(GTK2.Widget child, int position)
Description: Reorders the page containing child, so that it appears at position.

Method set_current_page: GTK2.Notebook set_current_page(int pos)
Description: Go to the specified page

Method set_group_id: GTK2.Notebook set_group_id(int id)
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.Notebook set_menu_label(GTK2.Widget child, GTK2.Widget label)
Description: Changes the menu label for the page containing child.

Method set_menu_label_text: GTK2.Notebook set_menu_label_text(GTK2.Widget child, string label_text)
Description: Creates a new label with label_text sets it as the menu label.

Method set_scrollable: GTK2.Notebook set_scrollable(int scrollablep)
Description: If true, add scrollbars if necessary.

Method set_show_border: GTK2.Notebook set_show_border(int showborderp)
Description: If true, show the borders around the contents and tabs.

Method set_show_tabs: GTK2.Notebook set_show_tabs(int showtabsp)
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.Notebook set_tab_label(GTK2.Widget child, GTK2.Widget label)
Description: Changes the tab label for child.

Method set_tab_label_packing: GTK2.Notebook set_tab_label_packing(GTK2.Widget child, int expand, int fill, int type)
Description: Sets the packing parameters for the tab label of the page child.

Method set_tab_label_text: GTK2.Notebook set_tab_label_text(GTK2.Widget child, string title)
Description: Creates a new label and sets it as the tab label for the page containing child.

Method set_tab_pos: GTK2.Notebook set_tab_pos(int pos)
Description: Sets the edge at which the tabs for switching pages in the notebook are drawn. One of POS_BOTTOM, POS_LEFT, POS_RIGHT and POS_TOP

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

Inherit InitiallyUnowned: inherit G.InitiallyUnowned : InitiallyUnowned

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.

Inherit Object: inherit G.Object : Object

Method copy: GTK2.PageSetup copy()
Description: Returns a copy of this GTK2.PageSetup.

Method create: GTK2.PageSetup GTK2.PageSetup(mapping|void props)
Description: Create a new GTK2.PageSetup.

Method get_bottom_margin: float get_bottom_margin(int unit)
Description: Gets the bottom margin in units of unit.

Method get_left_margin: float get_left_margin(int unit)
Description: Gets the left margin in units of unit.

Method get_orientation: int get_orientation()
Description: Gets the page orientation.

Method get_page_height: float get_page_height(int unit)
Description: Returns the page height in units of unit.

Method get_page_width: float get_page_width(int unit)
Description: Returns the page width in units of unit.

Method get_paper_height: float get_paper_height(int unit)
Description: Returns the paper height in units of unit.

Method get_paper_size: GTK2.PaperSize get_paper_size()
Description: Gets the paper size.

Method get_paper_width: float get_paper_width(int unit)
Description: Returns the paper width in units of unit.

Method get_right_margin: float get_right_margin(int unit)
Description: Gets the right margin in units of unit.

Method get_top_margin: float get_top_margin(int unit)
Description: Gets the top margin in units of unit.

Method set_bottom_margin: GTK2.PageSetup set_bottom_margin(float margin, int unit)
Description: Sets the bottom margin.

Method set_left_margin: GTK2.PageSetup set_left_margin(float margin, int unit)
Description: Sets the left margin.

Method set_orientation: GTK2.PageSetup set_orientation(int orientation)
Description: Sets the page orientation.

Method set_paper_size: GTK2.PageSetup set_paper_size(GTK2.PaperSize size)
Description: Sets the paper size without changing the margins.

Method set_paper_size_and_default_margins: GTK2.PageSetup set_paper_size_and_default_margins(GTK2.PaperSize size)
Description: Sets the paper size and modifies the margins.

Method set_right_margin: GTK2.PageSetup set_right_margin(float margin, int unit)
Description: Sets the right margin.

Method set_top_margin: GTK2.PageSetup set_top_margin(float margin, int unit)
Description: Sets the top 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

Inherit Container: inherit GTK2.Container : Container

Method add1: GTK2.Paned add1(GTK2.Widget left_or_top)
Description: Set the left or topmost item. This is equivalent to pack1(left_or_top,0,1)

Method add2: GTK2.Paned add2(GTK2.Widget right_or_bottom)
Description: Set the right or bottommost item This is equivalent to pack2(left_or_top,0,1)

Method get_child1: GTK2.Widget get_child1()
Description: Obtains the first child of the paned widget.

Method get_child2: GTK2.Widget get_child2()
Description: Obtains the second child of the paned widget.

Method get_position: int get_position()
Description: Obtains the position of the divider between the two panes.

Method pack1: GTK2.Paned pack1(GTK2.Widget widget, int resize, int shrink)
Description: Add a child to the top or left pane.

Method pack2: GTK2.Paned pack2(GTK2.Widget widget, int resize, int shrink)
Description: Add a child to the bottom or right pane.

Method set_position: GTK2.Paned set_position(int position)
Description: Set the position of the separator, as if set by the user. If position is negative, the remembered position is forgotten, and the division is recomputed from the the requisitions of the children.

Class GTK2.PaperSize

Description: A Paper Size.

Method _destruct: protected GTK2.PaperSize _destruct()
Description: Destructor.

Method copy: GTK2.PaperSize copy()
Description: Copy this GTK2.PaperSize.

Method create: GTK2.PaperSize GTK2.PaperSize(string|void name, string|void ppd_display_name, float|void width, float|void height, int|void unit)
Description: Create a new GTK2.PaperSize object by parsing a PWG 5101.1-2002 PWG paper name.

Method get_default: string get_default()
Description: Returns the name of the default paper size.

Method get_default_bottom_margin: float get_default_bottom_margin(int unit)
Description: Gets the default bottom margin.

Method get_default_left_margin: float get_default_left_margin(int unit)
Description: Gets the default left margin.

Method get_default_right_margin: float get_default_right_margin(int unit)
Description: Gets the default right margin.

Method get_default_top_margin: float get_default_top_margin(int unit)
Description: Gets the default top margin.

Method get_display_name: string get_display_name()
Description: Get the human-readable name.

Method get_height: float get_height(int unit)
Description: Gets the paper height in units of unit.

Method get_name: string get_name()
Description: Get the name.

Method get_ppd_name: string get_ppd_name()
Description: Get the ppd name. May return an empty string.

Method get_width: float get_width(int unit)
Description: Gets the paper width in units of unit.

Method is_custom: int is_custom()
Description: Returns 1 if this paper size is not a standard paper size.

Method is_equal: int is_equal(GTK2.PaperSize size1)
Description: Comparison.

Method set_size: GTK2.PaperSize set_size(float width, float height, int unit)
Description: Changes the dimensions to width x height.

Class GTK2.PatternTag

Inherit SourceTag: inherit GTK2.SourceTag : SourceTag

Method create: GTK2.PatternTag GTK2.PatternTag(string id, string name, string pattern)
Description: Creates a new pattern tag object with the provided arguments.

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

Inherit Window: inherit GTK2.Window : Window

Method create: GTK2.Plug GTK2.Plug(int|mapping socket_id_or_props)
Description: Create a new plug, the socket_id is the window into which this plug will be plugged.

Method get_id: int get_id()
Description: Gets the window id of this widget.

Class GTK2.PrintContext

Inherit Object: inherit G.Object : Object

Method create_pango_context: GTK2.Pango.Context create_pango_context()
Description: Creates a new Pango.Context that can be used with this PrintContext.

Method create_pango_layout: GTK2.Pango.Layout create_pango_layout()
Description: Creates a new Pango.Layout that is suitable for use with this PrintContext.

Method get_dpi_x: float get_dpi_x()
Description: Obtains the horizontal resolution, in dots per inch.

Method get_dpi_y: float get_dpi_y()
Description: Obtains the vertical resolution, in dots per inch.

Method get_height: float get_height()
Description: Obtains the height, in pixels.

Method get_page_setup: GTK2.PageSetup get_page_setup()
Description: Obtains the GTK2.PageSetup that determines the page dimensions.

Method get_width: float get_width()
Description: Obtains the width, in pixels.

Class GTK2.Progress

Description: Properties: int activity-mode int show-text float text-xalign float text-yalign

Inherit Widget: inherit GTK2.Widget : Widget

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_NONE and PANGO_ELLIPSIZE_START float fraction int orientation PROGRESS_BOTTOM_TO_TOP, PROGRESS_CONTINUOUS, PROGRESS_DISCRETE, PROGRESS_LEFT_TO_RIGHT, PROGRESS_RIGHT_TO_LEFT and PROGRESS_TOP_TO_BOTTOM float pulse-step string text

Inherit Progress: inherit GTK2.Progress : Progress

Method create: GTK2.ProgressBar GTK2.ProgressBar(mapping|void props)
Description: Create a new progress bar. The default values are: Min 0.0, max 1.0, current 0.0

Method get_ellipsize: int get_ellipsize()
Description: Returns the ellipsizing position of the progressbar.

Method get_fraction: float get_fraction()
Description: Returns the current fraction of the task that's been completed.

Method get_orientation: int get_orientation()
Description: Retrieves the current progress bar orientation.

Method get_pulse_step: float get_pulse_step()
Description: Retrieves the pulse step.

Method get_text: string get_text()
Description: Retrieves the text displayed superimposed on the progress bar, if any.

Method pulse: GTK2.ProgressBar pulse()
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.ProgressBar set_ellipsize(int mode)
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_NONE and PANGO_ELLIPSIZE_START.

Method set_fraction: GTK2.ProgressBar set_fraction(float fraction)
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.ProgressBar set_orientation(int style)
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_LEFT and PROGRESS_TOP_TO_BOTTOM.

Method set_pulse_step: GTK2.ProgressBar set_pulse_step(float fraction)
Description: Sets the fraction of total progress bar length to move the bouncing block for each call to pulse().

Method set_text: GTK2.ProgressBar set_text(sprintf_format text, sprintf_args ... fmt)
Description: Causes the given text to appear superimposed on the progress bar.

Class GTK2.RadioAction

Description

Properties int current-value GTK2.RadioAction group int value

Signals: changed

Inherit ToggleAction: inherit GTK2.ToggleAction : ToggleAction

Method create: GTK2.RadioAction GTK2.RadioAction(string|mapping name_or_props, string|void label, string|void tooltip, string|void stock_id, int|void value)
Description: Creates a new GTK2.ToggleAction object.

Method get_current_value: int get_current_value()
Description: Obtains the value property of the currently active member.

Method get_group: array get_group()
Description: Returns the list representing the radio group.

Method set_current_value: GTK2.RadioAction set_current_value(int value)
Description: Sets the currently active group member to the member with value property value.

Method set_group: GTK2.RadioAction set_group(GTK2.RadioAction member)
Description: Sets the radio group.

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

Inherit CheckButton: inherit GTK2.CheckButton : CheckButton

Method create: GTK2.RadioButton GTK2.RadioButton(string|mapping title, GTK2.RadioButton groupmember, int|void mnemonic)
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 get_group: array get_group()
Description: Returns an array of members in this group.

Method set_group: GTK2.RadioButton set_group(GTK2.RadioButton groupmember)
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

Inherit CheckMenuItem: inherit GTK2.CheckMenuItem : CheckMenuItem

Method create: GTK2.RadioMenuItem GTK2.RadioMenuItem(string|mapping title, GTK2.RadioMenuItem groupmember)
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 get_group: array get_group()
Description: Returns the group to which the radio menu item belongs.

Method set_group: GTK2.RadioMenuItem set_group(GTK2.RadioMenuItem groupmember)
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

Inherit ToggleToolButton: inherit GTK2.ToggleToolButton : ToggleToolButton

Method create: GTK2.RadioToolButton GTK2.RadioToolButton(GTK2.RadioToolButton groupmember)
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.

Method get_group: array get_group()
Description: Get the group this button belongs to.

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

Inherit Widget: inherit GTK2.Widget : Widget

Method get_adjustment: GTK2.Adjustment get_adjustment()
Description: Gets the W(Adjustment) which is the "model" object for W(Range).

Method get_fill_level: float get_fill_level()
Description: Gets the current position of the fill level indicator.

Method get_inverted: int get_inverted()
Description: Gets the value set by set_inverted().

Method get_lower_stepper_sensitivity: GTK2.Range get_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: int get_restrict_to_fill_level()
Description: Gets whether the range is restricted to the fill level.

Method get_show_fill_level: int get_show_fill_level()
Description: Gets whether the range displays the fill level graphically.

Method get_update_policy: int get_update_policy()
Description: Gets the update policy.

Method get_upper_stepper_sensitivity: GTK2.Range get_upper_stepper_sensitivity()
Description: Gets the sensitivity policy for the stepper that points to the 'upper' end of the GTK2.Range's adjustment.

Method get_value: float get_value()
Description: Gets the current value.

Method set_adjustment: GTK2.Range set_adjustment(GTK2.Adjustment pos)
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.Range set_fill_level(float fill)
Description: Set the new position of the fill level indicator.

Method set_increments: GTK2.Range set_increments(float step, float page)
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.Range set_inverted(int setting)
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.Range set_lower_stepper_sensitivity(int sensitivity)
Description: Sets the sensitivity policy for the stepper that points to the 'lower' end of the GTK2.Range's adjustment.

Method set_range: GTK2.Range set_range(float min, float max)
Description: Sets the allowable values, and clamps the range value to be between min and max.

Method set_restrict_to_fill_level: GTK2.Range set_restrict_to_fill_level(int rest)
Description: Sets whether the slider is restricted to the fill level

Method set_show_fill_level: GTK2.Range set_show_fill_level(int show)
Description: Sets whether a graphical fill level is show on the trough.

Method set_update_policy

GTK2.Range set_update_policy(int when)

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.Range set_upper_stepper_sensitivity(int sensitivity)
Description: Sets the sensitivity policy for the stepper that points to the 'upper' end of the GTK2.Range's adjustment.

Method set_value: GTK2.Range set_value(float value)
Description: Sets the current value; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The range emits the "value-changed" signal if the value changes.

Class GTK2.RcStyle

Description: RC settings.

Inherit Object: inherit G.Object : Object

Method copy: GTK2.RcStyle copy()
Description: Makes a copy.

Method create: GTK2.RcStyle GTK2.RcStyle()
Description: Creates a new W(Rc).

Method set_base: GTK2.RcStyle set_base(array colors)
Description: Set base.

Method set_bg: GTK2.RcStyle set_bg(array colors)
Description: Set bg.

Method set_bg_pixmap_name: GTK2.RcStyle set_bg_pixmap_name(array names)
Description: Set bg_pixmap_name.

Method set_color_flags: GTK2.RcStyle set_color_flags(array flags)
Description: Set color_flags.

Method set_fg: GTK2.RcStyle set_fg(array colors)
Description: Set fg.

Method set_name: GTK2.RcStyle set_name(string name)
Description: Set the name.

Method set_text: GTK2.RcStyle set_text(array colors)
Description: Set text.

Method set_xthickness: GTK2.RcStyle set_xthickness(int value)
Description: Set xthickness.

Method set_ythickness: GTK2.RcStyle set_ythickness(int value)
Description: Set ythickness.

Class GTK2.RecentChooser

Method add_filter: GTK2.RecentChooser add_filter(GTK2.RecentFilter filter)
Description: Adds filter to the list of GTK2.RecentFilter objects held by chooser.

Method get_current_item: GTK2.RecentInfo get_current_item()
Description: Gets the GTK2.RecentInfo currently selected.

Method get_current_uri: string get_current_uri()
Description: Gets the URI currently selected.

Method get_filter: GTK2.RecentFilter get_filter()
Description: Gets the filter currently used.

Method get_items

array get_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: int get_limit()
Description: Gets the number of items returned by get_items() and get_uris().

Method get_local_only: int get_local_only()
Description: Gets whether only local resources should be shown in the recently used resources selector.

Method get_select_multiple: int get_select_multiple()
Description: Gets whether chooser can select multiple items.

Method get_show_icons: int get_show_icons()
Description: Retrieves whether chooser should show an icon near the resource.

Method get_show_not_found: int get_show_not_found()
Description: Retrieves whether chooser should show the recently used resources that were not found.

Method get_show_numbers: int get_show_numbers()
Description: Returns whether chooser should display recently used resources prepended by a unique number.

Method get_show_private: int get_show_private()
Description: Returns whether chooser should display recently used resources registered as private.

Method get_show_tips: int get_show_tips()
Description: Gets whether chooser should display tooltips.

Method get_sort_type: int get_sort_type()
Description: Gets the sorting order.

Method get_uris

array get_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 list_filters: array list_filters()
Description: Gets a list of filters.

Method remove_filter: GTK2.RecentChooser remove_filter(GTK2.RecentFilter filter)
Description: Removes filter.

Method select_all: GTK2.RecentChooser select_all()
Description: Selects all the items inside chooser, if the chooser supports multiple selection.

Method select_uri: int select_uri(string uri)
Description: Selects uri.

Method set_current_uri: int set_current_uri(string uri)
Description: Sets uri as the current URI.

Method set_filter: GTK2.RecentChooser set_filter(GTK2.RecentFilter filter)
Description: Sets filter as the current GTK2.RecentFilter object to affect the displayed recently used resources.

Method set_limit: GTK2.RecentChooser set_limit(int limit)
Description: Sets the number of items that should be returned by get_items() and get_uris().

Method set_local_only: GTK2.RecentChooser set_local_only(int local_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.RecentChooser set_select_multiple(int select_multiple)
Description: Sets whether chooser can select multiple items.

Method set_show_icons: GTK2.RecentChooser set_show_icons(int show_icons)
Description: Sets whether chooser should show an icon near the resource when displaying it.

Method set_show_not_found: GTK2.RecentChooser set_show_not_found(int show_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.RecentChooser set_show_numbers(int show_numbers)
Description: Whether to show recently used resources prepended by a unique number.

Method set_show_private: GTK2.RecentChooser set_show_private(int show_private)
Description: Whether to show recently used resources marked registered as private.

Method set_show_tips: GTK2.RecentChooser set_show_tips(int show_tips)
Description: Sets whether to show a tooltips on the widget.

Method set_sort_type: GTK2.RecentChooser set_sort_type(int sort_type)
Description: Changes the sorting order of the recently used resources list displayed by chooser.

Method unselect_all: GTK2.RecentChooser unselect_all()
Description: Unselects all the items.

Method unselect_uri: GTK2.RecentChooser unselect_uri(string uri)
Description: Unselects uri.

Class GTK2.RecentChooserDialog

Inherit Dialog: inherit GTK2.Dialog : Dialog

Inherit RecentChooser: inherit GTK2.RecentChooser : RecentChooser

Method create: GTK2.RecentChooserDialog GTK2.RecentChooserDialog(mapping|string title, GTK2.Window parent, array buttons, GTK2.RecentManager manager)
Description: Creates a new RecentChooserDialog. Analogous to GTK2.Dialog->create().

Class GTK2.RecentChooserMenu

Inherit Activatable: inherit GTK2.Activatable : Activatable

Inherit Menu: inherit GTK2.Menu : Menu

Inherit RecentChooser: inherit GTK2.RecentChooser : RecentChooser

Method create: GTK2.RecentChooserMenu GTK2.RecentChooserMenu(mapping|RecentManager props)
Description: Create a new GTK2.RecentChooserMenu.

Method get_show_numbers: int get_show_numbers()
Description: Returns true if numbers should be shown.

Method set_show_numbers: GTK2.RecentChooserMenu set_show_numbers(int show_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.

Class GTK2.RecentChooserWidget

Inherit RecentChooser: inherit GTK2.RecentChooser : RecentChooser

Inherit Vbox: inherit GTK2.Vbox : Vbox

Method create: GTK2.RecentChooserWidget GTK2.RecentChooserWidget(mapping|RecentManager props)
Description: Create a new GTK2.RecentChooserWidget.

Class GTK2.RecentFilter

Description: A filter for selecting a subset of recently used files.

Inherit Object: inherit GTK2.Object : Object

Method add_age: GTK2.RecentFilter add_age(int days)
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.RecentFilter add_application(string application)
Description: Adds a rule that allows resources based on the name of the application that has registered them.

Method add_group: GTK2.RecentFilter add_group(string group)
Description: Adds a rule that allows resources based on the name of the group to which they belong.

Method add_mime_type: GTK2.RecentFilter add_mime_type(string mime_type)
Description: Adds a rule that allows resources based on their registered MIME type.

Method add_pattern: GTK2.RecentFilter add_pattern(string pattern)
Description: Adds a rule that allows resources based on a pattern matching their display name.

Method add_pixbuf_formats: GTK2.RecentFilter add_pixbuf_formats()
Description: Adds a rule allowing image files in the formats supported by GdkPixbuf.

Method create: GTK2.RecentFilter GTK2.RecentFilter(mapping|void props)
Description: Create a new GTK2.RecentFilter.

Method get_name: string get_name()
Description: Gets the human-readable name for the filter.

Method set_name: GTK2.RecentFilter set_name(string name)
Description: Sets the human-readable name of the filter; this is the string that will be displayed in the recently used resources selector user interface if there is a selectable list of filters.

Class GTK2.RecentInfo

Method _destruct: protected GTK2.RecentInfo _destruct()
Description: Destructor.

Method exists: int exists()
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: int get_added()
Description: Gets the timestamp (seconds from system's Epoch) when the resource was added to the recently used resources list.

Method get_age: int get_age()
Description: Gets the number of days elapsed since the last update of the resource pointed by info.

Method get_description: string get_description()
Description: Gets the (short) description of the resource. Gets the (short) description of the resource.

Method get_display_name: string get_display_name()
Description: Gets the name of the resource. If none has been defined, the basename of the resource is obtained.

Method get_groups: array get_groups()
Description: Returns all groups registered for the recently used item.

Method get_icon: GTK2.GdkPixbuf get_icon(int size)
Description: Retrieves the icon of size size associated to the resource MIME type.

Method get_mime_type: string get_mime_type()
Description: Gets the MIME type of the resource.

Method get_modified: int get_modified()
Description: Gets the timestamp (seconds from system's Epoch) when the resource was last modified.

Method get_private_hint: int get_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: string get_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: string get_uri()
Description: Gets the URI of the resource.

Method get_uri_display: string get_uri_display()
Description: Gets a displayable version of the resource's URI.

Method get_visited: int get_visited()
Description: Gets the timestamp (seconds from system's Epoch) when the resource was last visited.

Method has_application: int has_application()
Description: Checks whether an application registered this resource using app_name.

Method has_group: int has_group(string group_name)
Description: Checks whether group_name appears inside the groups registered for the recently used item info.

Method is_local: int is_local()
Description: Checks whether the resource is local or not by looking at the scheme of its URI.

Method last_application: string last_application()
Description: Gets the name of the last application that have registered the recently used resource represented by info.

Method match: int match(GTK2.RecentInfo b)
Description: Checks whether two GTK2.RecentInfo structures point to the same resource.

Class GTK2.RecentManager

Inherit Object: inherit G.Object : Object

Method add_item: int add_item(string uri)
Description: Adds a new resource, pointed by uri, into the recently used resources list.

Method create: GTK2.RecentManager GTK2.RecentManager(mapping|int|GdkScreen props_or_def)
Description: Create a new GTK2.RecentManager.

Method get_items: array get_items()
Description: Gets the list of recently used resources.

Method get_limit: int get_limit()
Description: Gets the maximum number of items that the get_items() function should return.

Method has_item: int has_item(string uri)
Description: Checks whether there is a recently used resource registered with uri inside the recent manager.

Method lookup_item: mapping lookup_item(string uri)
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: int move_item(string uri, string new_uri)
Description: Changes the location of a recently used resource from uri to new_uri.

Method purge_items: int purge_items()
Description: Purges every item from the recently used resources list.

Method remove_item: int remove_item(string uri)
Description: Removes a resource pointed by uri from the recently used resources list handled by a recent manager.

Method set_limit: GTK2.RecentManager set_limit(int limit)
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 set_screen: GTK2.RecentManager set_screen(GTK2.GdkScreen screen)
Description: Sets the screen for a recent manager; the screen is used to track the user's currently configured recently used documents storage.

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

Inherit Range: inherit GTK2.Range : Range

Method clear_marks: GTK2.Scale clear_marks()
Description: Removes any marks that have been added with add_mark().

Method get_digits: int get_digits()
Description: Gets the number of decimal places that are displayed.

Method get_draw_value: int get_draw_value()
Description: Returns whether the current value is displayed as a string next to the slider.

Method get_layout: GTK2.Pango.Layout get_layout()
Description: Gets the Pango.Layout used to display the scale.

Method get_layout_offsets: mapping get_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: int get_value_pos()
Description: Gets the position in which the current value is displayed.

Method set_digits: GTK2.Scale set_digits(int precision)
Description: Sets the number of decimal places that are displayed in the value.

Method set_draw_value: GTK2.Scale set_draw_value(int drawp)
Description: Specifies whether the current value is displayed as a string next to the slider.

Method set_value_pos: GTK2.Scale set_value_pos(int where)
Description: Sets the position in which the current value is displayed. One of POS_BOTTOM, POS_LEFT, POS_RIGHT and POS_TOP

Class GTK2.ScaleButton

Description

Properties: GTK2.Adjustment adjustment string icons int size float value

Signals: popdown

popup

value_changed Scale button

Inherit Button: inherit GTK2.Button : Button

Method create: GTK2.ScaleButton GTK2.ScaleButton(int|void size_or_props, float|void min, float|void max, float|void step, array|void icons)
Description: Create a new W(ScaleButton).

Method get_adjustment: GTK2.Adjustment get_adjustment()
Description: Returns the GTK2.Adjustment associated with this scale.

Method get_value: float get_value()
Description: Gets the current value.

Method set_adjustment: GTK2.ScaleButton set_adjustment(GTK2.Adjustment adj)
Description: Sets the GTK2.Adjustment to be used as a model.

Method set_icons: GTK2.ScaleButton set_icons(array icons)
Description: Sets the icons to be used.

Method set_value: GTK2.ScaleButton set_value(float val)
Description: Sets the current value of the scale; if the scale is outside the minimum or maximum range values, it will be clamped to fit inside them. The button emits the "value-changed" signal if the value changes.

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

Inherit Range: inherit GTK2.Range : Range

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"))

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

Inherit Bin: inherit GTK2.Bin : Bin

Method add

GTK2.ScrolledWindow add(GTK2.Widget victim)

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.ScrolledWindow GTK2.ScrolledWindow(GTK2.Adjustment hadjustment_or_props, GTK2.Adjustment vadjustments)
Description: The two adjustments are most commonly set to 0.

Method get_hadjustment: GTK2.Adjustment get_hadjustment()
Description: Get the horizontal adjustment.

Method get_hscrollbar: GTK2.HScrollbar get_hscrollbar()
Description: Returns the horizontal scrollbar.

Method get_placement: int get_placement()
Description: Gets the placement of the scrollbars.

Method get_policy: mapping get_policy()
Description: Returns the current policy values for the horizontal and vertical scrollbars. ([ "h-policy": horizontal policy, "v-policy": vertical policy ]);

Method get_shadow_type: int get_shadow_type()
Description: Gets the shadow type.

Method get_vadjustment: GTK2.Adjustment get_vadjustment()
Description: Get the vertical adjustment.

Method get_vscrollbar: GTK2.VScrollbar get_vscrollbar()
Description: Returns the vertical scrollbar.

Method set_hadjustment: GTK2.ScrolledWindow set_hadjustment(GTK2.Adjustment hadjustment)
Description: Set the horizontal adjustment object.

Method set_placement: GTK2.ScrolledWindow set_placement(int window_placement)
Description: The location of the window relative to the scrollbars. One of CORNER_BOTTOM_LEFT, CORNER_BOTTOM_RIGHT, CORNER_TOP_LEFT and CORNER_TOP_RIGHT

Method set_policy: GTK2.ScrolledWindow set_policy(int xpolicy, int ypolicy)
Description: Vertical and horizontal policy. Both are one of POLICY_ALWAYS, POLICY_AUTOMATIC and POLICY_NEVER

Method set_shadow_type: GTK2.ScrolledWindow set_shadow_type(int type)
Description: Changes the type of shadow drawn around the contents. One of SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_NONE and SHADOW_OUT

Method set_vadjustment: GTK2.ScrolledWindow set_vadjustment(GTK2.Adjustment vadjustment)
Description: Set the vertical adjustment object.

Class GTK2.SelectionData

Description: Drag-and-drop selection data transport object. Most commonly accessed from selection handler callbacks.

Method get_text: string get_text()
Description: Retrieve the selection data as a string.

Method set_text: GTK2.SelectionData set_text(string text)
Description: Set the selection data to the given text string.

Class GTK2.Separator

Description: A generic separator. Basicaly a line, like <hr> in HTML.

Inherit Widget: inherit GTK2.Widget : Widget

Class GTK2.SeparatorMenuItem

Description: A separator menu item.

Inherit MenuItem: inherit GTK2.MenuItem : MenuItem

Method create: GTK2.SeparatorMenuItem GTK2.SeparatorMenuItem(mapping|void props)
Description: Create a new GTK2.SeparatorMenuItem.

Class GTK2.SeparatorToolItem

Description: Properties: int draw

Inherit ToolItem: inherit GTK2.ToolItem : ToolItem

Method create: GTK2.SeparatorToolItem GTK2.SeparatorToolItem(mapping|void props)
Description: Create a new GTK2.SeparatorToolItem.

Method get_draw: int get_draw()
Description: Returns whether SeparatorToolItem is drawn as a line, or just a blank

Method set_draw: GTK2.SeparatorToolItem set_draw(int draw)
Description: When a 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

Inherit Object: inherit G.Object : Object

Method create: GTK2.Settings GTK2.Settings()
Description: Get the default GTK2.Settings object

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.

Inherit Object: inherit G.Object : Object

Method add_widget: GTK2.SizeGroup add_widget(GTK2.Widget widget)
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 create: GTK2.SizeGroup GTK2.SizeGroup(int|mapping mode_or_props)
Description: Create a new group.

Method get_ignore_hidden: int get_ignore_hidden()
Description: Returns if invisible widgets are ignored when calculating the size.

Method get_mode: int get_mode()
Description: Gets the current mode.

Method get_widgets: array get_widgets()
Description: Returns the list of widgets associated with this size group.

Method remove_widget: GTK2.SizeGroup remove_widget(GTK2.Widget widget)
Description: Removes a widget.

Method set_ignore_hidden: GTK2.SizeGroup set_ignore_hidden(int setting)
Description: Sets whether invisible widgets should be ignored when calculating the size.

Method set_mode: GTK2.SizeGroup set_mode(int mode)
Description: Sets the mode of the size group. One of SIZE_GROUP_BOTH, SIZE_GROUP_HORIZONTAL, SIZE_GROUP_NONE and SIZE_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

Inherit Container: inherit GTK2.Container : Container

Method add_id: GTK2.Socket add_id(int wid)
Description: Adds an XEMBED client, such as a W(Plug), to the W(Socket).

Method create: GTK2.Socket GTK2.Socket(mapping|void props)
Description: Create a new GTK2.Socket.

Method get_id: int get_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().

Method id: int id()
Description: Returns the window id, to be sent to the application providing the plug. You must realize this widget before calling this function.

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

Inherit TextBuffer: inherit GTK2.TextBuffer : TextBuffer

Method begin_not_undoable_action

GTK2.SourceBuffer begin_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 can_redo: int can_redo()
Description: Determines whether a source buffer can redo the last action.

Method can_undo: int can_undo()
Description: Determines whether a source buffer can undo the last action.

Method create: GTK2.SourceBuffer GTK2.SourceBuffer(GTK2.TextTagTable table_or_lang)
Description: Create a new SourceBuffer.

Method end_not_undoable_action: GTK2.SourceBuffer end_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.SourceLanguage get_language()
Description: Determines the GTK2.SourceLanguage used by the buffer.

Method get_max_undo_levels: int get_max_undo_levels()
Description: Determines the number of undo levels the buffer will track for buffer edits.

Method redo: GTK2.SourceBuffer redo()
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.SourceBuffer set_language(GTK2.SourceLanguage lang)
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.SourceBuffer set_max_undo_levels(int setting)

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.SourceBuffer undo()

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

Inherit TextIter: inherit GTK2.TextIter : TextIter

Method backward_search: array backward_search(string str, int flags, GTK2.TextIter limit)
Description: Same as GTK2.TextIter->backward_search(), but supports case insensitive searching.

Method forward_search: array forward_search(string str, int flags, GTK2.TextIter limit)
Description: Same as GTK2.TextIter->backward_search(), but supports case insensitive searching.

Class GTK2.SourceLanguage

Description: Signals: tag_style_changed

Inherit Object: inherit G.Object : Object

Method get_name: string get_name()
Description: Returns the localized name of the language.

Method get_section: string get_section()
Description: Returns the localized section of the language. Each language belongs to a section (ex. HTML belongs to the Markup section).

Class GTK2.SourceLanguagesManager

Inherit Object: inherit G.Object : Object

Method create: GTK2.SourceLanguagesManager GTK2.SourceLanguagesManager()
Description: Create a new language manager.

Method get_available_languages: array get_available_languages()
Description: Gets a list of available languages.

Method get_lang_files_dirs: array get_lang_files_dirs()
Description: Gets a list of language files directories.

Method get_language_from_mime_type: GTK2.SourceLanguage get_language_from_mime_type(string type)
Description: Gets the GTK2.SourceLanguage which is associated with the given type in the language manager.

Method get_language_from_name: GTK2.SourceLanguage get_language_from_name(string name)
Description: Gets the GTK2.SourceLanguage which has this name.

Class GTK2.SourceMark

Inherit TextMark: inherit GTK2.TextMark : TextMark

Method get_category: string get_category()
Description: Gets the category type of this marker.

Method next: GTK2.SourceMark next(string category)
Description: Gets the next marker of the specified category after this.

Method prev: GTK2.SourceMark prev(string category)
Description: Gets the previous marker of the specified category before this.

Class GTK2.SourceMarker

Inherit SourceMark: inherit GTK2.SourceMark : SourceMark

Method get_marker_type: string get_marker_type()
Description: Gets the marker type of this marker.

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

Inherit Object: inherit G.Object : Object

Method cancel: GTK2.SourcePrintJob cancel()
Description: Cancels an asynchronous printing operation. This will remove any pending print idle handler.

Method create: GTK2.SourcePrintJob GTK2.SourcePrintJob(GTK2.SourceBuffer buffer)
Description: Creates a new print job object.

Method get_buffer: GTK2.SourceBuffer get_buffer()
Description: Gets the GTK2.SourceBuffer the print job would print.

Method get_highlight: int get_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: int get_page()
Description: Determines the currently printing page number.

Method get_page_count: int get_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: int get_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: int get_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: int get_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: int get_tabs_width()
Description: Determines the configured width (in equivalent spaces) of tabulations. The default value is 8.

Method get_text_margins: mapping get_text_margins()
Description: Determines the user set margins for the job. The default for all four margins is 0.0.

Method get_wrap_mode: int get_wrap_mode()
Description: Determines the wrapping style for text lines wider than the printable width. The default is no wrapping.

Method print: GTK2.SourcePrintJob print()
Description: Print the document.

Method print_range: GTK2.SourcePrintJob print_range(GTK2.TextIter start, GTK2.TextIter end)
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.SourcePrintJob print_range_async(GTK2.TextIter start, GTK2.TextIter end)

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.SourcePrintJob set_buffer(GTK2.SourceBuffer buffer)
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.SourcePrintJob set_footer_format(string|void left, string|void center, string|void right, int separator)
Description: Like set_header_format(), but for the footer.

Method set_header_format

GTK2.SourcePrintJob set_header_format(string|void left, string|void center, string|void right, int separator)

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.SourcePrintJob set_highlight(int setting)
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.SourcePrintJob set_print_footer(int setting)

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.SourcePrintJob set_print_header(int setting)

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.SourcePrintJob set_print_numbers(int interval)
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.SourcePrintJob set_tabs_width(int tabs_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.SourcePrintJob set_text_margins(float top, float bottom, float left, float right)

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.SourcePrintJob set_wrap_mode(int setting)
Description: Sets the wrap mode for lines of text larger than the printable width.

Method setup_from_view: GTK2.SourcePrintJob setup_from_view(GTK2.SourceView view)
Description: Convenience function to set several configuration options at once, so that the printed output matches view. The options set are buffer (if not set already), tabs width, highlighting, wrap mode and default font.

Class GTK2.SourceStyleScheme

Method get_name: string get_name()
Description: Gets the name of this scheme.

Class GTK2.SourceTag

Description: Properties: string id GTK2.SourceTagStyle tag-style

Inherit TextTag: inherit GTK2.TextTag : TextTag

Method get_style: mapping get_style()
Description: Gets the style associated with this tag.

Method set_style: GTK2.SourceTag set_style(mapping style)
Description: Associates a style with this tag. See GTK2.SourceBuffer->set_bracket_match_style() for format.

Class GTK2.SourceTagTable

Description

Derived from GTK2.TextTagTable

Signals: changed

Inherit TextTagTable: inherit GTK2.TextTagTable : TextTagTable

Method add_tags

GTK2.SourceTagTable add_tags(array tags)

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.SourceTagTable GTK2.SourceTagTable()
Description: Creates a new table. The table contains no tags be default.

Method remove_source_tags: GTK2.SourceTagTable remove_source_tags()
Description: Removes all source tags from the table. This will remove the table's reference to the tags, so be careful - tags will end up destroyed if you don't have a reference to them.

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

Inherit TextView: inherit GTK2.TextView : TextView

Method create: GTK2.SourceView GTK2.SourceView(GTK2.SourceBuffer buffer)
Description: Create a new W(SourceView). If a buffer isn't specified, an empty default buffer will be created.

Method get_auto_indent: int get_auto_indent()
Description: Returns whether auto indentation of text is enabled.

Method get_insert_spaces_instead_of_tabs: int get_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: int get_show_line_numbers()
Description: Returns whether line markers are displayed beside the text.

Method get_smart_home_end: int get_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.SourceView set_auto_indent(int setting)
Description: If true, auto indentation of text is enabled.

Method set_insert_spaces_instead_of_tabs: GTK2.SourceView set_insert_spaces_instead_of_tabs(int setting)
Description: If true, any tabulator character inserted is replaced by a group of space characters.

Method set_show_line_numbers: GTK2.SourceView set_show_line_numbers(int setting)
Description: If true, line numbers will be displayed beside the text.

Method set_smart_home_end: GTK2.SourceView set_smart_home_end(int setting)
Description: If true, HOME and END keys will move to the first/last non-space character of the line before moving to the start/end.

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

Inherit CellEditable: inherit GTK2.CellEditable : CellEditable

Inherit Editable: inherit GTK2.Editable : Editable

Inherit Entry: inherit GTK2.Entry : Entry

Method configure: GTK2.SpinButton configure(GTK2.Adjustment range, float climb_rate, int precision)
Description: Adjustment (with the lower/upper/increse values), climb_rate and digits

Method create: GTK2.SpinButton GTK2.SpinButton(GTK2.Adjustment range_or_min_or_props, float climb_rate_or_max, int|float precision_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.Adjustment get_adjustment()
Description: Get the adjustment associated with this spinbutton.

Method get_digits: int get_digits()
Description: Fetches the precision.

Method get_entry: int get_entry()
Description: Returns W(Entry) of this widget.

Method get_increments: mapping get_increments()
Description: Gets the current step and page increments.

Method get_numeric: int get_numeric()
Description: Returns whether non-numeric text can be typed in.

Method get_range: mapping get_range()
Description: Gets the range allowed.

Method get_snap_to_ticks: int get_snap_to_ticks()
Description: Returns whether the value are corrected to the nearest step.

Method get_update_policy: int get_update_policy()
Description: Gets the update behavior.

Method get_value: float get_value()
Description: Get the value.

Method get_value_as_int: int get_value_as_int()
Description: The current value of a Spin Button can be retrieved as a int.

Method get_wrap: int get_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.SpinButton set_adjustment(GTK2.Adjustment range)
Description: Set a new adjustment.

Method set_digits: GTK2.SpinButton set_digits(int precision)
Description: Set the number of digits to show to the user.

Method set_increments: GTK2.SpinButton set_increments(float step, float page)
Description: Sets the step and page increments. This affects how quickly the value changes when the arrows are activated.

Method set_numeric: GTK2.SpinButton set_numeric(int numericp)
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.SpinButton set_range(float min, float max)
Description: Sets the minimum and maximum allowable values.

Method set_snap_to_ticks: GTK2.SpinButton set_snap_to_ticks(int snapp)
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.SpinButton set_update_policy(int policy)

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_value: GTK2.SpinButton set_value(float to)
Description: Set the value.

Method set_wrap: GTK2.SpinButton set_wrap(int wrapp)
Description: If true, the spin button will wrap from the lowest to the highest value, and the highest to the lowest.

Method spin

GTK2.SpinButton spin(int direction, float increment)

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_FORWARD and SPIN_USER_DEFINED

GTK2.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.

Method update: GTK2.SpinButton update()
Description: Explicitly request that the Spin Button updates itself

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

Inherit DrawingArea: inherit GTK2.DrawingArea : DrawingArea

Method create: GTK2.Spinner GTK2.Spinner()

Method start: GTK2.Spinner start()
Description: Start the spinner

Method stop: GTK2.Spinner stop()
Description: Stop the spinner

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

Inherit Object: inherit G.Object : Object

Method create: GTK2.StatusIcon GTK2.StatusIcon(mapping|GdkPixbuf|string arg)
Description: Create a new GTK2.StatusIcon.

Method get_blinking: int get_blinking()
Description: Returns whether the icon is blinking.

Method get_icon_name: string get_icon_name()
Description: Gets the name of the icon.

Method get_pixbuf: GTK2.GdkPixbuf get_pixbuf()
Description: Get the pixbuf.

Method get_size: int get_size()
Description: Gets the size in pixels.

Method get_stock: string get_stock()
Description: Gets the id of the stock icon.

Method get_storage_type: int get_storage_type()
Description: Gets the type of icon, e.g. GTK2.IMAGE_PIXMAP, GTK2.IMAGE_PIXBUF, etc.

Method get_visible: int get_visible()
Description: Returns whether the icon is visible or not.

Method is_embedded: int is_embedded()
Description: Returns whether the status icon is embedded in a notification area.

Method set_blinking: GTK2.StatusIcon set_blinking(int blinking)
Description: Makes the status icon start or stop blinking.

Method set_from_file: GTK2.StatusIcon set_from_file(string filename)
Description: Set the icon from a file.

Method set_from_icon_name: GTK2.StatusIcon set_from_icon_name(string icon_name)
Description: Set the icon from the icon called icon_name from the current theme.

Method set_from_pixbuf: GTK2.StatusIcon set_from_pixbuf(GTK2.GdkPixbuf pixbuf)
Description: Set the icon from pixbuf.

Method set_from_stock: GTK2.StatusIcon set_from_stock(string stock_id)
Description: Set the icon from a stock icon.

Method set_tooltip: GTK2.StatusIcon set_tooltip(string tooltip_text)
Description: Sets the tooltip.

Method set_visible: GTK2.StatusIcon set_visible(int visible)
Description: Shows or hides a status 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

Inherit Hbox: inherit GTK2.Hbox : Hbox

Method create: GTK2.Statusbar GTK2.Statusbar(mapping|void props)
Description: Create a new statusbar widget

Method get_context_id: int get_context_id(string context)
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: int get_has_resize_grip()
Description: Returns whether the statusbar has a resize grip.

Method pop: GTK2.Statusbar pop(int context)
Description: Remove the topmost message.

Method push: int push(int context, string data)
Description: Push a message onto the statusbar. The return value is an id that can be passed to remove later on.

Method remove: GTK2.Statusbar remove(int context, int id)
Description: Remove the specified message (the message id is the second argument).

Method set_has_resize_grip: GTK2.Statusbar set_has_resize_grip(int setting)
Description: Sets whether the statusbar has a resize grip. TRUE by default.

Class GTK2.StringTag

Inherit SourceTag: inherit GTK2.SourceTag : SourceTag

Method create: GTK2.StringTag GTK2.StringTag(string id, string name, string pattern_start, string pattern_end, int end_at_line_end)
Description: Creates a new string tag object with the provided arguments.

Class GTK2.Style

Description

Style settings.

Signals: realize

unrealize

Inherit Object: inherit G.Object : Object

Method attach: GTK2.Style attach(GTK2.Widget window)
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 copy: GTK2.Style copy()
Description: Copy a style.

Method create: GTK2.Style GTK2.Style()
Description: Creates a new style.

Method detach: GTK2.Style detach()
Description: Detach a style.

Method lookup_icon_set: GTK2.IconSet lookup_icon_set(string stock_id)
Description: Lookup the icon set.

Method paint_arrow: GTK2.Style paint_arrow(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int arrow, int fill, int x, int y, int width, int height)
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.Style paint_box(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height)
Description: Draws a box on window with the given parameters.

Method paint_box_gap: GTK2.Style paint_box_gap(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height, int gap_side, int gap_x, int gap_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.Style paint_check(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height)
Description: Draws a check button indicator in the given rectangle on window.

Method paint_diamond: GTK2.Style paint_diamond(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height)
Description: Draws a diamond in the given rectangle on window.

Method paint_expander: GTK2.Style paint_expander(GTK2.Widget window, int state, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int style)
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.Style paint_extension(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height, int gap_side)
Description: Draws an extension, i.e. a notebook tab.

Method paint_flat_box: GTK2.Style paint_flat_box(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height)
Description: Draws a flat box on window.

Method paint_focus: GTK2.Style paint_focus(GTK2.Widget window, int state, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height)
Description: Draws a focus indicator around the given rectangle.

Method paint_handle: GTK2.Style paint_handle(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height, int orientation)
Description: Draws a handle as used in GTK2.HandleBox and GTK2.Paned.

Method paint_hline: GTK2.Style paint_hline(GTK2.Widget window, int state, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x1, int x2, int y)
Description: Draws a horizontal line from (x1,y) to (x2,y).

Method paint_layout: GTK2.Style paint_layout(GTK2.Widget window, int state, int use_text, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, GTK2.Pango.Layout layout)
Description: Draw a pango layout. Use widget->create_pango_layout() to get a Pango.Layout.

Method paint_option: GTK2.Style paint_option(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height)
Description: Draws a radio button indicator in the given rectangle.

Method paint_resize_grip: GTK2.Style paint_resize_grip(GTK2.Widget window, int state, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int edge, int x, int y, int width, int height)
Description: Draws a resize grip in the given rectangle.

Method paint_shadow: GTK2.Style paint_shadow(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height)
Description: Draws a shadow around the given rectangle.

Method paint_shadow_gap: GTK2.Style paint_shadow_gap(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height, int gap_side, int gap_x, int gap_width)
Description: Draws a shadow around the given rectangle in window, leaving a gap in one side.

Method paint_slider: GTK2.Style paint_slider(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height, int orientation)
Description: Paint a slider.

Method paint_tab: GTK2.Style paint_tab(GTK2.Widget window, int state, int shadow, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int x, int y, int width, int height)
Description: Draws an option menu tab (i.e. the up and down pointing arrows).

Method paint_vline: GTK2.Style paint_vline(GTK2.Widget window, int state, GTK2.GdkRectangle rect, GTK2.Widget widget, string detail, int y1, int y2, int x)
Description: Draws a vertical line from (x,y1) to (x,y2).

Method render_icon: GTK2.GdkPixbuf render_icon(GTK2.IconSource source, int direction, int state, int size, GTK2.Widget widget, string detail)
Description: Renders the icon specified by source at the given size according to the given parameters and returns the result in a pixbuf.

Method set_background: GTK2.Style set_background(GTK2.Widget window, int state)
Description: Sets the background of window to the background color or pixmap specified by style for the given state.

Class GTK2.SyntaxTag

Inherit SourceTag: inherit GTK2.SourceTag : SourceTag

Method create: GTK2.SyntaxTag GTK2.SyntaxTag(string id, string name, string pattern_start, string pattern_end)
Description: Creates a new syntax tag object with the provided arguments.

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

Inherit Container: inherit GTK2.Container : Container

Method attach

GTK2.Table attach(GTK2.Widget subwidget, int left, int right, int top, int bottom, int xoptions, int yoptions, int xpad, int ypad)

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.Table attach_defaults(GTK2.Widget subwidget, int left, int right, int top, int bottom)

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.Table GTK2.Table(int|mapping width_or_props, int|void height, int|void homogeneousp)

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: int get_col_spacing(int col)
Description: Gets the amound of space between col and col+1.

Method get_default_col_spacing: int get_default_col_spacing()
Description: Gets the default column spacing for the table.

Method get_default_row_spacing: int get_default_row_spacing()
Description: Gets the default row spacing for the table.

Method get_homogeneous: int get_homogeneous()
Description: Returns whether the table cells are all constrained to the same width and height.

Method get_row_spacing: int get_row_spacing(int row)
Description: Gets the amount of space between row and row+1.

Method resize: GTK2.Table resize(int rows, int columns)
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.Table set_col_spacing(int x, int spacing)
Description: alters the amount of space between a given table column and the adjacent columns.

Method set_col_spacings: GTK2.Table set_col_spacings(int spacing)
Description: Sets the space between every column in the table equal to spacing.

Method set_homogeneous: GTK2.Table set_homogeneous(int homogeneousp)
Description: Set the homogeneous flag.

Method set_row_spacing: GTK2.Table set_row_spacing(int y, int spacing)
Description: alters the amount of space between a given table row and the adjacent rows.

Method set_row_spacings: GTK2.Table set_row_spacings(int spacing)
Description: Sets the space between every row in the table equal to spacing.

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)

Inherit Activatable: inherit GTK2.Activatable : Activatable

Inherit MenuItem: inherit GTK2.MenuItem : MenuItem

Method create: GTK2.TearoffMenuItem GTK2.TearoffMenuItem(mapping|void props)
Description: Create a new tearoff menu item

Class GTK2.TextAttributes

Description: Holds text attributes.

Method copy: GTK2.TextAttributes copy()
Description: Copies src and returns it.

Method copy_values: GTK2.TextAttributes copy_values(GTK2.TextAttributes dest)
Description: Copies src onto dest

Method create: GTK2.TextAttributes GTK2.TextAttributes()
Description: Create a W(TextAttributes) widget.

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

Inherit Object: inherit G.Object : Object

Method add_selection_clipboard: GTK2.TextBuffer add_selection_clipboard(GTK2.Clipboard clipboard)
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.TextBuffer apply_tag(GTK2.TextTag tag, GTK2.TextIter start, GTK2.TextIter end)
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.TextBuffer apply_tag_by_name(string name, GTK2.TextIter start, GTK2.TextIter end)
Description: Calls GTK2.TextTagTable->lookup() on the buffers tag table to get a GTK2.TextTag, then calls apply_tag().

Method backspace

int backspace(GTK2.TextIter iter, int interactive, int default_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.TextBuffer begin_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.TextBuffer copy_clipboard(GTK2.Clipboard clipboard)
Description: Copies the currently-selected text to a clipboard.

Method create: GTK2.TextBuffer GTK2.TextBuffer(GTK2.TextTagTable table_or_props)
Description: Creates a new text buffer.

Method create_child_anchor: GTK2.TextChildAnchor create_child_anchor(GTK2.TextIter iter)
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.TextMark create_mark(GTK2.TextIter where, int left_gravity, string|void mark_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.TextTag create_tag(string tag_name, mapping props)
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.TextBuffer cut_clipboard(GTK2.Clipboard clipboard, int default_editable)
Description: Copies the currently-selected text to a clipboard, then deletes said text if it's editable.

Method delete: GTK2.TextBuffer delete(GTK2.TextIter start, GTK2.TextIter end)
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: int delete_interactive(GTK2.TextIter start, GTK2.TextIter end, int default_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.TextBuffer delete_mark(GTK2.TextMark mark)
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.TextBuffer delete_mark_by_name(string name)
Description: Deletes the mark named name; the mark must exist.

Method delete_selection: int delete_selection(int interactive, int default_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.TextBuffer end_user_action()
Description: Should be paired with begin_user_action();

Method get_bounds: array get_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: int get_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.TextIter get_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: int get_has_selection()
Description: Indicates whether some text is currently selected.

Method get_insert: GTK2.TextMark get_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.TextIter get_iter_at_child_anchor(GTK2.TextChildAnchor anchor)
Description: Returns the location of anchor.

Method get_iter_at_line: GTK2.TextIter get_iter_at_line(int line)
Description: Returns a W(TextIter) to the start of the given line.

Method get_iter_at_line_index: GTK2.TextIter get_iter_at_line_index(int line, int byte_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.TextIter get_iter_at_line_offset(int line_number, int char_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.TextIter get_iter_at_mark(GTK2.TextMark mark)
Description: Returns an iterator with the current position of mark.

Method get_iter_at_offset: GTK2.TextIter get_iter_at_offset(int offset)
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_line_count: int get_line_count()
Description: Obtains the number of lines in the buffer.

Method get_mark: GTK2.TextMark get_mark(string name)
Description: Returns the mark named name.

Method get_modified: int get_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.TextMark get_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: array get_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: string get_slice(GTK2.TextIter start, GTK2.TextIter end, int include_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.TextIter get_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.TextTagTable get_tag_table()
Description: Get the W(TextTagTable) associated with this buffer.

Method get_text: string get_text(GTK2.TextIter start, GTK2.TextIter end, int include_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.TextBuffer insert(GTK2.TextIter iter, string text, int len)
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.TextBuffer insert_at_cursor(string text, int len)
Description: Simply calls insert(), using the current cursor position as the insertion point.

Method insert_child_anchor: GTK2.TextBuffer insert_child_anchor(GTK2.TextIter iter, GTK2.TextChildAnchor anchor)
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

int insert_interactive(GTK2.TextIter iter, string text, int len, int default_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: int insert_interactive_at_cursor(string text, int len, int default_editable)
Description: Calls insert_interactive() at the cursor position.

Method insert_pixbuf: GTK2.TextBuffer insert_pixbuf(GTK2.TextIter iter, GTK2.GdkPixbuf pixbuf)
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.TextBuffer insert_range(GTK2.TextIter iter, GTK2.TextIter start, GTK2.TextIter end)

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: int insert_range_interactive(GTK2.TextIter iter, GTK2.TextIter start, GTK2.TextIter end, int default_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.TextBuffer insert_with_tags(GTK2.TextIter iter, string text, int len, array tags)
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.TextBuffer insert_with_tags_by_name(GTK2.TextIter iter, string text, int len, array tag_names)
Description: Same as insert_with_tags(), but allows you to pass in tag names instead of tag objects.

Method move_mark: GTK2.TextBuffer move_mark(GTK2.TextMark mark, GTK2.TextIter where)
Description: Moves mark to the new location where. Emits the "mark-set" signal as notification of the move.

Method move_mark_by_name: GTK2.TextBuffer move_mark_by_name(string name, GTK2.TextIter where)
Description: Moves the mark named name (which must exist) to location where.

Method paste_clipboard: GTK2.TextBuffer paste_clipboard(GTK2.Clipboard clipboard, int|void default_editable, GTK2.TextIter location)
Description: Pastes the contents of a clipboard at the insertion point, or at override_location.

Method place_cursor: GTK2.TextBuffer place_cursor(GTK2.TextIter where)
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.TextBuffer remove_all_tags(GTK2.TextIter start, GTK2.TextIter end)
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.TextBuffer remove_selection_clipboard(GTK2.Clipboard clipboard)
Description: Removes a clipboard that was added with add_selection_clipboard().

Method remove_tag: GTK2.TextBuffer remove_tag(GTK2.TextTag tag, GTK2.TextIter start, GTK2.TextIter end)
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.TextBuffer remove_tag_by_name(string name, GTK2.TextIter start, GTK2.TextIter end)
Description: Removes a tag. See apply_tag_by_name().

Method select_range: GTK2.TextBuffer select_range(GTK2.TextIter ins, GTK2.TextIter bound)
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.TextBuffer set_modified(int setting)
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.

Method set_text: GTK2.TextBuffer set_text(sprintf_format text, sprintf_args ... fmt)
Description: Deletes current contents of this buffer, and inserts text instead. If multiple arguments are supplied, sprintf() is called implicitly.

Class GTK2.TextChildAnchor

Description: Anchors for embedding widgets in a TextBuffer.

Inherit Object: inherit G.Object : Object

Method create: GTK2.TextChildAnchor GTK2.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: int get_deleted()
Description: Determines whether a child anchor has been deleted from the buffer.

Method get_widgets: array get_widgets()
Description: Gets a list of all widgets anchored at this child anchor.

Class GTK2.TextIter

Description: A TextIter.

Method backward_char: int backward_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: int backward_chars(int count)
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: int backward_cursor_position()
Description: Like forward_cursor_position(), but moves backward.

Method backward_cursor_positions: int backward_cursor_positions(int count)
Description: Moves up to count cursor positions.

Method backward_line: int backward_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_lines: int backward_lines(int count)
Description: Moves count lines backward.

Method backward_search: array backward_search(string str, int flags, GTK2.TextIter limit)
Description: Same as forward_search(), but searches backward.

Method backward_sentence_start: int backward_sentence_start()
Description: Moves backward to the previous sentence start.

Method backward_sentence_starts: int backward_sentence_starts(int count)
Description: Call backward_sentence_start() count times.

Method backward_to_tag_toggle: int backward_to_tag_toggle(GTK2.TextTag tag)
Description: Moves backward to the next toggle. See forward_to_tag_toggle().

Method backward_visible_cursor_position: int backward_visible_cursor_position()
Description: Moves backward to the previous visible cursor position.

Method backward_visible_cursor_positions: int backward_visible_cursor_positions(int count)
Description: Moves up to count visible cursor positions.

Method backward_visible_line: int backward_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: int backward_visible_lines(int count)
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: int backward_visible_word_start()
Description: Moves backward to the previous visible word start.

Method backward_visible_word_starts: int backward_visible_word_starts(int count)
Description: Call backward_visible_word_start() count times

Method backward_word_start: int backward_word_start()
Description: Moves backward to the previous word start.

Method backward_word_starts: int backward_word_starts(int count)
Description: Calls backward_word_start() up to count times.

Method begins_tag: int begins_tag(GTK2.TextTag tag)
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: int can_insert(int default_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: int compare(GTK2.TextIter rhs)
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

int editable(int default_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: int ends_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_sentence: int ends_sentence()
Description: Determines whether this iter ends a sentence.

Method ends_tag: int ends_tag(GTK2.TextTag tag)
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: int ends_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: int equal(GTK2.TextIter rhs)
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: int forward_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: int forward_chars(int count)
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: int forward_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: int forward_cursor_positions(int count)
Description: Moves up to count cursor positions.

Method forward_line: int forward_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: int forward_lines(int count)
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

array forward_search(string str, int flags, GTK2.TextIter limit)

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: int forward_sentence_end()
Description: Moves forward to the next sentence end.

Method forward_sentence_ends: int forward_sentence_ends(int count)
Description: Call forward_sentence_ends() count times.

Method forward_to_end: GTK2.TextIter forward_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: int forward_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: int forward_to_tag_toggle(GTK2.TextTag tag)
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: int forward_visible_cursor_position()
Description: Moves forward to the next visible cursor position.

Method forward_visible_cursor_positions: int forward_visible_cursor_positions(int count)
Description: Moves up to count visible cursor positions.

Method forward_visible_line: int forward_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: int forward_visible_lines(int count)
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: int forward_visible_word_end()
Description: Moves forward to the next visible word end.

Method forward_visible_word_ends: int forward_visible_word_ends(int count)
Description: Call forward_visible_word_end() count times.

Method forward_word_end: int forward_word_end()
Description: Moves forward to the next word end.

Method forward_word_ends: int forward_word_ends(int count)
Description: Calls forward_word_end() up to count times.

Method get_buffer: GTK2.TextBuffer get_buffer()
Description: Returns the W(TextBuffer) this iterator is associated with.

Method get_bytes_in_line: int get_bytes_in_line()
Description: Returns the number of bytes in the line, including the paragraph delimiters.

Method get_char: int get_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: int get_chars_in_line()
Description: Returns the number of characters in the line, including the paragraph delimiters.

Method get_child_anchor: GTK2.TextChildAnchor get_child_anchor()
Description: If this location contains a child anchor, the anchor is returned.

Method get_line: int get_line()
Description: Returns the line number containing this iterator.

Method get_line_index: int get_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: int get_line_offset()
Description: Returns the character offset of the iterator, counting from the start of a newline-terminated line.

Method get_marks: array get_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_offset: int get_offset()
Description: Returns the character offset of an iterator.

Method get_pixbuf: GTK2.GdkPixbuf get_pixbuf()
Description: If the element at iter is a pixbuf, it is returned.

Method get_slice: string get_slice(GTK2.TextIter end)
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: array get_tags()
Description: Returns a list of tags that apply to iter, in ascending order of priority (highest-priority tags are last).

Method get_text: string get_text(GTK2.TextIter end)
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: array get_toggled_tags(int toggled_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: int get_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: int get_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: string get_visible_slice(GTK2.TextIter end)
Description: Like get_slice(), but invisible text is not included.

Method get_visible_text: string get_visible_text(GTK2.TextIter end)
Description: Like get_text(), but invisible text is not include.

Method has_tag: int has_tag(GTK2.TextTag tag)
Description: Returns true if this iterator is within a range tagged with tag.

Method in_range: int in_range(GTK2.TextIter start, GTK2.TextIter end)
Description: Checks whether this iterator falls in the range [start,end). start and end must be in ascending order.

Method inside_sentence: int inside_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: int inside_word()
Description: Determines whether this iter is inside a natural-language word ass opposed to say inside some whitespace).

Method is_cursor_position: int is_cursor_position()
Description: See forward_cursor_position() or Pango.LangAttr or pango_break() for details on what a cursor position is.

Method is_end: int is_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: int is_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.TextIter order(GTK2.TextIter second)
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.TextIter set_line(int line_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.TextIter set_line_index(int index)
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.TextIter set_line_offset(int offset)
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.TextIter set_offset(int char_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.TextIter set_visible_line_index(int index)
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.TextIter set_visible_line_offset(int offset)
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: int starts_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: int starts_sentence()
Description: Determines whether this iter begins a sentence.

Method starts_word: int starts_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).

Method toggles_tag: int toggles_tag(GTK2.TextTag tag)
Description: This is equivalent to begins_tag()||ends_tag(), i.e it tells you whether a range with tag applied to it beings or ends here.

Class GTK2.TextMark

Description: Marks for the text.

Inherit Object: inherit G.Object : Object

Method get_buffer: GTK2.TextBuffer get_buffer()
Description: Gets the buffer this mark is located inside, or empty if the mark is deleted.

Method get_deleted: int get_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: int get_left_gravity()
Description: Determines whether the mark has left gravity.

Method get_name: string get_name()
Description: Returns the mark name; returns empty for anonymous marks.

Method get_visible: int get_visible()
Description: Returns true if the mark is visible.

Method set_visible: GTK2.TextMark set_visible(int setting)
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_NONE and TEXT_DIR_RTL int 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 of JUSTIFY_CENTER, JUSTIFY_FILL, JUSTIFY_LEFT and JUSTIFY_RIGHT int 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 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_CONDENSED and PANGO_STRETCH_ULTRA_EXPANDED int stretch-set; int strikethrough; int strikethrough-set; int style; One of PANGO_STYLE_ITALIC, PANGO_STYLE_NORMAL and PANGO_STYLE_OBLIQUE int style-set; Pango.TabArray tabs int tabs-set; int underline; One of PANGO_UNDERLINE_DOUBLE, PANGO_UNDERLINE_ERROR, PANGO_UNDERLINE_LOW, PANGO_UNDERLINE_NONE and PANGO_UNDERLINE_SINGLE int underline-set; int variant; One of PANGO_VARIANT_NORMAL and PANGO_VARIANT_SMALL_CAPS int variant-set; int weight; int weight-set; int wrap-mode; One of WRAP_CHAR, WRAP_NONE, WRAP_WORD and WRAP_WORD_CHAR int wrap-mode-set;

Signals: event

Inherit Object: inherit G.Object : Object

Method create: GTK2.TextTag GTK2.TextTag(string|mapping name_or_props)
Description: Creates a new text tag.

Method event: int event(GTK2.G.Object event_object, GTK2.GdkEvent event, GTK2.TextIter iter)
Description: Emits the 'event' signal.

Method get_priority: int get_priority()
Description: Gets the tag priority.

Method set_priority: GTK2.TextTag set_priority(int priority)
Description: Sets the priority. Valid priorities start at 0 and go to 1 less than W(TextTagTable)->get_size().

Class GTK2.TextTagTable

Description

Table of text tags.

Signals: tag_added

tag_changed

tag_removed

Inherit Object: inherit G.Object : Object

Method add: GTK2.TextTagTable add(GTK2.TextTag tag)
Description: Add a tag to the table. The tag is assigned the highest priority in the table.

Method create: GTK2.TextTagTable GTK2.TextTagTable()
Description: Creates a new W(TextTagTable).

Method get_size: int get_size()
Description: Returns the size of the table (number of tags).

Method lookup: GTK2.TextTag lookup(string name)
Description: Look up a named tag.

Method remove: GTK2.TextTagTable remove(GTK2.TextTag tag)
Description: Remove a tag from 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

Inherit Container: inherit GTK2.Container : Container

Method add_child_at_anchor: GTK2.TextView add_child_at_anchor(GTK2.Widget child, GTK2.TextChildAnchor anchor)
Description: Adds a child widget in the text buffer, at the given anchor.

Method add_child_in_window: GTK2.TextView add_child_in_window(GTK2.Widget child, int wintype, int xpos, int ypos)
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: int backward_display_line(GTK2.TextIter iter)
Description: See forward_display_line().

Method backward_display_line_start: int backward_display_line_start(GTK2.TextIter iter)
Description: Moves the iter backward to the next display line start.

Method buffer_to_window_coords: array buffer_to_window_coords(int wintype, int buffer_x, int buffer_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_TOP and TEXT_WINDOW_WIDGET.

Method create: GTK2.TextView GTK2.TextView(GTK2.TextBuffer buffer_or_props)
Description: Create a new W(TextView).

Method forward_display_line: int forward_display_line(GTK2.TextIter iter)
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: int forward_display_line_end(GTK2.TextIter iter)
Description: Moves the iter forward to the next display line end.

Method get_accepts_tab: int get_accepts_tab()
Description: Returns whether pressing the Tab key inserts a tab character.

Method get_border_window_size: int get_border_window_size(int wintype)
Description: Gets the width of the specified border window.

Method get_buffer: GTK2.TextBuffer get_buffer()
Description: Returns the buffer displayed by this view.

Method get_cursor_visible: int get_cursor_visible()
Description: Find out whether the cursor is being displayed.

Method get_default_attributes: GTK2.TextAttributes get_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_editable: int get_editable()
Description: Gets the default editability.

Method get_indent: int get_indent()
Description: Gets the default indentation for paragraphs.

Method get_iter_at_location: GTK2.TextIter get_iter_at_location(int x, int y)
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.TextIter get_iter_at_position(int x, int y)
Description: Retrieves the iterator pointing to the character at buffer coordinates x and y.

Method get_iter_location: GTK2.GdkRectangle get_iter_location(GTK2.TextIter iter)
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_justification: int get_justification()
Description: Gets the default justification.

Method get_left_margin: int get_left_margin()
Description: Gets the default left margin size of paragraphs.

Method get_line_at_y: GTK2.TextIter get_line_at_y(int y)
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: mapping get_line_yrange(GTK2.TextIter iter)
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: int get_overwrite()
Description: Returns whether the view is in overwrite mode or not.

Method get_pixels_above_lines: int get_pixels_above_lines()
Description: Gets the default number of pixels to put above paragraphs.

Method get_pixels_below_lines: int get_pixels_below_lines()
Description: Gets the value set by set_pixels_below_lines().

Method get_pixels_inside_wrap: int get_pixels_inside_wrap()
Description: Gets the value set by set_pixels_inside_wrap().

Method get_right_margin: int get_right_margin()
Description: Gets the default right margin size of paragraphs.

Method get_tabs: GTK2.Pango.TabArray get_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.GdkRectangle get_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.GdkWindow get_window(int wintype)
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: int get_window_type(GTK2.GdkWindow window)
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_TOP and TEXT_WINDOW_WIDGET.

Method get_wrap_mode: int get_wrap_mode()
Description: Gets the line wrapping mode.

Method move_child: GTK2.TextView move_child(GTK2.Widget child, int x, int y)
Description: Updates the position of a child.

Method move_mark_onscreen: int move_mark_onscreen(GTK2.TextMark mark)
Description: Moves a mark within the buffer so that it's located within the currently visible text-area.

Method move_visually

int move_visually(GTK2.TextIter iter, int count)

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: int place_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.TextView scroll_mark_onscreen(GTK2.TextMark mark)
Description: Scrolls the view the minimum distance such that mark is contained within the visible area.

Method scroll_to_iter: GTK2.TextView scroll_to_iter(GTK2.TextIter iter, float within_margin, int use_align, float xalign, float yalign)
Description: Scrolls the view so that iter is on the screen as with scroll_to_mark().

Method scroll_to_mark: GTK2.TextView scroll_to_mark(GTK2.TextMark mark, float within_margin, int use_align, float xalign, float yalign)
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.TextView set_accepts_tab(int accepts_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.TextView set_border_window_size(int wintype, int size)
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.TextView set_buffer(GTK2.TextBuffer buffer)
Description: Sets buffer as the buffer being displayed.

Method set_cursor_visible: GTK2.TextView set_cursor_visible(int setting)
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.TextView set_editable(int setting)
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.TextView set_indent(int indent)
Description: Sets the default indentation for paragraphs. May be overridden by tags.

Method set_justification: GTK2.TextView set_justification(int just)
Description: Sets the default justification of text. One of JUSTIFY_CENTER, JUSTIFY_FILL, JUSTIFY_LEFT and JUSTIFY_RIGHT.

Method set_left_margin: GTK2.TextView set_left_margin(int margin)
Description: Sets the default left margin. May be overridden by tags.

Method set_overwrite: GTK2.TextView set_overwrite(int overwrite)
Description: Changes the overwrite mode, true for on, false for off.

Method set_pixels_above_lines: GTK2.TextView set_pixels_above_lines(int pixels)
Description: Sets the default number of blank pixels above paragraphs. Tags in the buffer may override the defaults.

Method set_pixels_below_lines: GTK2.TextView set_pixels_below_lines(int pixels)
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.TextView set_pixels_inside_wrap(int pixels)
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.TextView set_right_margin(int margin)
Description: Sets the default right margin. May be overridden by tags.

Method set_tabs: GTK2.TextView set_tabs(GTK2.Pango.TabArray tabs)
Description: Sets the default tab stops for paragraphs. Tags in the buffer may override the default.

Method set_wrap_mode: GTK2.TextView set_wrap_mode(int wrap_mode)
Description: Sets the line wrapping. One of WRAP_CHAR, WRAP_NONE, WRAP_WORD and WRAP_WORD_CHAR.

Method starts_display_line: int starts_display_line(GTK2.TextIter iter)
Description: Determines whether iter is at the start of a display line.

Method window_to_buffer_coords: array window_to_buffer_coords(int wintype, int window_x, int window_y)
Description: Converts coordinates on the window identified by wintype to buffer coordinates, returning the result.

Class GTK2.ToggleAction

Description

Properties int active int draw-as-radio

Signals: toggled

Inherit Action: inherit GTK2.Action : Action

Method create: GTK2.ToggleAction GTK2.ToggleAction(string|mapping name_or_props, string|void label, string|void tooltip, string|void stock_id)
Description: Creates a new GTK2.ToggleAction object.

Method get_active: int get_active()
Description: Returns the checked state.

Method get_draw_as_radio: int get_draw_as_radio()
Description: Returns whether the action should have proxies like a radio action.

Method set_active: GTK2.ToggleAction set_active(int setting)
Description: Sets the checked state.

Method set_draw_as_radio: GTK2.ToggleAction set_draw_as_radio(int setting)
Description: Sets whether the action should have proxies like a radio action.

Method toggled: GTK2.ToggleAction toggled()
Description: Emits the "toggled" signal.

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

Inherit Button: inherit GTK2.Button : Button

Method create: GTK2.ToggleButton GTK2.ToggleButton(string|mapping label_or_props, int|void mnemonic)
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: int get_active()
Description: Returns true if button is pressed, and false if it is raised.

Method get_inconsistent: int get_inconsistent()
Description: Gets the value set by set_inconsistent().

Method get_mode: int get_mode()
Description: Retrieves whether the button is displayed as a separator indicator and label.

Method set_active: GTK2.ToggleButton set_active(int activep)
Description: If activep is true, the toggle button will be activated.

Method set_inconsistent: GTK2.ToggleButton set_inconsistent(int setting)
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.

Method set_mode: GTK2.ToggleButton set_mode(int mode)
Description: If true, draw indicator

Method toggled: GTK2.ToggleButton toggled()
Description: emulate a 'toggle' of the button. This will emit a 'toggled' signal.

Class GTK2.ToggleToolButton

Description

A ToolItem containing a toggle button.

Signals: toggled

Inherit ToolButton: inherit GTK2.ToolButton : ToolButton

Method create: GTK2.ToggleToolButton GTK2.ToggleToolButton(string|mapping stock_id)
Description: Creates a new toggle tool button, with or without a stock id.

Method get_active: int get_active()
Description: Returns the status of the toggle tool button, true if it is pressed in and false if it isn't.

Method set_active: GTK2.ToggleToolButton set_active(int is_active)
Description: Sets the status of the toggle tool button. Set to true if you want the button to be pressed in, and false to raise it. This causes the toggled signal to be emitted.

Class GTK2.ToolButton

Description

Properties that can be notified: icon-widget label label-widget stock-id use-underline

Signals: clicked

Inherit ToolItem: inherit GTK2.ToolItem : ToolItem

Method create: GTK2.ToolButton GTK2.ToolButton(GTK2.Widget icon, string|void label)
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_IN and STOCK_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: string get_icon_name()
Description: Returns the name of the themed icon for the tool button.

Method get_icon_widget: GTK2.Widget get_icon_widget()
Description: Returns the widget used as the icon widget.

Method get_label: string get_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.Widget get_label_widget()
Description: Returns the widget used as the label.

Method get_stock_id: string get_stock_id()
Description: Returns the name of the stock item.

Method get_use_underline: int get_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.ToolButton set_icon_name(string name)
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.ToolButton set_icon_widget(GTK2.Widget icon_widget)
Description: Sets icon_widget as the widget used as the icon on the button.

Method set_label: GTK2.ToolButton set_label(string label)
Description: Sets label as the label used for the tool button.

Method set_label_widget: GTK2.ToolButton set_label_widget(GTK2.Widget label_widget)
Description: Sets label_widget as the widget used as the label.

Method set_stock_id: GTK2.ToolButton set_stock_id(string stock_id)
Description: Sets the name of the stock item.

Method set_use_underline: GTK2.ToolButton set_use_underline(int use_underline)
Description: If set, an underline in the label property indicates that the next character should be used for the mnemonic accelerator key in the overflow menu.

Class GTK2.ToolItem

Description

Properties: int is-important int visible-horizontal int visible-vertical

Signals: create_menu_proxy

set_tooltip

toolbar_reconfigured

Inherit Activatable: inherit GTK2.Activatable : Activatable

Inherit Bin: inherit GTK2.Bin : Bin

Method create: GTK2.ToolItem GTK2.ToolItem(mapping|void props)
Description: Creates a new GTK2.ToolItem.

Method get_expand: int get_expand()
Description: Returns whether this item is allocated extra space.

Method get_homogeneous: int get_homogeneous()
Description: Returns whether this item is the same size as the other homogeneous items.

Method get_icon_size: int get_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_MENU and ICON_SIZE_SMALL_TOOLBAR

Method get_is_important: int get_is_important()
Description: Returns whether this item is considered important.

Method get_orientation: int get_orientation()
Description: Returns the orientation used for this item. One of ORIENTATION_HORIZONTAL and ORIENTATION_VERTICAL

Method get_proxy_menu_item: GTK2.Widget get_proxy_menu_item(string menu_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: int get_relief_style()
Description: Returns the relief style of this item. One of RELIEF_HALF, RELIEF_NONE and RELIEF_NORMAL

Method get_toolbar_style: int get_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_LINE and TOOLBAR_TEXT

Method get_use_drag_window: int get_use_drag_window()
Description: Returns whether this item has a drag window.

Method get_visible_horizontal: int get_visible_horizontal()
Description: Returns whether this item is visible on toolbars that are docked horizontally.

Method get_visible_vertical: int get_visible_vertical()
Description: Returns whether this item is visible when the toolbar is docked vertically.

Method rebuild_menu: GTK2.ToolItem rebuild_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.Widget retrieve_proxy_menu_item()
Description: Returns the GTK2.MenuItem that was last set by set_proxy_menu_item().

Method set_expand: GTK2.ToolItem set_expand(int expand)
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.ToolItem set_homogeneous(int homogeneous)
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.ToolItem set_is_important(int is_important)
Description: Sets whether this item should be considered important.

Method set_proxy_menu_item: GTK2.ToolItem set_proxy_menu_item(string menu_item_id, GTK2.Widget menu_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.ToolItem set_tooltip(GTK2.Tooltips tooltips, string tip_text, string tip_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.ToolItem set_use_drag_window(int use_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.ToolItem set_visible_horizontal(int visible_horizontal)
Description: Sets whether toolitem is visible when the toolbar is docked horizontally.

Method set_visible_vertical: GTK2.ToolItem set_visible_vertical(int visible_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

Inherit Container: inherit GTK2.Container : Container

Method create: GTK2.Toolbar GTK2.Toolbar(mapping|void props)
Description: Creates a new toolbar.

Method get_drop_index

int get_drop_index(int x, int y)

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: int get_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_MENU and ICON_SIZE_SMALL_TOOLBAR.

Method get_item_index: int get_item_index(GTK2.ToolItem item)
Description: Returns the position of item on the toolbar, starting from 0.

Method get_n_items: int get_n_items()
Description: Returns the number of items on the toolbar.

Method get_nth_item: GTK2.ToolItem get_nth_item(int n)
Description: Returns the n's item on the toolbar, or empty if the toolbar does not contain an n'th item.

Method get_orientation: int get_orientation()
Description: Retrieves the current orientation of the toolbar.

Method get_relief_style: int get_relief_style()
Description: Returns the relief style of buttons.

Method get_show_arrow: int get_show_arrow()
Description: Returns whether the toolbar has an overflow menu.

Method get_style: int get_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_LINE and TOOLBAR_TEXT;

Method get_tooltips: int get_tooltips()
Description: Retrieves whether tooltips are enabled.

Method insert: GTK2.Toolbar insert(GTK2.ToolItem item, int pos)
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.Toolbar set_drop_highlight_item(GTK2.ToolItem item, int index)

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.Toolbar set_orientation(int orientation)
Description: Sets whether a toolbar should appear horizontally or vertically. One of ORIENTATION_HORIZONTAL and ORIENTATION_VERTICAL.

Method set_show_arrow: GTK2.Toolbar set_show_arrow(int show_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.Toolbar set_style(int style)
Description: Set the style, one of TOOLBAR_BOTH, TOOLBAR_BOTH_HORIZ, TOOLBAR_ICONS, TOOLBAR_SPACE_EMPTY, TOOLBAR_SPACE_LINE and TOOLBAR_TEXT

Method set_tooltips: GTK2.Toolbar set_tooltips(int enable)
Description: Sets if the tooltips should be active or not.

Method unset_style: GTK2.Toolbar unset_style()
Description: Unsets a toolbar style, so that user preferences will be used to determine the toolbar style.

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.

Inherit Data: inherit GTK2.Data : Data

Method create: GTK2.Tooltips GTK2.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 disable: GTK2.Tooltips disable()
Description: Disable this tooltip collection.

Method enable: GTK2.Tooltips enable()
Description: Enable this tooltip collection.

Method force_window: GTK2.Tooltips force_window()
Description: Realize the tooltip window (as returned from get_gdkwindow())

Method set_tip: GTK2.Tooltips set_tip(GTK2.Widget in, string to)
Description: Adds a tooltip containing the message tip_text to the specified W(Widget).

Class GTK2.TreeDragDest

Method drag_data_received: int drag_data_received(GTK2.TreePath path, GTK2.SelectionData sel)
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: int row_drop_possible(GTK2.TreePath path, GTK2.SelectionData sel)
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.

Class GTK2.TreeDragSource

Method drag_data_delete: int drag_data_delete(GTK2.TreePath path)
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.SelectionData drag_data_get(GTK2.TreePath path)
Description: Asks to return a representation of the row at path.

Method row_draggable: int row_draggable(GTK2.TreePath path)
Description: Asks the source whether a particular row can be used as the source of a DND operation. If the source doesn't implement this interface, the row is assumed draggable.

Class GTK2.TreeIter

Description: TreeIter.

Method copy: GTK2.TreeIter copy()
Description: Creates a copy of this tree iter.

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_column_type: int get_column_type(int index)
Description: Returns the type of the column.

Method get_flags: int get_flags()
Description: Returns a set of flags supported by this interface.

Method get_iter: GTK2.TreeIter get_iter(GTK2.TreePath path)
Description: Returns a valid iterator pointer to path

Method get_iter_first: GTK2.TreeIter get_iter_first()
Description: Get GTK2.TreeIter with the first iterator in the tree ("0").

Method get_iter_from_string: GTK2.TreeIter get_iter_from_string(string path)
Description: Returns a valid iterator from a path string.

Method get_n_columns: int get_n_columns()
Description: Returns the number of columns suppported by this model.

Method get_path: GTK2.TreePath get_path(GTK2.TreeIter iter)
Description: Returns a GTK2.TreePath from iter.

Method get_row: array get_row(GTK2.TreeIter iter)
Description: Get the row at this iter.

Method get_string_from_iter: string get_string_from_iter(GTK2.TreeIter iter)
Description: Get string representation of iter.

Method get_value: mixed get_value(GTK2.TreeIter iter, int column)
Description: Get value at column of iter.

Method iter_children: GTK2.TreeIter iter_children(GTK2.TreeIter parent)
Description: Get first child of parent.

Method iter_has_child: int iter_has_child(GTK2.TreeIter iter)
Description: Check if iter has children.

Method iter_n_children: int iter_n_children(GTK2.TreeIter iter)
Description: Returns the number of children this iter has.

Method iter_next: int iter_next(GTK2.TreeIter iter)
Description: Go to next node.

Method iter_nth_child: GTK2.TreeIter iter_nth_child(GTK2.TreeIter parent, int index)
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.TreeIter iter_parent(GTK2.TreeIter child)
Description: Get parent of child, or 0 if none.

Method row_changed: GTK2.TreeModel row_changed(GTK2.TreePath path, GTK2.TreeIter iter)
Description: Emit "row-changed" signal.

Method row_deleted: GTK2.TreeModel row_deleted(GTK2.TreePath path)
Description: Emit "row-deleted" signal.

Method row_has_child_toggled: GTK2.TreeModel row_has_child_toggled(GTK2.TreePath path, GTK2.TreeIter iter)
Description: Emit "row-has-child-toggled" signal.

Method row_inserted: GTK2.TreeModel row_inserted(GTK2.TreePath path, GTK2.TreeIter iter)
Description: Emit "row-inserted" signal.

Class GTK2.TreeModelFilter

Description: Properties: GTK2.TreeModel child-model GTK2.TreePath virtual-root

Inherit Object: inherit G.Object : Object

Inherit TreeDragSource: inherit GTK2.TreeDragSource : TreeDragSource

Inherit TreeModel: inherit GTK2.TreeModel : TreeModel

Method convert_child_iter_to_iter: GTK2.TreeIter convert_child_iter_to_iter(GTK2.TreeIter child_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.TreePath convert_child_path_to_path(GTK2.TreePath child_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.TreeIter convert_iter_to_child_iter(GTK2.TreeIter sorted_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.TreePath convert_path_to_child_path(GTK2.TreePath sorted_path)
Description: Converts sorted_path to a path on the child model.

Method create: GTK2.TreeModelFilter GTK2.TreeModelFilter(GTK2.TreeModel model, GTK2.TreePath root)
Description: Create a new GTK2.TreeModel, with model as the child model.

Method refilter: GTK2.TreeModelFilter refilter()
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.

Method set_visible_func: GTK2.TreeModelFilter set_visible_func(function(:void) f, mixed user_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.TreeModelSort

Description: Properties: GTK2.TreeModel model

Inherit Object: inherit G.Object : Object

Inherit TreeDragSource: inherit GTK2.TreeDragSource : TreeDragSource

Inherit TreeModel: inherit GTK2.TreeModel : TreeModel

Inherit TreeSortable: inherit GTK2.TreeSortable : TreeSortable

Method convert_child_iter_to_iter: GTK2.TreeIter convert_child_iter_to_iter(GTK2.TreeIter child_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.TreePath convert_child_path_to_path(GTK2.TreePath child_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.TreeIter convert_iter_to_child_iter(GTK2.TreeIter sorted_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.TreePath convert_path_to_child_path(GTK2.TreePath sorted_path)
Description: Converts sorted_path to a path on the child model.

Method create: GTK2.TreeModelSort GTK2.TreeModelSort(GTK2.TreeModel model)
Description: Create a new GTK2.TreeModel, with model as the child model.

Method get_model: GTK2.TreeModel get_model()
Description: Return the model this ModelSort is sorting.

Method reset_default_sort_func: GTK2.TreeModelSort reset_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.TreePath append_index(int index)
Description: Appends a new index to path. As a result, the depth of the path is increased.

Method compare: int compare(GTK2.TreePath b)
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 copy: GTK2.TreePath copy()
Description: Creates a new GTK2.TreePath as a copy.

Method create: GTK2.TreePath GTK2.TreePath(string|void path)
Description: Creates a new GTK2.TreePath.

Method down: GTK2.TreePath down()
Description: Moves path to point to the first child of the current path.

Method get_depth: int get_depth()
Description: Returns the current depth of path.

Method get_indices: array get_indices()
Description: Returns the current indices of path as an array of integers, each representing a node in a tree.

Method is_ancestor: int is_ancestor(GTK2.TreePath descendant)
Description: Returns TRUE if descendant is a descendant of this path.

Method is_descendant: int is_descendant(GTK2.TreePath ancestor)
Description: Returns TRUE if this path is a descendant of ancestor.

Method next: GTK2.TreePath next()
Description: Moves the path to point to the next node at the current depth.

Method prepend_index: GTK2.TreePath prepend_index(int index)
Description: Prepends a new index to a path. As a result, the depth of the path is increased.

Method prev: GTK2.TreePath prev()
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: string to_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.

Method up: GTK2.TreePath up()
Description: Moves the path to point to its parent node, if it has a parent.

Class GTK2.TreeRowReference

Description: A TreeRowReference.

Method copy: GTK2.TreeRowReference copy()
Description: Copies a GTK2.TreeRowReference.

Method create: GTK2.TreeRowReference GTK2.TreeRowReference(GTK2.TreeModel model, GTK2.TreePath path)
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.TreeModel get_model()
Description: Returns the model which this references is monitoring.

Method get_path: GTK2.TreePath get_path()
Description: Returns a path that the row reference currently points to.

Method valid: int valid()
Description: Return TRUE if the reference referes to a current valid path.

Class GTK2.TreeSelection

Description

Selections on a treestore.

Signals: changed

Inherit Object: inherit G.Object : Object

Method count_selected_rows: int count_selected_rows()
Description: Returns the number of rows that have been selected.

Method get_mode: int get_mode()
Description: Gets the selectiom mode.

Method get_selected: array get_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: array get_selected_rows(GTK2.TreeModel model)
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.TreeView get_tree_view()
Description: Returns the tree view associated with this selection.

Method get_user_data: object get_user_data()
Description: Returns the user data for the selection function.

Method iter_is_selected: int iter_is_selected(GTK2.TreeIter iter)
Description: Returns true if the row at iter is currently selected.

Method path_is_selected: int path_is_selected(GTK2.TreePath path)
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.TreeSelection select_all()
Description: Selects all the nodes. This selection must be set to GTK2.SELECTION_MULTIPLE mode.

Method select_iter: GTK2.TreeSelection select_iter(GTK2.TreeIter iter)
Description: Selects the specified iterator.

Method select_path: GTK2.TreeSelection select_path(GTK2.TreePath path)
Description: Select the row at path.

Method select_range: GTK2.TreeSelection select_range(GTK2.TreePath start, GTK2.TreePath end)
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.TreeSelection set_mode(int type)
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_NONE and SELECTION_SINGLE.

Method unselect_all: GTK2.TreeSelection unselect_all()
Description: Unselects all the nodes.

Method unselect_iter: GTK2.TreeSelection unselect_iter(GTK2.TreeIter iter)
Description: Unselects the specified iterator.

Method unselect_path: GTK2.TreeSelection unselect_path(GTK2.TreePath path)
Description: Unselects the row at path.

Method unselect_range: GTK2.TreeSelection unselect_range(GTK2.TreePath start, GTK2.TreePath end)
Description: Unselects a range of nodes, determined by start and end inclusive.

Class GTK2.TreeSortable

Description

The interface for sortable models used by TreeView.

Signals: sort_column_changed

Method get_sort_column_id: mapping get_sort_column_id()
Description: Returns ([ "column": int, "order": int ])

Method has_default_sort_func: int has_default_sort_func()
Description: Returns true if the model has a default sort function.

Method set_default_sort_func

GTK2.TreeSortable set_default_sort_func(function(:void) f, mixed user_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.TreeSortable set_sort_column_id(int column, int order)
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.TreeSortable set_sort_func(int column, function(:void) f, mixed user_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.

Method sort_column_changed: GTK2.TreeSortable sort_column_changed()
Description: Emits a "sort-column-changed" signal

Class GTK2.TreeStore

Description: A tree-like data structure that can be used with W(TreeView).

Inherit Object: inherit G.Object : Object

Inherit TreeDragDest: inherit GTK2.TreeDragDest : TreeDragDest

Inherit TreeDragSource: inherit GTK2.TreeDragSource : TreeDragSource

Inherit TreeModel: inherit GTK2.TreeModel : TreeModel

Inherit TreeSortable: inherit GTK2.TreeSortable : TreeSortable

Method append: GTK2.TreeIter append(GTK2.TreeIter parent)
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 clear: GTK2.TreeStore clear()
Description: Removes all rows.

Method create: GTK2.TreeStore GTK2.TreeStore(array types)
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.TreeIter insert(GTK2.TreeIter parent, int position)
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.TreeIter insert_after(GTK2.TreeIter parent, GTK2.TreeIter sibling)
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.TreeIter insert_before(GTK2.TreeIter parent, GTK2.TreeIter sibling)
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: int is_ancestor(GTK2.TreeIter iter, GTK2.TreeIter descendant)
Description: Returns true if iter is an ancestor of descendant.

Method iter_depth: int iter_depth(GTK2.TreeIter iter)
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.TreeStore move_after(GTK2.TreeIter iter, GTK2.TreeIter position)
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.TreeStore move_before(GTK2.TreeIter iter, GTK2.TreeIter position)
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.TreeIter prepend(GTK2.TreeIter parent)
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.TreeStore remove(GTK2.TreeIter iter)
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.TreeStore set_row(GTK2.TreeIter iter, array values)
Description: Set the data in an entire row.

Method set_value: GTK2.TreeStore set_value(GTK2.TreeIter iter, int column, mixed value)
Description: Set the data in the cell specified by iter and column.

Method swap: GTK2.TreeStore swap(GTK2.TreeIter a, GTK2.TreeIter b)
Description: Swap 2 rows. Only works if this store is unsorted.

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

Inherit Container: inherit GTK2.Container : Container

Method append_column: GTK2.TreeView append_column(GTK2.TreeViewColumn column)
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.TreeView collapse_all()
Description: Recursively collapses all visible, expanded nodes.

Method collapse_row: int collapse_row(GTK2.TreePath path)
Description: Collapses a row (hides its child rows, if they exist).

Method columns_autosize: GTK2.TreeView columns_autosize()
Description: Resizes all columns to their optimal width. Only works after the treeview has been realized.

Method convert_bin_window_to_tree_coords: mapping convert_bin_window_to_tree_coords(int bx, int by)
Description: Convert bin_window coordinates to tree coordinates.

Method convert_bin_window_to_widget_coords: mapping convert_bin_window_to_widget_coords(int bx, int by)
Description: Convert bin_window coordinates to widget coordinates.

Method convert_tree_to_bin_window_coords: mapping convert_tree_to_bin_window_coords(int tx, int ty)
Description: Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.

Method convert_tree_to_widget_coords: mapping convert_tree_to_widget_coords(int tx, int ty)
Description: Convert tree coordinates to widget coordinates.

Method convert_widget_to_bin_window_coords: mapping convert_widget_to_bin_window_coords(int wx, int wy)
Description: Convert widget coordinates to bin_window coordinates.

Method convert_widget_to_tree_coords: mapping convert_widget_to_tree_coords(int wx, int wy)
Description: Convert widget coordinates to tree coordinates.

Method create: GTK2.TreeView GTK2.TreeView(GTK2.TreeModel model_or_props)
Description: Create a new W(TreeView), with or without a default model.

Method create_row_drag_icon: GTK2.GdkPixmap create_row_drag_icon(GTK2.TreePath path)
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.TreeView enable_model_drag_dest(array targets, int actions)
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.TreeView enable_model_drag_source(int start_button_mask, array targets, int actions)
Description: Turns the view into a drag source for automatic DND. See also: drag_source_set

Method expand_all: GTK2.TreeView expand_all()
Description: Recursively expands all nodes.

Method expand_row: int expand_row(GTK2.TreePath path, int open_all)
Description: Opens the row so its children are visible.

Method expand_to_path: GTK2.TreeView expand_to_path(GTK2.TreePath path)
Description: Expands the row at path. This will also expand all parent rows of path as necessary.

Method get_background_area: GTK2.GdkRectangle get_background_area(GTK2.TreePath path, GTK2.TreeViewColumn column)
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.GdkWindow get_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.GdkRectangle get_cell_area(GTK2.TreePath path, GTK2.TreeViewColumn column)
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.TreeViewColumn get_column(int n)
Description: Gets the W(TreeViewColumn) at the given position.

Method get_columns: array get_columns()
Description: Returns an array of all the W(TreeViewColumn)'s current in the view.

Method get_cursor: mapping get_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: mapping get_dest_row_at_pos(int drag_x, int drag_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: mapping get_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: int get_enable_search()
Description: Returns whether or not the tree allows to start interactive searching by typing in text.

Method get_enable_tree_lines: int get_enable_tree_lines()
Description: Returns whether or not tree lines are drawn.

Method get_expander_column: GTK2.TreeViewColumn get_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: int get_fixed_height_mode()
Description: Returns whether fixed height mode is turned on.

Method get_grid_lines: int get_grid_lines()
Description: Returns which grid lines are enabled.

Method get_hadjustment: GTK2.Adjustment get_hadjustment()
Description: Gets the W(Adjustment) currently being used for the horizontal aspect.

Method get_headers_clickable: int get_headers_clickable()
Description: Returns whether all header columns are clickable.

Method get_headers_visible: int get_headers_visible()
Description: Returns true if the headers are visible.

Method get_hover_expand: int get_hover_expand()
Description: Returns whether hover expansion mode is turned on.

Method get_hover_selection: int get_hover_selection()
Description: Returns whether hover selection mode is turned on.

Method get_level_indentation: int get_level_indentation()
Description: Returns the amount, in pixels, of extra indentation for child levels

Method get_model: GTK2.TreeModel get_model()
Description: Returns the model this TreeView is based on.

Method get_path_at_pos: mapping get_path_at_pos(int x, int y)
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: int get_reorderable()
Description: Retrieves whether the user can reorder the tree via drag-and-drop.

Method get_rubber_banding: int get_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_rules_hint: int get_rules_hint()
Description: Gets the setting set by set_rules_hint().

Method get_search_column: int get_search_column()
Description: Gets the column searched on by the interactive search code.

Method get_search_entry: GTK2.Entry get_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: array get_selected()
Description: Shortcut to GTK2.TreeView->get_selection() and GTK2.TreeSelection()->get_selected().

Method get_selection: GTK2.TreeSelection get_selection()
Description: Gets the W(TreeSelection) associated with this TreeView.

Method get_show_expanders: int get_show_expanders()
Description: Returns whether or not expanders are drawn

Method get_vadjustment: GTK2.Adjustment get_vadjustment()
Description: Gets the W(Adjustment) currently being used for the vertical aspect.

Method get_visible_range: array get_visible_range()
Description: Returns the first and last visible path. Note that there may be invisible paths in between.

Method get_visible_rect: GTK2.GdkRectangle get_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: int insert_column(GTK2.TreeViewColumn column, int position)
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.TreeView move_column_after(GTK2.TreeViewColumn column, GTK2.TreeViewColumn base)
Description: Moves column to be after base. If base is omitted, then column is placed in the first position.

Method remove_column: int remove_column(GTK2.TreeViewColumn column)
Description: Removes column.

Method row_activated: GTK2.TreeView row_activated(GTK2.TreePath path, GTK2.TreeViewColumn column)
Description: Activates the cell determined by path and column.

Method row_expanded: int row_expanded(GTK2.TreePath path)
Description: Returns true if the node pointed to by path is expanded.

Method scroll_to_cell

GTK2.TreeView scroll_to_cell(GTK2.TreePath path, GTK2.TreeViewColumn column, float|void row_align, float|void col_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.TreeView scroll_to_point(int x, int y)

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.TreeView set_cursor(GTK2.TreePath path, GTK2.TreeViewColumn focus_column, int|void start_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.TreeView set_cursor_on_cell(GTK2.TreePath path, GTK2.TreeViewColumn focus_column, int|void start_editing, GTK2.CellRenderer focus_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.TreeView set_drag_dest_row(GTK2.TreePath path, int pos)
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.TreeView set_enable_search(int enable_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.TreeView set_enable_tree_lines(int enabled)
Description: Sets whether to draw lines interconnecting the expanders. This does not have any visible effects for lists.

Method set_expander_column: GTK2.TreeView set_expander_column(GTK2.TreeViewColumn column)
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.TreeView set_fixed_height_mode(int enable)
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.TreeView set_grid_lines(int grid_lines)
Description: Sets which grid lines to draw.

Method set_hadjustment: GTK2.TreeView set_hadjustment(GTK2.Adjustment hadj)
Description: Sets the W(Adjustment) for the current horizontal aspect.

Method set_headers_clickable: GTK2.TreeView set_headers_clickable(int setting)
Description: Allow the column title buttons to be clicked.

Method set_headers_visible: GTK2.TreeView set_headers_visible(int headers_visible)
Description: Sets the visibility state of the headers.

Method set_hover_expand: GTK2.TreeView set_hover_expand(int expand)
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.TreeView set_hover_selection(int hover)
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.TreeView set_model(GTK2.TreeModel model)
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.TreeView set_reorderable(int reorderable)

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.TreeView set_row_separator_func(function(:void) f, mixed user_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.TreeView set_rubber_banding(int enable)
Description: Enables or disables rubber banding.

Method set_rules_hint: GTK2.TreeView set_rules_hint(int setting)
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.TreeView set_search_column(int column)

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.TreeView set_search_entry(GTK2.Entry entry)
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.TreeView set_show_expanders(int show)
Description: Sets whether to draw and enable expanders and indent child rows.

Method set_vadjustment: GTK2.TreeView set_vadjustment(GTK2.Adjustment vadj)
Description: Sets the W(Adjustment) for the current vertical aspect.

Method unset_rows_drag_dest: GTK2.TreeView unset_rows_drag_dest()
Description: Undoes the effect of enable_model_drag_dest().

Method unset_rows_drag_source: GTK2.TreeView unset_rows_drag_source()
Description: Undoes the effect of enable_model_drag_source().

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_FIXED and TREE_VIEW_COLUMN_GROW_ONLY int sort-indicator int sort-order SORT_ASCENDING and SORT_DESCENDING int spacing string title int visible GTK2.Widget widget int width

Signals: clicked

Inherit CellLayout: inherit GTK2.CellLayout : CellLayout

Inherit Data: inherit GTK2.Data : Data

Method add_attribute: GTK2.TreeViewColumn add_attribute(GTK2.CellRenderer cell_renderer, string attribute, int column)
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: mapping cell_get_position(GTK2.CellRenderer cell_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: mapping cell_get_size(GTK2.GdkRectangle cell_area)
Description: Obtains the width and height needed to render the column.

Method cell_is_visible: int cell_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.TreeViewColumn cell_set_cell_data(GTK2.TreeModel model, GTK2.TreeIter iter, int is_expander, int is_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: GTK2.TreeViewColumn clear()
Description: Unsets all the mappings on all renderers.

Method clear_attributes: GTK2.TreeViewColumn clear_attributes(GTK2.CellRenderer cell_renderer)
Description: Clears all existing attributes previously set.

Method clicked: GTK2.TreeViewColumn clicked()
Description: Emits the "clicked" signal on the column. This function will only work if this column is clickable.

Method create: GTK2.TreeViewColumn GTK2.TreeViewColumn(string|mapping title_or_props, GTK2.CellRenderer renderer, string property, int col, 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.TreeViewColumn focus_cell(GTK2.CellRenderer cell)
Description: Sets the current keyboard focus to be at cell, if the column contains 2 or more editable and activatable cells.

Method get_alignment: float get_alignment()
Description: Returns the current x alignment. This value can range between 0.0 and 1.0.

Method get_cell_renderers: array get_cell_renderers()
Description: Returns an array of all the cell renderers in the column, in no partciular order.

Method get_clickable: int get_clickable()
Description: Returns true if the user can click on the header for the column.

Method get_expand: int get_expand()
Description: Return true if the column expands to take any available space.

Method get_fixed_width: int get_fixed_width()
Description: Gets the fixed width of the column.

Method get_max_width: int get_max_width()
Description: Returns the maximum width in pixels, or -1 if no maximum width is set.

Method get_min_width: int get_min_width()
Description: Returns the minimum width in pixels, or -1 if no minimum width is set.

Method get_reorderable: int get_reorderable()
Description: Returns true if the column can be reordered by the user.

Method get_resizable: int get_resizable()
Description: Returns true if the column can be resized by the end user.

Method get_sizing: int get_sizing()
Description: Returns the current type.

Method get_sort_column_id: int get_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: int get_sort_indicator()
Description: Gets the value set by set_sort_indicator();

Method get_sort_order: int get_sort_order()
Description: Gets the value set by set_sort_order().

Method get_spacing: int get_spacing()
Description: Returns the spacing.

Method get_title: string get_title()
Description: Returns the title of the widget.

Method get_tree_view: GTK2.Widget get_tree_view()
Description: Returns the W(TreeView) that this TreeViewColumn has been inserted into.

Method get_visible: int get_visible()
Description: Returns true if the column is visible.

Method get_widget: GTK2.Widget get_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 get_width: int get_width()
Description: Returns the current size in pixels.

Method pack_end: GTK2.TreeViewColumn pack_end(GTK2.CellRenderer cell, int expand)
Description: Packs the cell to the end of the column.

Method pack_start: GTK2.TreeViewColumn pack_start(GTK2.CellRenderer cell, int expand)
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.TreeViewColumn queue_resize()
Description: Flags the column, and the cell renderers added to this column, to have their sizes renegotiated.

Method set_alignment: GTK2.TreeViewColumn set_alignment(float xalign)
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.TreeViewColumn set_clickable(int clickable)
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.TreeViewColumn set_expand(int expand)
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.TreeViewColumn set_fixed_width(int fixed_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.TreeViewColumn set_max_width(int max_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.TreeViewColumn set_min_width(int min_width)
Description: Sets the minimum width. If min_width is -1, then the minimum width is unset.

Method set_reorderable: GTK2.TreeViewColumn set_reorderable(int reorderable)
Description: If reorderable is true, then the column can be reorderd by the end user dragging the header.

Method set_resizable: GTK2.TreeViewColumn set_resizable(int resizable)
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.TreeViewColumn set_sizing(int type)
Description: Sets the growth behavior of this columnt to type. One of TREE_VIEW_COLUMN_AUTOSIZE, TREE_VIEW_COLUMN_FIXED and TREE_VIEW_COLUMN_GROW_ONLY.

Method set_sort_column_id: GTK2.TreeViewColumn set_sort_column_id(int column_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.TreeViewColumn set_sort_indicator(int setting)
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.TreeViewColumn set_sort_order(int order)

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_ASCENDING and SORT_DESCENDING.

Method set_spacing: GTK2.TreeViewColumn set_spacing(int spacing)
Description: Sets the spacing field, which is the number of pixels to place between cell renderers packed into it.

Method set_title: GTK2.TreeViewColumn set_title(string title)
Description: Sets the title. If a custom widget has been set, then this value is ignored.

Method set_visible: GTK2.TreeViewColumn set_visible(int visible)
Description: Sets the visibility.

Method set_widget: GTK2.TreeViewColumn set_widget(GTK2.Widget widget)
Description: Sets the widget in the header to be widget. If widget is omitted, then the header button is set with a W(Label) set to the title.

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>

Inherit Object: inherit G.Object : Object

Method add_ui

GTK2.UiManager add_ui(int merge_id, string path, string name, string action, int type, int top)

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: int add_ui_from_file(string filename)
Description: Parses a file containing a ui definition.

Method add_ui_from_string: int add_ui_from_string(string buffer)
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.UiManager GTK2.UiManager(mapping|void props)
Description: Creates a new ui manager object.

Method ensure_update: GTK2.UiManager ensure_update()
Description: Makes sure that all pending updates to the ui have been completed.

Method get_accel_group: GTK2.AccelGroup get_accel_group()
Description: Returns the GTK2.AccelGroup associated with this.

Method get_action: GTK2.Action get_action(string path)
Description: Looks up an action by following a path.

Method get_action_groups: array get_action_groups()
Description: Returns the list of action groups.

Method get_add_tearoffs: int get_add_tearoffs()
Description: Returns whether menus generated by this manager will have tearoff menu items.

Method get_toplevels: array get_toplevels(int types)
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_TOOLBAR and UI_MANAGER_TOOLITEM.

Method get_ui: string get_ui()
Description: Creates a ui definition of the merged ui.

Method get_widget

GTK2.Widget get_widget(string path)

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.UiManager insert_action_group(GTK2.ActionGroup group, int pos)
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: int new_merge_id()
Description: Returns an unused merge id, suitable for use with add_ui().

Method remove_action_group: GTK2.UiManager remove_action_group(GTK2.ActionGroup group)
Description: Removes an action group from the list of action groups.

Method remove_ui: GTK2.UiManager remove_ui(int merge_id)
Description: Unmerges the part of the content identified by merge_id.

Method set_add_tearoffs

GTK2.UiManager set_add_tearoffs(int setting)

Description

Sets the "add-tearoffs" property, which controls whether menus generated by this manager will have tearoff menu items.

Note that this only affects regular menus. Generated popup menus never have tearoff menu items.

Class GTK2.VScrollbar

Description: General documentation: See W(Scrollbar) GTK2.VScrollbar(GTK2.Adjustment())->set_size_request(15,60)

Inherit Scrollbar: inherit GTK2.Scrollbar : Scrollbar

Method create: GTK2.VScrollbar GTK2.VScrollbar(GTK2.Adjustment pos_or_props)
Description: Used to create a new vscrollbar widget.

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"))

Inherit Box: inherit GTK2.Box : Box

Method create: GTK2.Vbox GTK2.Vbox(int|mapping uniformp_or_props, int|void padding)
Description: Create a new vertical box widget. If all_same_size is true, all widgets will have exactly the same size. padding is added to the top and bottom of the children.

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)

Inherit ButtonBox: inherit GTK2.ButtonBox : ButtonBox

Method create: GTK2.VbuttonBox GTK2.VbuttonBox(mapping|void props)
Description: Create a new vertical button box

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

Inherit Bin: inherit GTK2.Bin : Bin

Method create: GTK2.Viewport GTK2.Viewport(GTK2.Adjustment xscroll_or_props, GTK2.Adjustment yscroll)
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.Adjustment get_hadjustment()
Description: Return the current horizontal adjustment object

Method get_shadow_type: int get_shadow_type()
Description: Get the shadow type. One Of SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_NONE and SHADOW_OUT

Method get_vadjustment: GTK2.Adjustment get_vadjustment()
Description: Return the current vertical adjustment object

Method set_hadjustment: GTK2.Viewport set_hadjustment(GTK2.Adjustment xscroll)
Description: Set a new horizontal adjustment object.

Method set_shadow_type: GTK2.Viewport set_shadow_type(int type)
Description: Set the shadow style. One of SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_NONE and SHADOW_OUT

Method set_vadjustment: GTK2.Viewport set_vadjustment(GTK2.Adjustment yscroll)
Description: Set a new vertical adjustment object.

Class GTK2.VolumeButton

Description: Volume Button

Inherit ScaleButton: inherit GTK2.ScaleButton : ScaleButton

Method create: GTK2.VolumeButton GTK2.VolumeButton(mapping|void props)
Description: Create a new W(VolumeButton).

Class GTK2.Vpaned

Description

GTK2.Vpaned()->add1(GTK2.Label("Top Side Of Pane"))->add2(GTK2.Label("Bottom"))->set_size_request(100,100)

Inherit Paned: inherit GTK2.Paned : Paned

Method create: GTK2.Vpaned GTK2.Vpaned(mapping|void props)
Description: Create a new W(Vpaned) widget.

Class GTK2.Vscale

Description

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)

Inherit Scale: inherit GTK2.Scale : Scale

Method create: GTK2.Vscale GTK2.Vscale(GTK2.Adjustment settings_or_min_props, float|void max, float|void step)
Description: Used to create a new hscale widget. Either pass an W(Adjustment), or three floats representing min, max, and step values.

Class GTK2.Vseparator

Description: Simply creates a vertical separator. No bells or whistles. GTK2.Vseparator()->set_size_request(3,50)

Inherit Separator: inherit GTK2.Separator : Separator

Method create: GTK2.Vseparator GTK2.Vseparator(mapping|void props)
Description: Used to create a new vseparator widget.

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_CURSOR and GDK_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-request

Style 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

Inherit Object: inherit GTK2.Object : Object

Method APP_PAINTABLE: GTK2.Widget APP_PAINTABLE()
Description: Returns if the GTK2.APP_PAINTABLE flag has been set on this widget.

Method CAN_DEFAULT: GTK2.Widget CAN_DEFAULT()
Description: Returns if this widget is allowed to receive the default action.

Method CAN_FOCUS: GTK2.Widget CAN_FOCUS()
Description: Returns if this widget is able to handle focus grabs.

Method COMPOSITE_CHILD: GTK2.Widget COMPOSITE_CHILD()
Description: Returns if this widget is a composite child of its parent.

Method DOUBLE_BUFFERED: GTK2.Widget DOUBLE_BUFFERED()
Description: Returns if the GTK2.DOUBLE_BUFFERED flag has been set on this widget.

Method DRAWABLE: GTK2.Widget DRAWABLE()
Description: Returns if this widget is mapped and visible.

Method FLAGS: GTK2.Widget FLAGS()
Description: Returns flags.

Method HAS_DEFAULT: GTK2.Widget HAS_DEFAULT()
Description: Returns if this widget is currently receiving the default action.

Method HAS_FOCUS: GTK2.Widget HAS_FOCUS()
Description: Returns if this widget has grabbed the focus and no other widget has done so more recently.

Method HAS_GRAB: GTK2.Widget HAS_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.Widget IS_SENSITIVE()
Description: Returns if this widget is effectively sensitive.

Method MAPPED: GTK2.Widget MAPPED()
Description: Returns if this widget is mapped.

Method NO_WINDOW: GTK2.Widget NO_WINDOW()
Description: Returns if this widget doesn't have its own GDK2.Window.

Method PARENT_SENSITIVE: GTK2.Widget PARENT_SENSITIVE()
Description: Returns if the GTK2.PARENT_SENSITIVE flag is set.

Method RC_STYLE: GTK2.Widget RC_STYLE()
Description: Returns if the widget's style has been looked up through the rc mechanism.

Method REALIZED: GTK2.Widget REALIZED()
Description: Returns if this widget is realized.

Method RECEIVES_DEFAULT: GTK2.Widget RECEIVES_DEFAULT()
Description: Returns if this widget when focused will receive the default action even if there is a different widget set as default.

Method SAVED_STATE: GTK2.Widget SAVED_STATE()
Description: Get the saved state.

Method SENSITIVE: GTK2.Widget SENSITIVE()
Description: Returns if this widget is sensitive.

Method STATE: GTK2.Widget STATE()
Description: Get the state.

Method TOPLEVEL: GTK2.Widget TOPLEVEL()
Description: Returns if this is a toplevel widget.

Method VISIBLE: GTK2.Widget VISIBLE()
Description: Returns if this widget is visible.

Method activate: int activate()
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.Widget add_accelerator(string accel_signal, GTK2.AccelGroup accel_group, int accel_key, int accel_mods, int accel_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.Widget add_events(int events)
Description: Adds the events in the bitfield events to the event mask.

Method add_mnemonic_label: GTK2.Widget add_mnemonic_label(GTK2.Widget label)
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: mapping allocation()
Description: Returns ([ "x": xoffset, "y":yoffset, "width":xsize, "height":ysize ])

Method can_activate_accel: int can_activate_accel(int signal_id)
Description: Determines whether an accelerator that activates the signal signal_id can currently be activated.

Method child_notify: GTK2.Widget child_notify(string prop)
Description: Emits a "child-notify" signal for the child property prop.

Method class_path: string class_path()
Description: Same as path() but uses type rather than name.

Method create_pango_context: GTK2.Pango.Context create_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.Layout create_pango_layout(string text)
Description: Creates a new Pango.Layout with the appropriate colormap, font description, and base direction for drawing text.

Method drag_dest_set: GTK2.Widget drag_dest_set(int flags, array targets, int actions)
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.Widget drag_source_set(int buttons, array targets, int actions)

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.Widget error_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.Widget freeze_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.Action get_action()
Description: Returns the GTK2.Action that this widget is a proxy for.

Method get_clipboard: GTK2.Clipboard get_clipboard(GDK2.Atom selection)
Description: Returns the clipboard object for the given selection.

Method get_composite_name: string get_composite_name()
Description: Get the composite name.

Method get_direction: int get_direction()
Description: Gets the reading direction.

Method get_display: GTK2.GdkDisplay get_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_events: int get_events()
Description: Returns the event mask for the widget.

Method get_extension_events: int get_extension_events()
Description: Retrieves the extension events the widget will receive.

Method get_modifier_style: GTK2.RcStyle get_modifier_style()
Description: Returns the current modifier style.

Method get_name: string get_name()
Description: Retrieves the name.

Method get_no_show_all: int get_no_show_all()
Description: Returns the current value of the "no-show-all" property.

Method get_pango_context: GTK2.Pango.Context get_pango_context()
Description: Gets a Pango.Context with the appropriate colormap, font description, and base direction for this widget.

Method get_parent: GTK2.Widget get_parent()
Description: Returns the parent container.

Method get_parent_window: GTK2.GdkWindow get_parent_window()
Description: Get the parent window.

Method get_pointer: mapping get_pointer()
Description: Obtains the location of the mouse pointer in widget coordinates.

Method get_root_window: GTK2.GdkWindow get_root_window()
Description: Get the root window.

Method get_screen: GTK2.GdkScreen get_screen()
Description: Get the GDK2.Screen from the toplevel window associated with this widget.

Method get_settings: GTK2.Settings get_settings()
Description: Gets the settings object holding the settings (global property settings, RC file information, etc) used for this widget.

Method get_size_request: mapping get_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.GdkPixmap get_snapshot(GTK2.GdkRectangle clip_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_style: GTK2.Style get_style()
Description: Returns the style.

Method get_tooltip_markup: string get_tooltip_markup()
Description: Gets the contents of the tooltip

Method get_tooltip_text: string get_tooltip_text()
Description: Gets the contents of the tooltip

Method get_tooltip_window: GTK2.Window get_tooltip_window()
Description: Returns the GtkWindow of the current tooltip

Method get_toplevel: GTK2.Widget get_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.GdkWindow get_window()
Description: Returns the widget's window if it is realized, other NULL.

Method grab_default: GTK2.Widget grab_default()
Description: Causes this widget to become the default widget.

Method grab_focus: GTK2.Widget grab_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: int has_screen()
Description: Checks whether there is a GDK2.Screen associated with this widget.

Method hide: GTK2.Widget hide()
Description: Hide the widget.

Method hide_all: GTK2.Widget hide_all()
Description: Hide this widget, and all child widgets.

Method hide_on_delete: int hide_on_delete()
Description: Utility function

Method input_shape_combine_mask: GTK2.Widget input_shape_combine_mask(GTK2.GdkBitmap shape_mask, int offset_x, int offset_y)
Description: Sets an input shape for this widget's GDK2.Window.

Method is_ancestor: int is_ancestor(GTK2.Widget ancestor)
Description: Determines whether this widget is somewhere inside ancestor.

Method is_composited: int is_composited()
Description: Whether this widget can rely on having its alpha channel drawn correctly.

Method is_focus: int is_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

int keynav_failed(int direction)

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: array list_mnemonic_lables()
Description: Returns a list of the widgets, normally labels, for which this widget is the target of a mnemonic.

Method map: GTK2.Widget map()
Description: Causes this widget to be mapped.

Method mnemonic_activate: int mnemonic_activate(int group_cycling)
Description: Not documented.

Method modify_base: GTK2.Widget modify_base(int state, GTK2.GdkColor color)
Description: Sets the base color of the widget in a particular state. See modify_fg().

Method modify_bg: GTK2.Widget modify_bg(int state, GTK2.GdkColor color)
Description: Sets the background color of the widget in a particular state. See modify_fg().

Method modify_cursor: GTK2.Widget modify_cursor(GTK2.GdkColor primary, GTK2.GdkColor secondary)
Description: Sets the cursor color to use in a widget.

Method modify_fg: GTK2.Widget modify_fg(int state, GTK2.GdkColor color)
Description: Sets the foreground color of the widget in a particular state. state is one of STATE_ACTIVE, STATE_INSENSITIVE, STATE_NORMAL, STATE_PRELIGHT and STATE_SELECTED. color can be omitted to undo the effect of a previous call.

Method modify_font: GTK2.Widget modify_font(GTK2.Pango.FontDescription font)
Description: Sets the font.

Method modify_style: GTK2.Widget modify_style(GTK2.RcStyle style)
Description: Modifies style values.

Method modify_text: GTK2.Widget modify_text(int state, GTK2.GdkColor color)
Description: Sets the text color of the widget in a particular state. See modify_fg().

Method path: string path()
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.Widget queue_draw()
Description: Equivalent to calling queue_draw_area() for the entire area of the widget.

Method queue_draw_area: GTK2.Widget queue_draw_area(int x, int y, int width, int height)
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.Widget queue_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.Widget queue_resize_no_redraw()
Description: This function works like queue_resize(), except that the widget is not invalidated.

Method remove_accelerator: int remove_accelerator(GTK2.AccelGroup accel_group, int accel_key, int accel_mods)
Description: Removes an accelerator.

Method remove_mnemonic_label: GTK2.Widget remove_mnemonic_label(GTK2.Widget label)
Description: Removes a widget from the list of mnemonic labels for this widget.

Method render_icon

GTK2.GdkPixbuf render_icon(string stock_id, int size, string detail)

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.Widget reparent(GTK2.Widget new_parent)
Description: Moves a widget from one W(Container) to another.

Method reset_shapes: GTK2.Widget reset_shapes()
Description: Recursively resets the shape on this widget and its descendants.

Method set_accel_path: GTK2.Widget set_accel_path(string accel_path, GTK2.AccelGroup accel_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.Widget set_composite_name(string name)
Description: Sets a widget's composite name.

Method set_direction: GTK2.Widget set_direction(int dir)
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.Widget set_events(int events)
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.Widget set_extension_events(int mode)
Description: Sets the extension events mask to mode. One of GDK_EXTENSION_EVENTS_ALL, GDK_EXTENSION_EVENTS_CURSOR and GDK_EXTENSION_EVENTS_NONE

Method set_flags: GTK2.Widget set_flags(int flags)
Description: Set certain flags, such as GTK2.CAN_DEFAULT.

Method set_name: GTK2.Widget set_name(string name)
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.Widget set_no_show_all(int no_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.Widget set_parent(GTK2.Widget parent)
Description: Sets the container as the parent of this widget.

Method set_parent_window: GTK2.Widget set_parent_window(GTK2.GdkWindow parent)
Description: Sets a non default parent window for this widget.

Method set_scroll_adjustments: GTK2.Widget set_scroll_adjustments(GTK2.Adjustment hadj, GTK2.Adjustment vadj)
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.Widget set_sensitive(int sensitive)
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.Widget set_size_request(int width, int height)

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_style: GTK2.Widget set_style(GTK2.Style style)
Description: Sets the style.

Method set_tooltip_markup: GTK2.Widget set_tooltip_markup(string markup)
Description: Sets markup as the contents of the tooltip

Method set_tooltip_text: GTK2.Widget set_tooltip_text(string text)
Description: Sets text as the contents of the tooltip.

Method set_tooltip_window: GTK2.Widget set_tooltip_window(GTK2.Window window)
Description: Replaces the default, usually yellow, window used for displaying tooltips.

Method shape_combine_mask: GTK2.Widget shape_combine_mask(GTK2.GdkBitmap shape_mask, int offset_x, int offset_y)
Description: Sets a shape for a widget's GDK2.Window. This allows for transparent window, etc.

Method show: GTK2.Widget show()
Description: Show the widget. Most (almost all) widgets must be shown to be visible on the screen.

Method show_all: GTK2.Widget show_all()
Description: Show this widget, and all child widgets.

Method show_now: GTK2.Widget show_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 size_request: mapping size_request()
Description: Get the size allocated to a widget.

Method style_get_property: mixed style_get_property(string name)
Description: Gets the value of the style property called name.

Method thaw_child_notify: GTK2.Widget thaw_child_notify()
Description: Reverts the effect of a previous call to freeze_child_notify().

Method trigger_tooltip_query: GTK2.Widget trigger_tooltip_query()
Description: Triggers a tooltip query

Method unmap: GTK2.Widget unmap()
Description: Causes this widget to be unmapped.

Method unset_flags: GTK2.Widget unset_flags(int flags)
Description: Unset flags.

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_STATIC and GDK_GRAVITY_WEST int 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 type WINDOW_POPUP and WINDOW_TOPLEVEL int type-hint 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_TOOLBAR and GDK_WINDOW_TYPE_HINT_UTILITY int urgency-hint int window-position WIN_POS_CENTER, WIN_POS_CENTER_ALWAYS, WIN_POS_CENTER_ON_PARENT, WIN_POS_MOUSE and WIN_POS_NONE

Signals: activate_default

activate_focus

frame_event

keys_changed

move_focus

set_focus

Inherit Bin: inherit GTK2.Bin : Bin

Method activate_default: int activate_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 activate_focus: int activate_focus()
Description: Activates the current focused widget.

Method add_accel_group: GTK2.Window add_accel_group(GTK2.AccelGroup group)
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.Window add_mnemonic(int keyval, GTK2.Widget target)
Description: Adds a mnemonic to this window.

Method begin_move_drag: GTK2.Window begin_move_drag(int button, int root_x, int root_y, int timestamp)
Description: Starts moving a window. This function is used if an application has window movement grips.

Method begin_resize_drag: GTK2.Window begin_resize_drag(int edge, int button, int root_x, int root_y, int timestamp)
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.Window GTK2.Window(int|mapping props)
Description: Argument is one of WINDOW_POPUP and WINDOW_TOPLEVEL, or a mapping of allowed properties.

Method deiconify: GTK2.Window deiconify()
Description: Opposite of iconify().

Method fullscreen: GTK2.Window fullscreen()
Description: Asks to place this window in the fullscreen state. Same caveats iconify().

Method get_accept_focus: int get_accept_focus()
Description: Gets the value set by set_accept_focus().

Method get_decorated: int get_decorated()
Description: Returns whether the window has been set to have decorations such as a title bar.

Method get_default_size: mapping get_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: int get_deletable()
Description: Returns whether the window has been set to have a close button.

Method get_destroy_with_parent: int get_destroy_with_parent()
Description: Returns whether the window will be destroyed with its transient parent.

Method get_focus: GTK2.Widget get_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_focus_on_map: int get_focus_on_map()
Description: Gets the value set by set_focus_on_map().

Method get_gravity: int get_gravity()
Description: Gets the value set by set_gravity().

Method get_group: GTK2.WindowGroup get_group()
Description: Returns the group for this widget or the default group.

Method get_icon: GTK2.GdkPixbuf get_icon()
Description: Gets the value set by set_icon().

Method get_icon_list: array get_icon_list()
Description: Retrieves the list of icons set by set_icon_list().

Method get_icon_name: string get_icon_name()
Description: Returns the name of the themed icon for the window.

Method get_mnemonic_modifier: int get_mnemonic_modifier()
Description: Returns the mnemonic modifier for this window.

Method get_modal: int get_modal()
Description: Returns whether the window is modal.

Method get_opacity: float get_opacity()
Description: Fetches the requested opacity.

Method get_position

mapping get_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_resizable: GTK2.Window get_resizable()
Description: Gets the whether this window is resizable.

Method get_size: mapping get_size()
Description: Obtains the current size of window.

Method get_skip_pager_hint: int get_skip_pager_hint()
Description: Gets the value set by set_skip_pager_hint().

Method get_skip_taskbar_hint: int get_skip_taskbar_hint()
Description: Gets the value set by set_skip_taskbar_hint().

Method get_title: string get_title()
Description: Retrieves the title of the window.

Method get_transient_for: GTK2.Window get_transient_for()
Description: Fetches the transient parent for this window.

Method get_type_hint: int get_type_hint()
Description: Gets the type hint.

Method get_urgency_hint: int get_urgency_hint()
Description: Gets the value set by set_urgency_hint().

Method has_toplevel_focus: int has_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.Window iconify()
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: int is_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 lower: GTK2.Window lower()
Description: Lower this window if the window manager allows that.

Method maximize: GTK2.Window maximize()
Description: Maximize a window. Same caveats as iconify().

Method mnemonic_activate: int mnemonic_activate(int keyval, int modifier)
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.Window move(int x, int y)

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: int parse_geometry(string geometry)
Description: Parses a standard X geometry string.

Method present

GTK2.Window present()

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.Window present_with_time(int timestamp)
Description: Presents a window to the user with a timestamp. See present().

Method raise: GTK2.Window raise()
Description: Raise this window if the window manager allows that.

Method remove_accel_group: GTK2.Window remove_accel_group(GTK2.AccelGroup group)
Description: Reverses the effects of add_accel_group().

Method remove_mnemonic: GTK2.Window remove_mnemonic(int keyval, GTK2.Widget target)
Description: Removes a mnemonic from this window.

Method reshow_with_initial_size: GTK2.Window reshow_with_initial_size()
Description: Hides the window, then reshows it, resetting the default size and position of the window.

Method resize: GTK2.Window resize(int width, int height)
Description: Resizes the window as if the user had done so, obeying geometry constraints.

Method set_accept_focus: GTK2.Window set_accept_focus(int setting)
Description: Windows may set a hint asking the desktop environment not to receive the input focus.

Method set_decorated: GTK2.Window set_decorated(int setting)
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.Window set_default(GTK2.Widget child)
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.Window set_default_size(int width, int height)

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.Window set_deletable(int setting)

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.Window set_destroy_with_parent(int setting)
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.Window set_focus(GTK2.Widget child)
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.Window set_focus_on_map(int setting)
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.Window set_geometry_hints(GTK2.Widget widget, mapping geometry)
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_STATIC and GDK_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.Window set_gravity(int gravity)

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.Window set_icon(GTK2.GdkPixbuf icon)

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_from_file: int set_icon_from_file(string filename)
Description: Sets the icon from a file.

Method set_icon_list

GTK2.Window set_icon_list(array list)

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.Window set_icon_name(string name)
Description: Sets the icon for the window from a named themed icon.

Method set_keep_above: GTK2.Window set_keep_above(int setting)
Description: Keep window above.

Method set_keep_below: GTK2.Window set_keep_below(int setting)
Description: Keep window below.

Method set_mnemonic_modifier: GTK2.Window set_mnemonic_modifier(int modifier)
Description: Sets the mnemonic modifer for this window.

Method set_modal: GTK2.Window set_modal(int setting)
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.Window set_opacity(float opacity)
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.Window set_position(int pos)
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.Window set_resizable(int setting)
Description: Sets whether the user can resize a window. Windows are user resizable by default.

Method set_skip_pager_hint: GTK2.Window set_skip_pager_hint(int setting)
Description: Windows may set a hint asking the desktop environment not to display the window in the pager.

Method set_skip_taskbar_hint: GTK2.Window set_skip_taskbar_hint(int setting)
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.Window set_startup_id(string id)
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.Window set_title(string title)
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.Window set_transient_for(GTK2.Window parent)
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.Window set_type_hint(int hint)
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_TOOLBAR and GDK_WINDOW_TYPE_HINT_UTILITY

Method set_urgency_hint: GTK2.Window set_urgency_hint(int setting)
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.Window set_wmclass(string name, string class)
Description: Set the window manager application name and class.

Method stick: GTK2.Window stick()
Description: Makes this window sticky. Same caveats as iconify().

Method unfullscreen: GTK2.Window unfullscreen()
Description: Opposite of fullscreen().

Method unmaximize: GTK2.Window unmaximize()
Description: Opposite of maximize().

Method unstick: GTK2.Window unstick()
Description: Opposite of stick().

Class GTK2.WindowGroup

Description: Limit the effect of grabs.

Inherit Object: inherit G.Object : Object

Method add_window: GTK2.WindowGroup add_window(GTK2.Window window)
Description: Add a window.

Method create: GTK2.WindowGroup GTK2.WindowGroup()
Description: Creates a new GTK2.WindowGroup object. Grabs added with GTK2.grab_add() only affect windows with the same GTK2.WindowGroup.

Method remove_window: GTK2.WindowGroup remove_window(GTK2.Window window)
Description: Remove a window.

Class GTK2.build_pgtk

Class GTK2.build_pgtk.Class

Variable name
Variable file
Variable line: string GTK2.build_pgtk.Class.name
string|zero GTK2.build_pgtk.Class.file
int GTK2.build_pgtk.Class.line

Method __create__: protected local void __create__(string name, string|zero file, int line)

Method create: GTK2.build_pgtk.Class GTK2.build_pgtk.Class(string name, string|zero file, int line)

Class GTK2.build_pgtk.Class.Ref

Variable file
Variable line
Variable c: string GTK2.build_pgtk.Class.Ref.file
int GTK2.build_pgtk.Class.Ref.line
Class GTK2.build_pgtk.Class.Ref.c

Method __create__: protected local void __create__(string file, int line, Class c)

Method create: GTK2.build_pgtk.Class.Ref GTK2.build_pgtk.Class.Ref(string file, int line, Class c)

Class GTK2.build_pgtk.Constant

Variable name
Variable type
Variable file
Variable line: string GTK2.build_pgtk.Constant.name
Type GTK2.build_pgtk.Constant.type
string GTK2.build_pgtk.Constant.file
int GTK2.build_pgtk.Constant.line

Method __create__: protected local void __create__(string name, Type type, string file, int line)

Method create: GTK2.build_pgtk.Constant GTK2.build_pgtk.Constant(string name, Type type, string file, int line)

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: Class GTK2.build_pgtk.GtkFunction.parent
string GTK2.build_pgtk.GtkFunction.name
Type|zero GTK2.build_pgtk.GtkFunction.return_type
array(Type) GTK2.build_pgtk.GtkFunction.arg_types
array(string) GTK2.build_pgtk.GtkFunction.arg_names
mixed GTK2.build_pgtk.GtkFunction.body
array GTK2.build_pgtk.GtkFunction.require
string GTK2.build_pgtk.GtkFunction.doc
string GTK2.build_pgtk.GtkFunction.file
int GTK2.build_pgtk.GtkFunction.line

Method __create__: protected local void __create__(Class parent, string name, Type|zero return_type, array(Type) arg_types, array(string) arg_names, mixed body, array require, string doc, string file, int line)

Method create: GTK2.build_pgtk.GtkFunction GTK2.build_pgtk.GtkFunction(Class parent, string name, Type|zero return_type, array(Type) arg_types, array(string) arg_names, mixed body, array require, string doc, string file, int line)

Class GTK2.build_pgtk.Member

Variable name
Variable type
Variable set
Variable file
Variable line
Variable parent: string GTK2.build_pgtk.Member.name
Type GTK2.build_pgtk.Member.type
int GTK2.build_pgtk.Member.set
string GTK2.build_pgtk.Member.file
int GTK2.build_pgtk.Member.line
Class GTK2.build_pgtk.Member.parent

Method __create__: protected local void __create__(string name, Type type, int set, string file, int line, Class parent)

Method create: GTK2.build_pgtk.Member GTK2.build_pgtk.Member(string name, Type type, int set, string file, int line, Class parent)

Class GTK2.build_pgtk.Property

Inherit Member: inherit Member : Member

Variable name
Variable type
Variable set
Variable file
Variable line
Variable parent: string GTK2.build_pgtk.Property.name
Type GTK2.build_pgtk.Property.type
int GTK2.build_pgtk.Property.set
string GTK2.build_pgtk.Property.file
int GTK2.build_pgtk.Property.line
Class GTK2.build_pgtk.Property.parent

Method __create__: protected local void __create__(string name, Type type, int set, string file, int line, Class parent)

Method create: GTK2.build_pgtk.Property GTK2.build_pgtk.Property(string name, Type type, int set, string file, int line, Class parent)

Class GTK2.build_pgtk.Signal

Variable name: string GTK2.build_pgtk.Signal.name

Method __create__: protected local void __create__(string name)

Method create: GTK2.build_pgtk.Signal GTK2.build_pgtk.Signal(string name)

Module GTK2.G

Class GTK2.G.InitiallyUnowned

Description: Abstract class - do not instantiate

Inherit Object: inherit G.Object : Object

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: protected G.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.Object accel_groups_activate(int accel_key, int accel_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 get_data: object get_data(string name)
Description: Gets a named field from the object.

Method get_docs: string get_docs()
Description: Get documentation on object

Method get_property: mixed get_property(string property)
Description: Get a property.

Method is_floating: int is_floating()
Description: Checks whether this object has a floating reference.

Method new_signal: int new_signal(string name, array types, string return_type)
Description: Create a new signal.

Method notify: G.Object notify(string property)
Description: Emits a "notify" signal for the named property on the object.

Method set_data

object set_data(string name, mixed arg)

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.Object set_property(string property, mixed value)
Description: Set a property on a G.Object (and any derived types) to value.

Method signal_block: G.Object signal_block(int signal_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

int signal_connect(string signal, function(:void) callback, mixed|void callback_arg, string|void detail, int|void connect_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.Object signal_disconnect(int signal_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.Object signal_emit(string signal_name, string|void detail)
Description: Send the current named signal.

Method signal_stop: G.Object signal_stop(string signal_name)
Description: Stop the emission of a signal.

Method signal_unblock: G.Object signal_unblock(int signal_id)
Description: Unblock a formerly blocked signal handler. See signal_block() and signal_connect() for more info.

Module GTK2.Pango

Class GTK2.Pango.AttrList

Description: A PangoAttrList.

Method copy: GTK2.Pango.AttrList copy()
Description: Copy the list.

Method create: GTK2.Pango.AttrList GTK2.Pango.AttrList()
Description: Create a new empty attribute list.

Class GTK2.Pango.Context

Description: PangoContext.

Inherit Object: inherit G.Object : Object

Class GTK2.Pango.FontDescription

Description: Pango Font Description.

Method better_match: int better_match(GTK2.Pango.FontDescription new, GTK2.Pango.FontDescription old)
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 copy: GTK2.Pango.FontDescription copy()
Description: Copy a font description.

Method create: GTK2.Pango.FontDescription GTK2.Pango.FontDescription(string|void desc)
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: int equal(GTK2.Pango.FontDescription desc)
Description: Compares two font descriptions for equality.

Method get_family: string get_family()
Description: Gets the family name.

Method get_size: int get_size()
Description: Gets the size.

Method get_stretch: int get_stretch()
Description: Get the stretch.

Method get_style: int get_style()
Description: Gets the style.

Method get_variant: int get_variant()
Description: Gets the variant.

Method get_weight: int get_weight()
Description: Gets the weight.

Method merge: Pango.FontDescription merge(GTK2.Pango.FontDescription desc, int replace)
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.FontDescription set_family(string family)
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.FontDescription set_size(int size)
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.FontDescription set_stretch(int stretch)
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_CONDENSED and PANGO_STRETCH_ULTRA_EXPANDED.

Method set_style: Pango.FontDescription set_style(int style)
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_NORMAL and PANGO_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.FontDescription set_variant(int variant)
Description: Sets the variant. One of PANGO_VARIANT_NORMAL and PANGO_VARIANT_SMALL_CAPS.

Method set_weight: Pango.FontDescription set_weight(int weight)
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_ULTRABOLD and PANGO_WEIGHT_ULTRALIGHT, other intermediate numeric values are possible.

Method to_filename: string to_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.

Method to_string: string to_string()
Description: Creates a string representation. The family list in the string description will only have a terminating comm if the last word of the list is a valid style option.

Class GTK2.Pango.Layout

Description: Pango Layout.

Inherit Object: inherit G.Object : Object

Method context_changed: Pango.Layout context_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 copy: GTK2.Pango.Layout copy(GTK2.Pango.Layout src)
Description: Does a copy of the src.

Method create: GTK2.Pango.Layout GTK2.Pango.Layout(GTK2.Pango.Context context)
Description: Create a new layout with attributes initialized to default values for a particular Pango.Context

Method get_alignment: int get_alignment()
Description: Gets the alignment.

Method get_auto_dir: int get_auto_dir()
Description: Gets whether to calculate the bidirectional base direction for the layout according to the contents of the layout.

Method get_context: GTK2.Pango.Context get_context()
Description: Returns the Pango.Context.

Method get_cursor_pos: array get_cursor_pos(int index)
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: int get_indent()
Description: Gets the paragraph indent in pango units. A negative value indicates a hanging indent.

Method get_justify: int get_justify()
Description: Gets whether or not each complete line should be stretched to fill the entire width of the layout.

Method get_line: GTK2.Pango.LayoutLine get_line(int line)
Description: Retrieves a specific line.

Method get_line_count: int get_line_count()
Description: Retrieves the count of lines.

Method get_single_paragraph_mode: int get_single_paragraph_mode()
Description: Gets the value set by set_single_paragraph_mode().

Method get_size: mapping get_size()
Description: Determines the logical width and height in Pango units.

Method get_spacing: int get_spacing()
Description: Gets the amount of spacing between the lines.

Method get_tabs: GTK2.Pango.TabArray get_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 get_text: string get_text()
Description: Gets the text.

Method get_width: int get_width()
Description: Gets the line wrap width.

Method get_wrap: int get_wrap()
Description: Gets the wrap mode for the layout.

Method index_to_pos

mapping index_to_pos(int index)

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

mapping move_cursor_visually(int strong, int old_index, int old_trailing, int dir)

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.Layout set_alignment(int alignment)
Description: Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.) One of PANGO_ALIGN_CENTER, PANGO_ALIGN_LEFT and PANGO_ALIGN_RIGHT.

Method set_auto_dir

Pango.Layout set_auto_dir(int auto_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.Layout set_font_description(GTK2.Pango.FontDescription desc)
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.Layout set_indent(int indent)
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.Layout set_justify(int justify)
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.Layout set_markup(string markup, int length)
Description: Same as set_markup_with_accel(), but the markup text isn't scanned for accelerators.

Method set_markup_with_accel

Pango.Layout set_markup_with_accel(string markup, int length, int|void accel_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.Layout set_single_paragraph_mode(int setting)
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.Layout set_spacing(int spacing)
Description: Sets the amount of spacing between the lines.

Method set_tabs: Pango.Layout set_tabs(GTK2.Pango.TabArray tabs)
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.Layout set_text(sprintf_format text, sprintf_args ... fmt)
Description: Sets the text of the layout.

Method set_width: Pango.Layout set_width(int width)
Description: Sets the width to which the lines should be wrapped.

Method set_wrap: Pango.Layout set_wrap(int wrap)
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_WORD and PANGO_WRAP_WORD_CHAR.

Method xy_to_index

mapping xy_to_index(int x, int y)

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: int at_last_line()
Description: Determines whether this iter is on the last line of the layout.

Method get_baseline: int get_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: mapping get_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: array get_cluster_extents()
Description: Gets the extents of the current cluster, in layout coordinates.

Method get_index: int get_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_layout_extents: array get_layout_extents()
Description: Obtains the extents of the layout.

Method get_line: GTK2.Pango.LayoutLine get_line()
Description: Gets the current line.

Method get_line_extents: array get_line_extents()
Description: Obtains the extents of the current line.

Method get_line_yrange: array get_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: array get_run_extents()
Description: Gets the extents of the current run in layout coordinates.

Method next_char: int next_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: int next_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: int next_line()
Description: Moves forward to the start of the next line. If it is already on the last line, returns false.

Method next_run: int next_run()
Description: Moves forward to the next run in visual order. If it was already at the end of the layout, returns false.

Class GTK2.Pango.LayoutLine

Description: PangoLayoutLine.

Method get_extents: array get_extents()
Description: Computes the logical and ink extents of a layout line.

Method get_pixel_extents: array get_pixel_extents()
Description: Computes the logical and ink extents of a layout line, in device units.

Method index_to_x: int index_to_x(int index, int trailing)
Description: Converts an index within a line to an x position.

Method x_to_index: mapping x_to_index(int x_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.

Inherit Object: inherit G.Object : Object

Method copy: GTK2.Pango.TabArray copy()
Description: Returns a copy.

Method create: GTK2.Pango.TabArray GTK2.Pango.TabArray(int initial_size, int position_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: int get_positions_in_pixels()
Description: Returns true if the tab positions are in pixels, false if they are in Pango units.

Method get_size: int get_size()
Description: Gets the number of tab stops.

Method get_tab: mapping get_tab(int tab_index)
Description: Gets the alignment and position of a tab stop.

Method get_tabs: array get_tabs()
Description: Gets alignments and locations of all tab stops.

Method resize: Pango.TabArray resize(int new_size)
Description: Resizes the array. You must subsequently initialize any tabs that were added as a result of growing the array.

Method set_tab: Pango.TabArray set_tab(int tab_index, int alignment, int location)
Description: Sets the alignment and location of a tab stop. Alignment must always be PANGO_TAB_LEFT.

Module GDK

Description

GDK wrapper module.

This is a convenience module that is identical to either either the GDK2 or the GDK1 module depending on which (if any) of them is available.

See also

GDK1, GDK2

Constant Atom: constant GDK.Atom

Module GDK2

Constant Atom: constant GDK2.Atom

16. Graphic User Interface

Module GTK

Module GTK2

Class GTK2.AboutDialog

Class GTK2.AccelGroup

Class GTK2.AccelLabel

Class GTK2.Action

Class GTK2.ActionGroup

Class GTK2.Activatable

Class GTK2.Adjustment

Class GTK2.Alignment

Class GTK2.Allocation

Class GTK2.Arrow

Class GTK2.AspectFrame

Class GTK2.Assistant

Class GTK2.Bin

Class GTK2.Box

Class GTK2.Button

Class GTK2.ButtonBox

Class GTK2.Calendar

Class GTK2.CellEditable

Class GTK2.CellLayout

Class GTK2.CellRenderer

Class GTK2.CellRendererAccel

Class GTK2.CellRendererCombo

Class GTK2.CellRendererPixbuf

Class GTK2.CellRendererProgress

Class GTK2.CellRendererSpin

Class GTK2.CellRendererText

Class GTK2.CellRendererToggle

Class GTK2.CellView

Class GTK2.CheckButton

Class GTK2.CheckMenuItem

Class GTK2.Clipboard

Class GTK2.ColorButton

Class GTK2.ColorSelection

Class GTK2.ColorSelectionDialog

Class GTK2.ComboBox

Class GTK2.ComboBoxEntry

Class GTK2.Container

Class GTK2.Data

Class GTK2.Databox

Class GTK2.Dialog

Class GTK2.DrawingArea

Class GTK2.Editable

Class GTK2.Entry

Class GTK2.EntryCompletion

Class GTK2.EventBox

Class GTK2.Expander

Class GTK2.FileChooser

Class GTK2.FileChooserButton

Class GTK2.FileChooserDialog

Class GTK2.FileChooserWidget

Class GTK2.FileFilter

Class GTK2.FileSelection

Class GTK2.Fixed

Class GTK2.FontButton

Class GTK2.FontSelection

Class GTK2.FontSelectionDialog

Class GTK2.Frame

Class GTK2.GdkBitmap

Class GTK2.GdkColor

Class GTK2.GdkColormap

Class GTK2.GdkDisplay

Class GTK2.GdkDragContext

Class GTK2.GdkDrawable

Class GTK2.GdkEvent

Class GTK2.GdkGC

Class GTK2.GdkImage

Class GTK2.GdkPixbuf

Class GTK2.GdkPixbufAnimation

Class GTK2.GdkPixbufAnimationIter

Class GTK2.GdkPixbufLoader

Class GTK2.GdkPixbufSimpleAnim

Class GTK2.GdkPixmap

Class GTK2.GdkRectangle

Class GTK2.GdkRegion

Class GTK2.GdkScreen

Class GTK2.GdkVisual

Class GTK2.GdkWindow