|
Modules
ADT
Database
GTK2
GUI
IP
PiJAX
Public
Sql
Stdio
Subversion
System
Tools
Xosd
lua
v4l2
wx
Recent Changes
Public.Parser.XML2 1.50
Public.ZeroMQ 1.1
Public.Template.Mustache 1.0
Public.Protocols.XMPP 1.4
Sql.Provider.jdbc 1.0
Popular Downloads
Public.Parser.JSON2 1.0
Public.Parser.JSON 0.2
GTK2 2.23
Public.Web.FCGI 1.8
Public.Parser.XML2 1.48
|
Pike Module Reference: module version 2.15, prepared
| CLASS GTK.refdoc.GDK.Bitmap |
Methods
create()
destroy()
ref()
unref()
|
- Description
A bitmap is a black and white pixmap. Most commonly used as masks
for images, widgets and pixmaps.
NOIMG
-
Inherit Drawable
GDK.Drawable
-
Method create
object(GDK.Bitmap) GTK.refdoc.GDK.Bitmap()->create(int|object(Image.Image) xsize_or_image, int|void ysize, string|void bitmap)
- Description
Create a new GDK.Bitmap object.
Argument is either an Image.image object, or {xsisze,ysize,xbitmapdata}.
-
Method destroy
object(GDK.Bitmap) GTK.refdoc.GDK.Bitmap()->destroy()
- Description
Destructor. Destroys the bitmap. This will free the bitmap on the X-server.
-
Method ref
object(GDK.Bitmap) GTK.refdoc.GDK.Bitmap()->ref()
- Description
Add a reference
-
Method unref
object(GDK.Bitmap) GTK.refdoc.GDK.Bitmap()->unref()
- Description
Remove a reference
|
| CLASS GTK.refdoc.GDK.Color |
Methods
blue()
create()
destroy()
green()
image_color_object()
pixel()
red()
rgb()
|
- Description
The GDK.Color object is used to represent a color.
When you call GDK.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 blue
int GTK.refdoc.GDK.Color()->blue()
- Description
Returns the blue color component.
-
Method create
object(GDK.Color) GTK.refdoc.GDK.Color()->create(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 destroy
object(GDK.Color) GTK.refdoc.GDK.Color()->destroy()
- 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 green
int GTK.refdoc.GDK.Color()->green()
- Description
Returns the green color component.
-
Method image_color_object
object(Image.Color.Color) GTK.refdoc.GDK.Color()->image_color_object()
- Description
Return a Image.Color.Color instance.
This gives better precision than the rgb function.
-
Method pixel
int GTK.refdoc.GDK.Color()->pixel()
- Description
Returns the pixel value of the color. See GDK.Image->set_pixel.
-
Method red
int GTK.refdoc.GDK.Color()->red()
- Description
Returns the red color component.
-
Method rgb
array GTK.refdoc.GDK.Color()->rgb()
- Description
Returns the red green and blue color components as an array.
|
| CLASS GTK.refdoc.GDK.Image |
Methods
create()
destroy()
get_pixel()
get_pnm()
grab()
set()
set_pixel()
|
- Description
A gdk (low level) image.
Mainly used for W(Image) objects.
NOIMG
-
Inherit Object
G.Object
-
Method create
object(GDK.Image) GTK.refdoc.GDK.Image()->create(int|void fast_mode, object(Image.Image)|void image)
- Description
Create a new GDK.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 destroy
object(GDK.Image) GTK.refdoc.GDK.Image()->destroy()
- Description
Destructor. Destroys the image. Automatically called by pike when
the object is destructed.
-
Method get_pixel
int GTK.refdoc.GDK.Image()->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 GTK.refdoc.GDK.Image()->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
object(GDK.Image) GTK.refdoc.GDK.Image()->grab(object(GTK.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
object(GDK.Image) GTK.refdoc.GDK.Image()->set(object(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
object(GDK.Image) GTK.refdoc.GDK.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 GTK.refdoc.GDK._Atom |
Methods
create()
get_name()
|
- Description
An X-atom. You most likely want to use GDK.Atom.atom_name
instead of GDK._Atom(name).
-
Method create
object(GDK._Atom) GTK.refdoc.GDK._Atom()->create(string atom_name, int|void only_if_exists)
- Description
Create a new low-level atom. You should normally not call this
function directly. Use GDK.Atom[name] instead of GDK._Atom(name,0).
-
Method get_name
string GTK.refdoc.GDK._Atom()->get_name()
- Description
Returns the name of the atom.
|
| CLASS GTK.refdoc.GDK.Window |
Methods
change_property()
children()
create()
delete_property()
get_geometry()
get_property()
is_viewable()
is_visible()
lower()
move_resize()
raise()
set_background()
set_bitmap_cursor()
set_cursor()
set_events()
set_icon()
set_icon_name()
shape_combine_mask()
|
- Description
a GDK.Window object.
NOIMG
-
Inherit Drawable
GDK.Drawable
-
Method change_property
object(GDK.Window) GTK.refdoc.GDK.Window()->change_property(object(GDK.Atom) property, object(GDK.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 GTK.refdoc.GDK.Window()->children()
- Description
Returns an array of GDK.Window objects.
-
Method create
object(GDK.Window) GTK.refdoc.GDK.Window()->create(object(GDK.Window) parent, mapping|void attributes)
- Description
Not for non-experts. I promise.
-
Method delete_property
object(GDK.Window) GTK.refdoc.GDK.Window()->delete_property(object(GDK.Atom) a)
- Description
Delete a property.
-
Method get_geometry
mapping GTK.refdoc.GDK.Window()->get_geometry()
- Description
Returns ([ "x":xpos, "y":ypos, "width":width, "height":height, "depth":bits_per_pixel ])
-
Method get_property
mapping GTK.refdoc.GDK.Window()->get_property(object(GDK.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 GDK.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)
GDK.Window root = GTK.root_window();
array maybe=root->children()->
get_property(GDK.Atom.__SWM_VROOT)-({0});
if(sizeof(maybe))
root=GDK.Window( maybe[0]->data[0] );
-
Method is_viewable
int GTK.refdoc.GDK.Window()->is_viewable()
- Description
Return 1 if the window is mapped.
-
Method is_visible
int GTK.refdoc.GDK.Window()->is_visible()
- Description
Return 1 if the window, or a part of the window, is visible right now.
-
Method lower
object(GDK.Window) GTK.refdoc.GDK.Window()->lower()
- Description
Lower this window if the window manager allows that.
-
Method move_resize
object(GDK.Window) GTK.refdoc.GDK.Window()->move_resize(int x, int y, int w, int h)
- Description
Move and resize the window in one call.
-
Method raise
object(GDK.Window) GTK.refdoc.GDK.Window()->raise()
- Description
Raise this window if the window manager allows that.
-
Method set_background
object(GDK.Window) GTK.refdoc.GDK.Window()->set_background(object(GDK.Color) to)
- Description
Set the background color or image.
The argument is either a GDK.Pixmap or a GDK.Color object.
-
Method set_bitmap_cursor
object(GDK.Window) GTK.refdoc.GDK.Window()->set_bitmap_cursor(object(GDK.Bitmap) image, object(GDK.Bitmap) mask, object(GDK.Color) fg, object(GDK.Color) 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
object(GDK.Window) GTK.refdoc.GDK.Window()->set_cursor(int new_cursor)
- Description
Change the window cursor.<table border="0" cellpadding="3" cellspacing="0">
CURS(GDK.Arrow)
CURS(GDK.BasedArrowDown)
CURS(GDK.BasedArrowUp)
CURS(GDK.Boat)
CURS(GDK.Bogosity)
CURS(GDK.BottomLeftCorner)
CURS(GDK.BottomRightCorner)
CURS(GDK.BottomSide)
CURS(GDK.BottomTee)
CURS(GDK.BoxSpiral)
CURS(GDK.CenterPtr)
CURS(GDK.Circle)
CURS(GDK.Clock)
CURS(GDK.CoffeeMug)
CURS(GDK.Cross)
CURS(GDK.CrossReverse)
CURS(GDK.Crosshair)
CURS(GDK.DiamondCross)
CURS(GDK.Dot)
CURS(GDK.Dotbox)
CURS(GDK.DoubleArrow)
CURS(GDK.DraftLarge)
CURS(GDK.DraftSmall)
CURS(GDK.DrapedBox)
CURS(GDK.Exchange)
CURS(GDK.Fleur)
CURS(GDK.Gobbler)
CURS(GDK.Gumby)
CURS(GDK.Hand1)
CURS(GDK.Hand2)
CURS(GDK.Heart)
CURS(GDK.Icon)
CURS(GDK.IronCross)
CURS(GDK.LeftPtr)
CURS(GDK.LeftSide)
CURS(GDK.LeftTee)
CURS(GDK.Leftbutton)
CURS(GDK.LlAngle)
CURS(GDK.LrAngle)
CURS(GDK.Man)
CURS(GDK.Middlebutton)
CURS(GDK.Mouse)
CURS(GDK.Pencil)
CURS(GDK.Pirate)
CURS(GDK.Plus)
CURS(GDK.QuestionArrow)
CURS(GDK.RightPtr)
CURS(GDK.RightSide)
CURS(GDK.RightTee)
CURS(GDK.Rightbutton)
CURS(GDK.RtlLogo)
CURS(GDK.Sailboat)
CURS(GDK.SbDownArrow)
CURS(GDK.SbHDoubleArrow)
CURS(GDK.SbLeftArrow)
CURS(GDK.SbRightArrow)
CURS(GDK.SbUpArrow)
CURS(GDK.SbVDoubleArrow)
CURS(GDK.Shuttle)
CURS(GDK.Sizing)
CURS(GDK.Spider)
CURS(GDK.Spraycan)
CURS(GDK.Star)
CURS(GDK.Target)
CURS(GDK.Tcross)
CURS(GDK.TopLeftArrow)
CURS(GDK.TopLeftCorner)
CURS(GDK.TopRightCorner)
CURS(GDK.TopSide)
CURS(GDK.TopTee)
CURS(GDK.Trek)
CURS(GDK.UlAngle)
CURS(GDK.Umbrella)
CURS(GDK.UrAngle)
CURS(GDK.Watch)
CURS(GDK.Xterm)
</table>
-
Method set_events
object(GDK.Window) GTK.refdoc.GDK.Window()->set_events(int events)
- Description
events is a bitwise or of one or more of the following constants:
GDK.ExposureMask,
GDK.PointerMotionMask,
GDK.PointerMotion_HINTMask,
GDK.ButtonMotionMask,
GDK.Button1MotionMask,
GDK.Button2MotionMask,
GDK.Button3MotionMask,
GDK.ButtonPressMask,
GDK.ButtonReleaseMask,
GDK.KeyPressMask,
GDK.KeyReleaseMask,
GDK.EnterNotifyMask,
GDK.LeaveNotifyMask,
GDK.FocusChangeMask,
GDK.StructureMask,
GDK.PropertyChangeMask,
GDK.VisibilityNotifyMask,
GDK.ProximityInMask,
GDK.ProximityOutMask and
GDK.AllEventsMask
-
Method set_icon
object(GDK.Window) GTK.refdoc.GDK.Window()->set_icon(object(GDK.Pixmap) pixmap, object(GDK.Bitmap) mask, object(GDK.Window) window)
- Description
Set the icon to the specified image (with mask) or the specified
GDK.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
object(GDK.Window) GTK.refdoc.GDK.Window()->set_icon_name(string name)
- Description
Set the icon name to the specified string.
-
Method shape_combine_mask
object(GDK.Window) GTK.refdoc.GDK.Window()->shape_combine_mask(object(GDK.Bitmap) mask, int xoffset, int yoffset)
- Description
Set the shape of the widget, or, rather, it's window, to that of
the supplied bitmap.
|
| CLASS GTK.refdoc.GDK.DragContext |
Methods
drag_abort()
drag_drop()
drag_finish()
drag_set_icon_default()
drag_set_icon_pixmap()
drag_set_icon_widget()
drag_status()
drop_reply()
get_action()
get_actions()
get_is_source()
get_protocol()
get_source_widget()
get_start_time()
get_suggested_action()
|
- 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
object(GDK.DragContext) GTK.refdoc.GDK.DragContext()->drag_abort(int time)
- Description
Abort the drag
-
Method drag_drop
object(GDK.DragContext) GTK.refdoc.GDK.DragContext()->drag_drop(int time)
- Description
Drag drop.
-
Method drag_finish
object(GDK.DragContext) GTK.refdoc.GDK.DragContext()->drag_finish(int success, int del, int time)
- 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
object(GDK.DragContext) GTK.refdoc.GDK.DragContext()->drag_set_icon_default()
- Description
Use the default drag icon associated with the source widget.
-
Method drag_set_icon_pixmap
object(GDK.DragContext) GTK.refdoc.GDK.DragContext()->drag_set_icon_pixmap(object(GDK.Pixmap) p, object(GDK.Bitmap) 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
object(GDK.DragContext) GTK.refdoc.GDK.DragContext()->drag_set_icon_widget(object(GTK.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
object(GDK.DragContext) GTK.refdoc.GDK.DragContext()->drag_status(int action, int time)
- Description
Setting action to -1 means use the suggested action
-
Method drop_reply
object(GDK.DragContext) GTK.refdoc.GDK.DragContext()->drop_reply(int ok, int time)
- Description
Drop reply.
-
Method get_action
int GTK.refdoc.GDK.DragContext()->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 GTK.refdoc.GDK.DragContext()->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 GTK.refdoc.GDK.DragContext()->get_is_source()
- Description
Is this application the source?
-
Method get_protocol
int GTK.refdoc.GDK.DragContext()->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
object(GTK.Widget) GTK.refdoc.GDK.DragContext()->get_source_widget()
- Description
Return the drag source widget.
-
Method get_start_time
int GTK.refdoc.GDK.DragContext()->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 GTK.refdoc.GDK.DragContext()->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 GTK.refdoc.GDK.Drawable |
Methods
clear()
copy_area()
draw_arc()
draw_bitmap()
draw_image()
draw_line()
draw_pixmap()
draw_point()
draw_rectangle()
draw_text()
get_geometry()
xid()
xsize()
ysize()
|
- Description
The GDK.Bitmap, GDK.Window and GDK.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 GDK.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 GDK.Window or a W(Widget)
-
Inherit Object
G.Object
-
Method clear
object(GDK.Drawable) GTK.refdoc.GDK.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
object(GDK.Drawable) GTK.refdoc.GDK.Drawable()->copy_area(object(GDK.GC) gc, int xdest, int ydest, object(GTK.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
object(GDK.Drawable) GTK.refdoc.GDK.Drawable()->draw_arc(object(GDK.GC) 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
object(GDK.Drawable) GTK.refdoc.GDK.Drawable()->draw_bitmap(object(GDK.GC) gc, object(GDK.Bitmap) bitmap, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
- Description
Draw a GDK(Bitmap) in this drawable.
NOTE: This drawable must be a bitmap as well. This will be
fixed in GTK 1.3
-
Method draw_image
object(GDK.Drawable) GTK.refdoc.GDK.Drawable()->draw_image(object(GDK.GC) gc, object(GDK.Image) 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
GDK(Image) at xdest,ydest in the destination drawable
-
Method draw_line
object(GDK.Drawable) GTK.refdoc.GDK.Drawable()->draw_line(object(GDK.GC) gc, int x1, int y1, int x2, int y2)
- Description
img_begin
w = GTK.DrawingArea()->set_usize(100,100);
delay: g = GDK.GC(w)->set_foreground( GDK.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_pixmap
object(GDK.Drawable) GTK.refdoc.GDK.Drawable()->draw_pixmap(object(GDK.GC) gc, object(GDK.Pixmap) 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
GDK(Pixmap) at xdest,ydest in the destination drawable
-
Method draw_point
object(GDK.Drawable) GTK.refdoc.GDK.Drawable()->draw_point(object(GDK.GC) gc, int x, int y)
- Description
img_begin
w = GTK.DrawingArea()->set_usize(10,10);
delay: g = GDK.GC(w)->set_foreground( GDK.Color(255,0,0) );
delay: for(int x = 0; x<10; x++) w->draw_point(g, x, x);
img_end
-
Method draw_rectangle
object(GDK.Drawable) GTK.refdoc.GDK.Drawable()->draw_rectangle(object(GDK.GC) gc, int filledp, int x1, int y1, int x2, int y2)
- Description
img_begin
w = GTK.DrawingArea()->set_usize(100,100);
delay: g = GDK.GC(w)->set_foreground( GDK.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 = GTK.DrawingArea()->set_usize(100,100);
delay: g = GDK.GC(w);
delay: for(int x = 0; x<30; x++) {
delay: g->set_foreground(GDK.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
object(GDK.Drawable) GTK.refdoc.GDK.Drawable()->draw_text(object(GDK.GC) gc, int x, int y, string text)
- Description
y is used as the baseline for the text.
-
Method get_geometry
mapping GTK.refdoc.GDK.Drawable()->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 xid
int GTK.refdoc.GDK.Drawable()->xid()
- Description
Return the xwindow id.
-
Method xsize
int GTK.refdoc.GDK.Drawable()->xsize()
- Description
Returns the width of the drawable specified in pixels
-
Method ysize
int GTK.refdoc.GDK.Drawable()->ysize()
- Description
Returns the height of the drawable specified in pixels
|
| CLASS GTK.refdoc.GDK.Rectangle |
Methods
cast()
create()
destroy()
set()
|
- Description
Rectangle class.
-
Method cast
mixed GTK.refdoc.GDK.Rectangle()->cast(string type)
- Description
Normally used like (mapping)rectangle or (array)rectangle.
-
Method create
object(GDK.Rectangle) GTK.refdoc.GDK.Rectangle()->create(int x, int y, int width, int height)
- Description
Create a new rectangle
NOIMG
-
Method destroy
object(GDK.Rectangle) GTK.refdoc.GDK.Rectangle()->destroy()
- Description
Destroy rectangle.
-
Method set
object(GDK.Rectangle) GTK.refdoc.GDK.Rectangle()->set(int x, int y, int width, int height)
- Description
Set the upper left corner and the size of the rectangle.
|
| CLASS GTK.refdoc.GDK.PixbufAnimation |
Methods
create()
get_height()
get_iter()
get_static_image()
get_width()
is_static_image()
|
- Description
The GdkPixbufAnimation object. Holds animations, like gifs.
-
Inherit Object
G.Object
-
Method create
object(GDK.PixbufAnimation) GTK.refdoc.GDK.PixbufAnimation()->create(string filename)
- Description
Create a new PixbufAnimation.
-
Method get_height
int GTK.refdoc.GDK.PixbufAnimation()->get_height()
- Description
Returns the height of the bounding box.
-
Method get_iter
object(GDK.PixbufAnimationIter) GTK.refdoc.GDK.PixbufAnimation()->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
GDK.PixbufAnimationIter->get_pixbuf(). Then, you should install a timeout
or by some other mechanism ensure that you'll update the image after
GDK.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 GDK.PixbufAnimationIter->advance().
-
Method get_static_image
object(GDK.Pixbuf) GTK.refdoc.GDK.PixbufAnimation()->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 GTK.refdoc.GDK.PixbufAnimation()->get_width()
- Description
Returns the width of the bounding box.
-
Method is_static_image
int GTK.refdoc.GDK.PixbufAnimation()->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 GTK.refdoc.GDK.Pixmap |
Methods
create()
destroy()
ref()
set()
unref()
|
- Description
This class creates a GDK.Pixmap from either an GDK.Image or
Image.image object (or a numeric ID, see your X-manual for XIDs).
The GDK.Pixmap object can be used in a lot
of different GTK widgets. The most notable is the W(Pixmap)
widget.
NOIMG
-
Inherit Drawable
GDK.Drawable
-
Method create
object(GDK.Pixmap) GTK.refdoc.GDK.Pixmap()->create(int|object image)
- Description
Create a new GDK.Pixmap object.
Argument is a GDK.Image object or a Image.Image object
-
Method destroy
object(GDK.Pixmap) GTK.refdoc.GDK.Pixmap()->destroy()
- Description
Destructor. Destroys the pixmap.
-
Method ref
object(GDK.Pixmap) GTK.refdoc.GDK.Pixmap()->ref()
- Description
Ref this object.
-
Method set
object(GDK.Pixmap) GTK.refdoc.GDK.Pixmap()->set(object(GDK.Image) image)
- Description
Argument is a GDK.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
object(GDK.Pixmap) GTK.refdoc.GDK.Pixmap()->unref()
- Description
Unref this object.
|
| CLASS GTK.refdoc.GDK.Region |
Methods
create()
destroy()
equal()
intersect()
offset()
point_in()
rect_in()
shrink()
subtract()
union()
xor()
|
- Description
Region information.
-
Method create
object(GDK.Region) GTK.refdoc.GDK.Region()->create()
- Description
Create a new (empty) region
NOIMG
-
Method destroy
object(GDK.Region) GTK.refdoc.GDK.Region()->destroy()
- Description
Destructor.
-
Method equal
int GTK.refdoc.GDK.Region()->equal(object(GDK.Region) 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
object(GDK.Region) GTK.refdoc.GDK.Region()->intersect(object(GDK.Region) victim)
- Description
Computes the intersection of the given region and the region. Also
available as region & region
-
Method offset
object(GDK.Region) GTK.refdoc.GDK.Region()->offset(int dx, int dy)
- Description
Offset(move) the region by dx,dy pixels.
-
Method point_in
int GTK.refdoc.GDK.Region()->point_in(int x, int y)
- Description
Returns true if the given point resides in the given region
-
Method rect_in
int GTK.refdoc.GDK.Region()->rect_in(object(GDK.Rectangle) r)
- Description
Returns true if the given rectangle resides inside the given region
-
Method shrink
object(GDK.Region) GTK.refdoc.GDK.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
object(GDK.Region) GTK.refdoc.GDK.Region()->subtract(object(GDK.Region) victim)
- Description
Computes the difference of the given region and the region.
Also available as region - region
-
Method union
object(GDK.Region) GTK.refdoc.GDK.Region()->union(object(GDK.Region) 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
object(GDK.Region) GTK.refdoc.GDK.Region()->xor(object(GDK.Region) victim)
- Description
Computes the exlusive or of the given region and the region.
Also available as region ^ region
|
| CLASS GTK.refdoc.GDK.PixbufAnimationIter |
Methods
advance()
get_delay_time()
get_pixbuf()
on_currently_loading_frame()
|
- Description
An iterator for a PixbufAnimation.
-
Inherit Object
G.Object
-
Method advance
int GTK.refdoc.GDK.PixbufAnimationIter()->advance()
- Description
Possibly advance an animation to a new frame.
-
Method get_delay_time
int GTK.refdoc.GDK.PixbufAnimationIter()->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
object(GDK.Pixbuf) GTK.refdoc.GDK.PixbufAnimationIter()->get_pixbuf()
- Description
Gets the current pixbuf which should be displayed; the pixbuf will be the
same size as the animation itself (GDK.PixbufAnimation->get_width(),
GDK.PixbufAnimation->get_height()). This pixbuf should be displayed for
get_delay_time() milliseconds.
-
Method on_currently_loading_frame
int GTK.refdoc.GDK.PixbufAnimationIter()->on_currently_loading_frame()
- Description
Used to determine how to respond to the area_updated signal on
GDK.PixbufLoader when loading an animation.
|
| CLASS GTK.refdoc.GDK.Pixbuf |
Methods
add_alpha()
composite()
composite_color()
composite_color_simple()
copy()
copy_area()
create()
fill()
get_bits_per_sample()
get_colorspace()
get_has_alpha()
get_height()
get_n_channels()
get_option()
get_pixels()
get_rowstride()
get_width()
new_subpixbuf()
saturate_and_pixelate()
save()
scale()
scale_simple()
set_from_data()
set_from_file()
set_from_file_at_size()
set_from_inline()
set_from_xpm_data()
set_option()
|
- Description
Properties that can be notified:
int bits-per-sample
int colorspace (GdkColorspace)
int has-alpha
int height
int n-channels
object pixels
int rowstride
int width
-
Inherit Object
G.Object
-
Method add_alpha
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->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 full
transparent.
-
Method composite
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->composite(object(GDK.Pixbuf) 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
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->composite_color(object(GDK.Pixbuf) 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 destination image.
see composite_color_simple() for a simpler variant of this function
suitable for many tasks.
-
Method composite_color_simple
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->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
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->copy()
- Description
Creates a new GDK.Pixbuf with a copy of this one.
-
Method copy_area
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->copy_area(object(GDK.Pixbuf) dest, int src_x, int src_y, int width, 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
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->create(int|void has_alpha, int|void bits_per_sample, int|void width, int|void height)
- Description
Create a GDK.Pixbuf object.
-
Method fill
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->fill(array|mapping|int pixel)
- Description
Clears a pixbuf to the given RGBA value, converting the RGBA value
into the pixbuf's pixel format. The alpha will be ignored if the
pixbuf doesn't have an alpha channel.
-
Method get_bits_per_sample
int GTK.refdoc.GDK.Pixbuf()->get_bits_per_sample()
- Description
Queries the number of bits per color sample.
-
Method get_colorspace
int GTK.refdoc.GDK.Pixbuf()->get_colorspace()
- Description
Queries the color space.
-
Method get_has_alpha
int GTK.refdoc.GDK.Pixbuf()->get_has_alpha()
- Description
Queries whether a pixbuf has an alpha channel.
-
Method get_height
int GTK.refdoc.GDK.Pixbuf()->get_height()
- Description
Queries the height.
-
Method get_n_channels
int GTK.refdoc.GDK.Pixbuf()->get_n_channels()
- Description
Queries the number of channels.
-
Method get_option
string GTK.refdoc.GDK.Pixbuf()->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 GTK.refdoc.GDK.Pixbuf()->get_pixels()
- Description
Returns the pixel data as a string.
-
Method get_rowstride
int GTK.refdoc.GDK.Pixbuf()->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 GTK.refdoc.GDK.Pixbuf()->get_width()
- Description
Queries the width.
-
Method new_subpixbuf
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->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 saturate_and_pixelate
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->saturate_and_pixelate(object(GDK.Pixbuf) dest, float saturation, int pixelate)
- Description
Modifies 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
int GTK.refdoc.GDK.Pixbuf()->save(string filename, string type, string|void quality)
- 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
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->scale(object(GDK.Pixbuf) 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
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->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 GDK.INTERP_NEAREST if you want maximum speed
(but when scaling down GDK.INTERP_NEAREST is usually unusably ugly).
The default interp_type should be GDK.INTERP_BILINEAR which offers
reasonable quality and speed.
You can scale a sub-portion by create a sub-pixbuf with new_subpixbuf().
-
Method set_from_data
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->set_from_data(string data, int has_alpha, int width, int height, int rowstride)
- Description
Creates a new GDK.Pixbuf out of in-memory image data.
Currently only RGB images with 8 bits per sample are supported.
-
Method set_from_file
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->set_from_file(string filename)
- Description
Create a new pixbuf by loading an image from a file.
-
Method set_from_file_at_size
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->set_from_file_at_size(string filename, int width, int height)
- Description
Create a new pixbuf by loading an image from a file. The image
will be scaled to fit in the requested size, preserving the
image's aspect ratio.
-
Method set_from_inline
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->set_from_inline(int data_length, string data)
- Description
Create a GDK.Pixbuf from a flat representation that is suitable
for storing as inline data in a program.
If data_length is -1 it will disable length checks.
-
Method set_from_xpm_data
object(GDK.Pixbuf) GTK.refdoc.GDK.Pixbuf()->set_from_xpm_data(array data)
- Description
Creates a new pixbuf by parsing XPM data in memory.
-
Method set_option
int GTK.refdoc.GDK.Pixbuf()->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 GTK.refdoc.GDK.Display |
Methods
beep()
close()
create()
flush()
get_default_cursor_size()
get_default_group()
get_event()
get_maximal_cursor_size()
get_name()
get_pointer()
get_window_at_pointer()
keyboard_ungrab()
open()
peek_event()
pointer_is_grabbed()
pointer_ungrab()
put_event()
set_double_click_distance()
set_double_click_time()
supports_cursor_alpha()
supports_cursor_color()
sync()
|
- Description
GdkDisplay object.
Signals:
closed
-
Inherit Object
G.Object
-
Method beep
object(GDK.Display) GTK.refdoc.GDK.Display()->beep()
- Description
Emits a short beep on display
-
Method close
object(GDK.Display) GTK.refdoc.GDK.Display()->close()
- Description
Closes the connection to the window system for the given display, and
cleans up associated resources.
-
Method create
object(GDK.Display) GTK.refdoc.GDK.Display()->create()
- Description
Get the default display.
-
Method flush
object(GDK.Display) GTK.refdoc.GDK.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 GTK.refdoc.GDK.Display()->get_default_cursor_size()
- Description
Returns the default size to use for cursors.
-
Method get_default_group
object(GDK.Window) GTK.refdoc.GDK.Display()->get_default_group()
- Description
Returns the default group leader window for all toplevel windows. This
window is implicitly create by GDK.
-
Method get_event
object(GDK.Event) GTK.refdoc.GDK.Display()->get_event()
- Description
Gets the next GDK.Event to be processed, fetching events from the
windowing system if necessary.
-
Method get_maximal_cursor_size
mapping GTK.refdoc.GDK.Display()->get_maximal_cursor_size()
- Description
Returns the maximal size to use for cursors.
-
Method get_name
string GTK.refdoc.GDK.Display()->get_name()
- Description
Gets the name of the display.
-
Method get_pointer
mapping GTK.refdoc.GDK.Display()->get_pointer()
- Description
Gets the current location of the pointer and the current modifier mask.
-
Method get_window_at_pointer
mapping GTK.refdoc.GDK.Display()->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
object(GDK.Display) GTK.refdoc.GDK.Display()->keyboard_ungrab()
- Description
Release any keyboard grab.
-
Method open
object(GDK.Display) GTK.refdoc.GDK.Display()->open(string name)
- Description
Opens a display.
-
Method peek_event
object(GDK.Event) GTK.refdoc.GDK.Display()->peek_event()
- Description
Gets a copy of the first GDK.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 GTK.refdoc.GDK.Display()->pointer_is_grabbed()
- Description
Test if the pointer is grabbed.
-
Method pointer_ungrab
object(GDK.Display) GTK.refdoc.GDK.Display()->pointer_ungrab()
- Description
Release any pointer grab.
-
Method put_event
object(GDK.Display) GTK.refdoc.GDK.Display()->put_event(object(GDK.Event) event)
- Description
Appends a copy of the given event onto the front of the event queue.
-
Method set_double_click_distance
object(GDK.Display) GTK.refdoc.GDK.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
object(GDK.Display) GTK.refdoc.GDK.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 supports_cursor_alpha
int GTK.refdoc.GDK.Display()->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 GTK.refdoc.GDK.Display()->supports_cursor_color()
- Description
Returns true if multicolored cursors are supported. Otherwise, cursors
have only a foreground and a background color.
-
Method sync
object(GDK.Display) GTK.refdoc.GDK.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.
|
| CLASS GTK.refdoc.GDK.Event |
Methods
_index()
cast()
destroy()
|
- Description
Gdk events.
-
Method _index
mixed GTK.refdoc.GDK.Event()->_index(string ind)
- Description
Return an index.
-
Method cast
mixed GTK.refdoc.GDK.Event()->cast(string to)
- Description
Cast to different types.
-
Method destroy
object(GDK.Event) GTK.refdoc.GDK.Event()->destroy()
- Description
Destructor.
|
| CLASS GTK.refdoc.GDK.GC |
Methods
create()
destroy()
get_values()
set_background()
set_clip_mask()
set_clip_origin()
set_foreground()
set_function()
set_subwindow()
|
- 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
G.Object
-
Method create
object(GDK.GC) GTK.refdoc.GDK.GC()->create(object(GTK.Widget) context)
- Description
The argument is either a W(Widget) or a GDK(Drawable) in
which the gc will be valid.
-
Method destroy
object(GDK.GC) GTK.refdoc.GDK.GC()->destroy()
- Description
Free the gc, called automatically by pike when the object is destroyed.
-
Method get_values
mapping GTK.refdoc.GDK.GC()->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
object(GDK.GC) GTK.refdoc.GDK.GC()->set_background(object(GDK.Color) color)
- Description
Set the background to the specified GDK.Color.
-
Method set_clip_mask
object(GDK.GC) GTK.refdoc.GDK.GC()->set_clip_mask(object(GDK.Bitmap) mask)
- Description
Set the clip mask to the specified GDK.Bitmap
-
Method set_clip_origin
object(GDK.GC) GTK.refdoc.GDK.GC()->set_clip_origin(int x, int y)
- Description
Set the clip mask origin to the specified point.
-
Method set_foreground
object(GDK.GC) GTK.refdoc.GDK.GC()->set_foreground(object(GDK.Color) color)
- Description
Set the foreground to the specified GDK.Color.
-
Method set_function
object(GDK.GC) GTK.refdoc.GDK.GC()->set_function(int fun)
- Description
Set the function to the specified one. One of GDK.Xor,
GDK.Invert and GDK.Copy.
-
Method set_subwindow
object(GDK.GC) GTK.refdoc.GDK.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.
|
| MODULE GTK.refdoc.GTK |
Classes
AccelGroup
AccelLabel
Adjustment
Alignment
Arrow
AspectFrame
Bin
Box
Button
ButtonBox
Calendar
CellRenderer
CellRendererPixbuf
CellRendererText
CellRendererToggle
CheckButton
CheckMenuItem
Clipboard
ColorSelection
ColorSelectionDialog
Container
Data
Dialog
DrawingArea
Entry
EventBox
FileSelection
Fixed
FontSelection
FontSelectionDialog
Frame
G.Object
HandleBox
Hbox
HbuttonBox
Hpaned
Hscale
Hscrollbar
Hseparator
IconFactory
IconSet
IconSize
IconSource
Image
ImageMenuItem
Invisible
Item
Label
Layout
ListStore
Menu
MenuBar
MenuItem
MenuShell
Misc
Notebook
Object
Paned
Plug
Progress
ProgressBar
RadioButton
RadioMenuItem
Range
RcStyle
Scale
Scrollbar
ScrolledWindow
SelectionData
Separator
SeparatorMenuItem
Settings
SizeGroup
Socket
SpinButton
Statusbar
Style
Table
TearoffMenuItem
TextAttributes
TextBuffer
TextChildAnchor
TextIter
TextMark
TextTag
TextTagTable
TextView
ToggleButton
Toolbar
Tooltips
TreeIter
TreeModel
TreePath
TreeRowReference
TreeSelection
TreeStore
TreeView
TreeViewColumn
Vbox
VbuttonBox
Viewport
Vpaned
Vscale
Vscrollbar
Vseparator
Widget
Window
WindowGroup
Methods
add_builtin_icon()
false()
flush()
get_default_icon_list()
get_default_icon_theme()
grab_add()
grab_remove()
gtk_init()
list_toplevels()
low_flush()
main()
main_iteration_do()
main_level()
main_quit()
parse_rc()
root_window()
set_default_icon_list()
setup_gtk()
true()
|
-
Constant FALSE
constant
GTK.refdoc.GTK.FALSE
-
Constant GDK_2BUTTON_PRESS
constant
GTK.refdoc.GTK.GDK_2BUTTON_PRESS
-
Constant GDK_3BUTTON_PRESS
constant
GTK.refdoc.GTK.GDK_3BUTTON_PRESS
-
Constant GDK_ACTION_ASK
constant
GTK.refdoc.GTK.GDK_ACTION_ASK
-
Constant GDK_ACTION_COPY
constant
GTK.refdoc.GTK.GDK_ACTION_COPY
-
Constant GDK_ACTION_DEFAULT
constant
GTK.refdoc.GTK.GDK_ACTION_DEFAULT
-
Constant GDK_ACTION_LINK
constant
GTK.refdoc.GTK.GDK_ACTION_LINK
-
Constant GDK_ACTION_MOVE
constant
GTK.refdoc.GTK.GDK_ACTION_MOVE
-
Constant GDK_ACTION_PRIVATE
constant
GTK.refdoc.GTK.GDK_ACTION_PRIVATE
-
Constant GDK_ALL_EVENTS_MASK
constant
GTK.refdoc.GTK.GDK_ALL_EVENTS_MASK
-
Constant GDK_AND
constant
GTK.refdoc.GTK.GDK_AND
-
Constant GDK_AND_INVERT
constant
GTK.refdoc.GTK.GDK_AND_INVERT
-
Constant GDK_AND_REVERSE
constant
GTK.refdoc.GTK.GDK_AND_REVERSE
-
Constant GDK_ARROW
constant
GTK.refdoc.GTK.GDK_ARROW
-
Constant GDK_AXIS_IGNORE
constant
GTK.refdoc.GTK.GDK_AXIS_IGNORE
-
Constant GDK_AXIS_LAST
constant
GTK.refdoc.GTK.GDK_AXIS_LAST
-
Constant GDK_AXIS_PRESSURE
constant
GTK.refdoc.GTK.GDK_AXIS_PRESSURE
-
Constant GDK_AXIS_WHEEL
constant
GTK.refdoc.GTK.GDK_AXIS_WHEEL
-
Constant GDK_AXIS_X
constant
GTK.refdoc.GTK.GDK_AXIS_X
-
Constant GDK_AXIS_XTILT
constant
GTK.refdoc.GTK.GDK_AXIS_XTILT
-
Constant GDK_AXIS_Y
constant
GTK.refdoc.GTK.GDK_AXIS_Y
-
Constant GDK_AXIS_YTILT
constant
GTK.refdoc.GTK.GDK_AXIS_YTILT
-
Constant GDK_BASED_ARROW_DOWN
constant
GTK.refdoc.GTK.GDK_BASED_ARROW_DOWN
-
Constant GDK_BASED_ARROW_UP
constant
GTK.refdoc.GTK.GDK_BASED_ARROW_UP
-
Constant GDK_BOAT
constant
GTK.refdoc.GTK.GDK_BOAT
-
Constant GDK_BOGOSITY
constant
GTK.refdoc.GTK.GDK_BOGOSITY
-
Constant GDK_BOTTOM_LEFT_CORNER
constant
GTK.refdoc.GTK.GDK_BOTTOM_LEFT_CORNER
-
Constant GDK_BOTTOM_RIGHT_CORNER
constant
GTK.refdoc.GTK.GDK_BOTTOM_RIGHT_CORNER
-
Constant GDK_BOTTOM_SIDE
constant
GTK.refdoc.GTK.GDK_BOTTOM_SIDE
-
Constant GDK_BOTTOM_TEE
constant
GTK.refdoc.GTK.GDK_BOTTOM_TEE
-
Constant GDK_BOX_SPIRAL
constant
GTK.refdoc.GTK.GDK_BOX_SPIRAL
-
Constant GDK_BUTTON1_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON1_MASK
-
Constant GDK_BUTTON1_MOTION_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON1_MOTION_MASK
-
Constant GDK_BUTTON2_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON2_MASK
-
Constant GDK_BUTTON2_MOTION_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON2_MOTION_MASK
-
Constant GDK_BUTTON3_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON3_MASK
-
Constant GDK_BUTTON3_MOTION_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON3_MOTION_MASK
-
Constant GDK_BUTTON4_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON4_MASK
-
Constant GDK_BUTTON5_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON5_MASK
-
Constant GDK_BUTTON_MOTION_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON_MOTION_MASK
-
Constant GDK_BUTTON_PRESS
constant
GTK.refdoc.GTK.GDK_BUTTON_PRESS
-
Constant GDK_BUTTON_PRESS_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON_PRESS_MASK
-
Constant GDK_BUTTON_RELEASE
constant
GTK.refdoc.GTK.GDK_BUTTON_RELEASE
-
Constant GDK_BUTTON_RELEASE_MASK
constant
GTK.refdoc.GTK.GDK_BUTTON_RELEASE_MASK
-
Constant GDK_CAP_BUTT
constant
GTK.refdoc.GTK.GDK_CAP_BUTT
-
Constant GDK_CAP_NOT_LAST
constant
GTK.refdoc.GTK.GDK_CAP_NOT_LAST
-
Constant GDK_CAP_PROJECTING
constant
GTK.refdoc.GTK.GDK_CAP_PROJECTING
-
Constant GDK_CAP_ROUND
constant
GTK.refdoc.GTK.GDK_CAP_ROUND
-
Constant GDK_CENTER_PTR
constant
GTK.refdoc.GTK.GDK_CENTER_PTR
-
Constant GDK_CIRCLE
constant
GTK.refdoc.GTK.GDK_CIRCLE
-
Constant GDK_CLEAR
constant
GTK.refdoc.GTK.GDK_CLEAR
-
Constant GDK_CLIENT_EVENT
constant
GTK.refdoc.GTK.GDK_CLIENT_EVENT
-
Constant GDK_CLIP_BY_CHILDREN
constant
GTK.refdoc.GTK.GDK_CLIP_BY_CHILDREN
-
Constant GDK_CLOCK
constant
GTK.refdoc.GTK.GDK_CLOCK
-
Constant GDK_COFFEE_MUG
constant
GTK.refdoc.GTK.GDK_COFFEE_MUG
-
Constant GDK_COLORSPACE_RGB
constant
GTK.refdoc.GTK.GDK_COLORSPACE_RGB
-
Constant GDK_CONFIGURE
constant
GTK.refdoc.GTK.GDK_CONFIGURE
-
Constant GDK_CONTROL_MASK
constant
GTK.refdoc.GTK.GDK_CONTROL_MASK
-
Constant GDK_COPY
constant
GTK.refdoc.GTK.GDK_COPY
-
Constant GDK_COPY_INVERT
constant
GTK.refdoc.GTK.GDK_COPY_INVERT
-
Constant GDK_CROSS
constant
GTK.refdoc.GTK.GDK_CROSS
-
Constant GDK_CROSSHAIR
constant
GTK.refdoc.GTK.GDK_CROSSHAIR
-
Constant GDK_CROSSING_GRAB
constant
GTK.refdoc.GTK.GDK_CROSSING_GRAB
-
Constant GDK_CROSSING_NORMAL
constant
GTK.refdoc.GTK.GDK_CROSSING_NORMAL
-
Constant GDK_CROSSING_UNGRAB
constant
GTK.refdoc.GTK.GDK_CROSSING_UNGRAB
-
Constant GDK_CROSS_REVERSE
constant
GTK.refdoc.GTK.GDK_CROSS_REVERSE
-
Constant GDK_CURSOR_IS_PIXMAP
constant
GTK.refdoc.GTK.GDK_CURSOR_IS_PIXMAP
-
Constant GDK_DECOR_ALL
constant
GTK.refdoc.GTK.GDK_DECOR_ALL
-
Constant GDK_DECOR_BORDER
constant
GTK.refdoc.GTK.GDK_DECOR_BORDER
-
Constant GDK_DECOR_MAXIMIZE
constant
GTK.refdoc.GTK.GDK_DECOR_MAXIMIZE
-
Constant GDK_DECOR_MENU
constant
GTK.refdoc.GTK.GDK_DECOR_MENU
-
Constant GDK_DECOR_MINIMIZE
constant
GTK.refdoc.GTK.GDK_DECOR_MINIMIZE
-
Constant GDK_DECOR_RESIZEH
constant
GTK.refdoc.GTK.GDK_DECOR_RESIZEH
-
Constant GDK_DECOR_TITLE
constant
GTK.refdoc.GTK.GDK_DECOR_TITLE
-
Constant GDK_DELETE
constant
GTK.refdoc.GTK.GDK_DELETE
-
Constant GDK_DESTROY
constant
GTK.refdoc.GTK.GDK_DESTROY
-
Constant GDK_DIAMOND_CROSS
constant
GTK.refdoc.GTK.GDK_DIAMOND_CROSS
-
Constant GDK_DOT
constant
GTK.refdoc.GTK.GDK_DOT
-
Constant GDK_DOTBOX
constant
GTK.refdoc.GTK.GDK_DOTBOX
-
Constant GDK_DOUBLE_ARROW
constant
GTK.refdoc.GTK.GDK_DOUBLE_ARROW
-
Constant GDK_DRAFT_LARGE
constant
GTK.refdoc.GTK.GDK_DRAFT_LARGE
-
Constant GDK_DRAFT_SMALL
constant
GTK.refdoc.GTK.GDK_DRAFT_SMALL
-
Constant GDK_DRAG_ENTER
constant
GTK.refdoc.GTK.GDK_DRAG_ENTER
-
Constant GDK_DRAG_LEAVE
constant
GTK.refdoc.GTK.GDK_DRAG_LEAVE
-
Constant GDK_DRAG_MOTION
constant
GTK.refdoc.GTK.GDK_DRAG_MOTION
-
Constant GDK_DRAG_PROTO_LOCAL
constant
GTK.refdoc.GTK.GDK_DRAG_PROTO_LOCAL
-
Constant GDK_DRAG_PROTO_MOTIF
constant
GTK.refdoc.GTK.GDK_DRAG_PROTO_MOTIF
-
Constant GDK_DRAG_PROTO_NONE
constant
GTK.refdoc.GTK.GDK_DRAG_PROTO_NONE
-
Constant GDK_DRAG_PROTO_OLE2
constant
GTK.refdoc.GTK.GDK_DRAG_PROTO_OLE2
-
Constant GDK_DRAG_PROTO_ROOTWIN
constant
GTK.refdoc.GTK.GDK_DRAG_PROTO_ROOTWIN
-
Constant GDK_DRAG_PROTO_WIN32_DROPFILES
constant
GTK.refdoc.GTK.GDK_DRAG_PROTO_WIN32_DROPFILES
-
Constant GDK_DRAG_PROTO_XDND
constant
GTK.refdoc.GTK.GDK_DRAG_PROTO_XDND
-
Constant GDK_DRAG_STATUS
constant
GTK.refdoc.GTK.GDK_DRAG_STATUS
-
Constant GDK_DRAPED_BOX
constant
GTK.refdoc.GTK.GDK_DRAPED_BOX
-
Constant GDK_DROP_FINISHED
constant
GTK.refdoc.GTK.GDK_DROP_FINISHED
-
Constant GDK_DROP_START
constant
GTK.refdoc.GTK.GDK_DROP_START
-
Constant GDK_ENTER_NOTIFY
constant
GTK.refdoc.GTK.GDK_ENTER_NOTIFY
-
Constant GDK_ENTER_NOTIFY_MASK
constant
GTK.refdoc.GTK.GDK_ENTER_NOTIFY_MASK
-
Constant GDK_EQUIV
constant
GTK.refdoc.GTK.GDK_EQUIV
-
Constant GDK_EVEN_ODD_RULE
constant
GTK.refdoc.GTK.GDK_EVEN_ODD_RULE
-
Constant GDK_EXCHANGE
constant
GTK.refdoc.GTK.GDK_EXCHANGE
-
Constant GDK_EXPOSE
constant
GTK.refdoc.GTK.GDK_EXPOSE
-
Constant GDK_EXPOSURE_MASK
constant
GTK.refdoc.GTK.GDK_EXPOSURE_MASK
-
Constant GDK_EXTENSION_EVENTS_ALL
constant
GTK.refdoc.GTK.GDK_EXTENSION_EVENTS_ALL
-
Constant GDK_EXTENSION_EVENTS_CURSOR
constant
GTK.refdoc.GTK.GDK_EXTENSION_EVENTS_CURSOR
-
Constant GDK_EXTENSION_EVENTS_NONE
constant
GTK.refdoc.GTK.GDK_EXTENSION_EVENTS_NONE
-
Constant GDK_FILTER_CONTINUE
constant
GTK.refdoc.GTK.GDK_FILTER_CONTINUE
-
Constant GDK_FILTER_REMOVE
constant
GTK.refdoc.GTK.GDK_FILTER_REMOVE
-
Constant GDK_FILTER_TRANSLATE
constant
GTK.refdoc.GTK.GDK_FILTER_TRANSLATE
-
Constant GDK_FLEUR
constant
GTK.refdoc.GTK.GDK_FLEUR
-
Constant GDK_FOCUS_CHANGE
constant
GTK.refdoc.GTK.GDK_FOCUS_CHANGE
-
Constant GDK_FOCUS_CHANGE_MASK
constant
GTK.refdoc.GTK.GDK_FOCUS_CHANGE_MASK
-
Constant GDK_FUNC_ALL
constant
GTK.refdoc.GTK.GDK_FUNC_ALL
-
Constant GDK_FUNC_CLOSE
constant
GTK.refdoc.GTK.GDK_FUNC_CLOSE
-
Constant GDK_FUNC_MAXIMIZE
constant
GTK.refdoc.GTK.GDK_FUNC_MAXIMIZE
-
Constant GDK_FUNC_MINIMIZE
constant
GTK.refdoc.GTK.GDK_FUNC_MINIMIZE
-
Constant GDK_FUNC_MOVE
constant
GTK.refdoc.GTK.GDK_FUNC_MOVE
-
Constant GDK_FUNC_RESIZE
constant
GTK.refdoc.GTK.GDK_FUNC_RESIZE
-
Constant GDK_GC_BACKGROUND
constant
GTK.refdoc.GTK.GDK_GC_BACKGROUND
-
Constant GDK_GC_CAP_STYLE
constant
GTK.refdoc.GTK.GDK_GC_CAP_STYLE
-
Constant GDK_GC_CLIP_MASK
constant
GTK.refdoc.GTK.GDK_GC_CLIP_MASK
-
Constant GDK_GC_CLIP_X_ORIGIN
constant
GTK.refdoc.GTK.GDK_GC_CLIP_X_ORIGIN
-
Constant GDK_GC_CLIP_Y_ORIGIN
constant
GTK.refdoc.GTK.GDK_GC_CLIP_Y_ORIGIN
-
Constant GDK_GC_EXPOSURES
constant
GTK.refdoc.GTK.GDK_GC_EXPOSURES
-
Constant GDK_GC_FILL
constant
GTK.refdoc.GTK.GDK_GC_FILL
-
Constant GDK_GC_FONT
constant
GTK.refdoc.GTK.GDK_GC_FONT
-
Constant GDK_GC_FOREGROUND
constant
GTK.refdoc.GTK.GDK_GC_FOREGROUND
-
Constant GDK_GC_FUNCTION
constant
GTK.refdoc.GTK.GDK_GC_FUNCTION
-
Constant GDK_GC_JOIN_STYLE
constant
GTK.refdoc.GTK.GDK_GC_JOIN_STYLE
-
Constant GDK_GC_LINE_STYLE
constant
GTK.refdoc.GTK.GDK_GC_LINE_STYLE
-
Constant GDK_GC_LINE_WIDTH
constant
GTK.refdoc.GTK.GDK_GC_LINE_WIDTH
-
Constant GDK_GC_STIPPLE
constant
GTK.refdoc.GTK.GDK_GC_STIPPLE
-
Constant GDK_GC_SUBWINDOW
constant
GTK.refdoc.GTK.GDK_GC_SUBWINDOW
-
Constant GDK_GC_TILE
constant
GTK.refdoc.GTK.GDK_GC_TILE
-
Constant GDK_GC_TS_X_ORIGIN
constant
GTK.refdoc.GTK.GDK_GC_TS_X_ORIGIN
-
Constant GDK_GC_TS_Y_ORIGIN
constant
GTK.refdoc.GTK.GDK_GC_TS_Y_ORIGIN
-
Constant GDK_GOBBLER
constant
GTK.refdoc.GTK.GDK_GOBBLER
-
Constant GDK_GRAB_ALREADY_GRABBED
constant
GTK.refdoc.GTK.GDK_GRAB_ALREADY_GRABBED
-
Constant GDK_GRAB_FROZEN
constant
GTK.refdoc.GTK.GDK_GRAB_FROZEN
-
Constant GDK_GRAB_INVALID_TIME
constant
GTK.refdoc.GTK.GDK_GRAB_INVALID_TIME
-
Constant GDK_GRAB_NOT_VIEWABLE
constant
GTK.refdoc.GTK.GDK_GRAB_NOT_VIEWABLE
-
Constant GDK_GRAB_SUCCESS
constant
GTK.refdoc.GTK.GDK_GRAB_SUCCESS
-
Constant GDK_GRAVITY_CENTER
constant
GTK.refdoc.GTK.GDK_GRAVITY_CENTER
-
Constant GDK_GRAVITY_EAST
constant
GTK.refdoc.GTK.GDK_GRAVITY_EAST
-
Constant GDK_GRAVITY_NORTH
constant
GTK.refdoc.GTK.GDK_GRAVITY_NORTH
-
Constant GDK_GRAVITY_NORTH_EAST
constant
GTK.refdoc.GTK.GDK_GRAVITY_NORTH_EAST
-
Constant GDK_GRAVITY_NORTH_WEST
constant
GTK.refdoc.GTK.GDK_GRAVITY_NORTH_WEST
-
Constant GDK_GRAVITY_SOUTH
constant
GTK.refdoc.GTK.GDK_GRAVITY_SOUTH
-
Constant GDK_GRAVITY_SOUTH_EAST
constant
GTK.refdoc.GTK.GDK_GRAVITY_SOUTH_EAST
-
Constant GDK_GRAVITY_SOUTH_WEST
constant
GTK.refdoc.GTK.GDK_GRAVITY_SOUTH_WEST
-
Constant GDK_GRAVITY_STATIC
constant
GTK.refdoc.GTK.GDK_GRAVITY_STATIC
-
Constant GDK_GRAVITY_WEST
constant
GTK.refdoc.GTK.GDK_GRAVITY_WEST
-
Constant GDK_GUMBY
constant
GTK.refdoc.GTK.GDK_GUMBY
-
Constant GDK_HAND1
constant
GTK.refdoc.GTK.GDK_HAND1
-
Constant GDK_HAND2
constant
GTK.refdoc.GTK.GDK_HAND2
-
Constant GDK_HEART
constant
GTK.refdoc.GTK.GDK_HEART
-
Constant GDK_HINT_ASPECT
constant
GTK.refdoc.GTK.GDK_HINT_ASPECT
-
Constant GDK_HINT_BASE_SIZE
constant
GTK.refdoc.GTK.GDK_HINT_BASE_SIZE
-
Constant GDK_HINT_MAX_SIZE
constant
GTK.refdoc.GTK.GDK_HINT_MAX_SIZE
-
Constant GDK_HINT_MIN_SIZE
constant
GTK.refdoc.GTK.GDK_HINT_MIN_SIZE
-
Constant GDK_HINT_POS
constant
GTK.refdoc.GTK.GDK_HINT_POS
-
Constant GDK_HINT_RESIZE_INC
constant
GTK.refdoc.GTK.GDK_HINT_RESIZE_INC
-
Constant GDK_HINT_USER_POS
constant
GTK.refdoc.GTK.GDK_HINT_USER_POS
-
Constant GDK_HINT_USER_SIZE
constant
GTK.refdoc.GTK.GDK_HINT_USER_SIZE
-
Constant GDK_ICON
constant
GTK.refdoc.GTK.GDK_ICON
-
Constant GDK_IMAGE_FASTEST
constant
GTK.refdoc.GTK.GDK_IMAGE_FASTEST
-
Constant GDK_IMAGE_NORMAL
constant
GTK.refdoc.GTK.GDK_IMAGE_NORMAL
-
Constant GDK_IMAGE_SHARED
constant
GTK.refdoc.GTK.GDK_IMAGE_SHARED
-
Constant GDK_INCLUDE_INFERIORS
constant
GTK.refdoc.GTK.GDK_INCLUDE_INFERIORS
-
Constant GDK_INPUT_EXCEPTION
constant
GTK.refdoc.GTK.GDK_INPUT_EXCEPTION
-
Constant GDK_INPUT_ONLY
constant
GTK.refdoc.GTK.GDK_INPUT_ONLY
-
Constant GDK_INPUT_OUTPUT
constant
GTK.refdoc.GTK.GDK_INPUT_OUTPUT
-
Constant GDK_INPUT_READ
constant
GTK.refdoc.GTK.GDK_INPUT_READ
-
Constant GDK_INPUT_WRITE
constant
GTK.refdoc.GTK.GDK_INPUT_WRITE
-
Constant GDK_INTERP_BILINEAR
constant
GTK.refdoc.GTK.GDK_INTERP_BILINEAR
-
Constant GDK_INTERP_HYPER
constant
GTK.refdoc.GTK.GDK_INTERP_HYPER
-
Constant GDK_INTERP_NEAREST
constant
GTK.refdoc.GTK.GDK_INTERP_NEAREST
-
Constant GDK_INTERP_TILES
constant
GTK.refdoc.GTK.GDK_INTERP_TILES
-
Constant GDK_INVERT
constant
GTK.refdoc.GTK.GDK_INVERT
-
Constant GDK_IRON_CROSS
constant
GTK.refdoc.GTK.GDK_IRON_CROSS
-
Constant GDK_JOIN_BEVEL
constant
GTK.refdoc.GTK.GDK_JOIN_BEVEL
-
Constant GDK_JOIN_MITER
constant
GTK.refdoc.GTK.GDK_JOIN_MITER
-
Constant GDK_JOIN_ROUND
constant
GTK.refdoc.GTK.GDK_JOIN_ROUND
-
Constant GDK_KEY_PRESS
constant
GTK.refdoc.GTK.GDK_KEY_PRESS
-
Constant GDK_KEY_PRESS_MASK
constant
GTK.refdoc.GTK.GDK_KEY_PRESS_MASK
-
Constant GDK_KEY_RELEASE
constant
GTK.refdoc.GTK.GDK_KEY_RELEASE
-
Constant GDK_KEY_RELEASE_MASK
constant
GTK.refdoc.GTK.GDK_KEY_RELEASE_MASK
-
Constant GDK_LAST_CURSOR
constant
GTK.refdoc.GTK.GDK_LAST_CURSOR
-
Constant GDK_LEAVE_NOTIFY
constant
GTK.refdoc.GTK.GDK_LEAVE_NOTIFY
-
Constant GDK_LEAVE_NOTIFY_MASK
constant
GTK.refdoc.GTK.GDK_LEAVE_NOTIFY_MASK
-
Constant GDK_LEFTBUTTON
constant
GTK.refdoc.GTK.GDK_LEFTBUTTON
-
Constant GDK_LEFT_PTR
constant
GTK.refdoc.GTK.GDK_LEFT_PTR
-
Constant GDK_LEFT_SIDE
constant
GTK.refdoc.GTK.GDK_LEFT_SIDE
-
Constant GDK_LEFT_TEE
constant
GTK.refdoc.GTK.GDK_LEFT_TEE
-
Constant GDK_LINE_DOUBLE_DASH
constant
GTK.refdoc.GTK.GDK_LINE_DOUBLE_DASH
-
Constant GDK_LINE_ON_OFF_DASH
constant
GTK.refdoc.GTK.GDK_LINE_ON_OFF_DASH
-
Constant GDK_LINE_SOLID
constant
GTK.refdoc.GTK.GDK_LINE_SOLID
-
Constant GDK_LL_ANGLE
constant
GTK.refdoc.GTK.GDK_LL_ANGLE
-
Constant GDK_LOCK_MASK
constant
GTK.refdoc.GTK.GDK_LOCK_MASK
-
Constant GDK_LR_ANGLE
constant
GTK.refdoc.GTK.GDK_LR_ANGLE
-
Constant GDK_LSB_FIRST
constant
GTK.refdoc.GTK.GDK_LSB_FIRST
-
Constant GDK_MAN
constant
GTK.refdoc.GTK.GDK_MAN
-
Constant GDK_MAP
constant
GTK.refdoc.GTK.GDK_MAP
-
Constant GDK_MIDDLEBUTTON
constant
GTK.refdoc.GTK.GDK_MIDDLEBUTTON
-
Constant GDK_MOD1_MASK
constant
GTK.refdoc.GTK.GDK_MOD1_MASK
-
Constant GDK_MOD2_MASK
constant
GTK.refdoc.GTK.GDK_MOD2_MASK
-
Constant GDK_MOD3_MASK
constant
GTK.refdoc.GTK.GDK_MOD3_MASK
-
Constant GDK_MOD4_MASK
constant
GTK.refdoc.GTK.GDK_MOD4_MASK
-
Constant GDK_MOD5_MASK
constant
GTK.refdoc.GTK.GDK_MOD5_MASK
-
Constant GDK_MODE_DISABLED
constant
GTK.refdoc.GTK.GDK_MODE_DISABLED
-
Constant GDK_MODE_SCREEN
constant
GTK.refdoc.GTK.GDK_MODE_SCREEN
-
Constant GDK_MODE_WINDOW
constant
GTK.refdoc.GTK.GDK_MODE_WINDOW
-
Constant GDK_MODIFIER_MASK
constant
GTK.refdoc.GTK.GDK_MODIFIER_MASK
-
Constant GDK_MOTION_NOTIFY
constant
GTK.refdoc.GTK.GDK_MOTION_NOTIFY
-
Constant GDK_MOUSE
constant
GTK.refdoc.GTK.GDK_MOUSE
-
Constant GDK_MSB_FIRST
constant
GTK.refdoc.GTK.GDK_MSB_FIRST
-
Constant GDK_NAND
constant
GTK.refdoc.GTK.GDK_NAND
-
Constant GDK_NOOP
constant
GTK.refdoc.GTK.GDK_NOOP
-
Constant GDK_NOR
constant
GTK.refdoc.GTK.GDK_NOR
-
Constant GDK_NOTHING
constant
GTK.refdoc.GTK.GDK_NOTHING
-
Constant GDK_NOTIFY_ANCESTOR
constant
GTK.refdoc.GTK.GDK_NOTIFY_ANCESTOR
-
Constant GDK_NOTIFY_INFERIOR
constant
GTK.refdoc.GTK.GDK_NOTIFY_INFERIOR
-
Constant GDK_NOTIFY_NONLINEAR
constant
GTK.refdoc.GTK.GDK_NOTIFY_NONLINEAR
-
Constant GDK_NOTIFY_NONLINEAR_VIRTUAL
constant
GTK.refdoc.GTK.GDK_NOTIFY_NONLINEAR_VIRTUAL
-
Constant GDK_NOTIFY_UNKNOWN
constant
GTK.refdoc.GTK.GDK_NOTIFY_UNKNOWN
-
Constant GDK_NOTIFY_VIRTUAL
constant
GTK.refdoc.GTK.GDK_NOTIFY_VIRTUAL
-
Constant GDK_NO_EXPOSE
constant
GTK.refdoc.GTK.GDK_NO_EXPOSE
-
Constant GDK_OPAQUE_STIPPLED
constant
GTK.refdoc.GTK.GDK_OPAQUE_STIPPLED
-
Constant GDK_OR
constant
GTK.refdoc.GTK.GDK_OR
-
Constant GDK_OR_INVERT
constant
GTK.refdoc.GTK.GDK_OR_INVERT
-
Constant GDK_OR_REVERSE
constant
GTK.refdoc.GTK.GDK_OR_REVERSE
-
Constant GDK_OVERLAP_RECTANGLE_IN
constant
GTK.refdoc.GTK.GDK_OVERLAP_RECTANGLE_IN
-
Constant GDK_OVERLAP_RECTANGLE_OUT
constant
GTK.refdoc.GTK.GDK_OVERLAP_RECTANGLE_OUT
-
Constant GDK_OVERLAP_RECTANGLE_PART
constant
GTK.refdoc.GTK.GDK_OVERLAP_RECTANGLE_PART
-
Constant GDK_PENCIL
constant
GTK.refdoc.GTK.GDK_PENCIL
-
Constant GDK_PIRATE
constant
GTK.refdoc.GTK.GDK_PIRATE
-
Constant GDK_PIXBUF_ALPHA_BILEVEL
constant
GTK.refdoc.GTK.GDK_PIXBUF_ALPHA_BILEVEL
-
Constant GDK_PIXBUF_ALPHA_FULL
constant
GTK.refdoc.GTK.GDK_PIXBUF_ALPHA_FULL
-
Constant GDK_PIXBUF_ERROR_BAD_OPTION
constant
GTK.refdoc.GTK.GDK_PIXBUF_ERROR_BAD_OPTION
-
Constant GDK_PIXBUF_ERROR_CORRUPT_IMAGE
constant
GTK.refdoc.GTK.GDK_PIXBUF_ERROR_CORRUPT_IMAGE
-
Constant GDK_PIXBUF_ERROR_FAILED
constant
GTK.refdoc.GTK.GDK_PIXBUF_ERROR_FAILED
-
Constant GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY
constant
GTK.refdoc.GTK.GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY
-
Constant GDK_PIXBUF_ERROR_UNKNOWN_TYPE
constant
GTK.refdoc.GTK.GDK_PIXBUF_ERROR_UNKNOWN_TYPE
-
Constant GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION
constant
GTK.refdoc.GTK.GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION
-
Constant GDK_PLUS
constant
GTK.refdoc.GTK.GDK_PLUS
-
Constant GDK_POINTER_MOTION_HINT_MASK
constant
GTK.refdoc.GTK.GDK_POINTER_MOTION_HINT_MASK
-
Constant GDK_POINTER_MOTION_MASK
constant
GTK.refdoc.GTK.GDK_POINTER_MOTION_MASK
-
Constant GDK_PROPERTY_CHANGE_MASK
constant
GTK.refdoc.GTK.GDK_PROPERTY_CHANGE_MASK
-
Constant GDK_PROPERTY_DELETE
constant
GTK.refdoc.GTK.GDK_PROPERTY_DELETE
-
Constant GDK_PROPERTY_NEW_VALUE
constant
GTK.refdoc.GTK.GDK_PROPERTY_NEW_VALUE
-
Constant GDK_PROPERTY_NOTIFY
constant
GTK.refdoc.GTK.GDK_PROPERTY_NOTIFY
-
Constant GDK_PROP_MODE_APPEND
constant
GTK.refdoc.GTK.GDK_PROP_MODE_APPEND
-
Constant GDK_PROP_MODE_PREPEND
constant
GTK.refdoc.GTK.GDK_PROP_MODE_PREPEND
-
Constant GDK_PROP_MODE_REPLACE
constant
GTK.refdoc.GTK.GDK_PROP_MODE_REPLACE
-
Constant GDK_PROXIMITY_IN
constant
GTK.refdoc.GTK.GDK_PROXIMITY_IN
-
Constant GDK_PROXIMITY_IN_MASK
constant
GTK.refdoc.GTK.GDK_PROXIMITY_IN_MASK
-
Constant GDK_PROXIMITY_OUT
constant
GTK.refdoc.GTK.GDK_PROXIMITY_OUT
-
Constant GDK_PROXIMITY_OUT_MASK
constant
GTK.refdoc.GTK.GDK_PROXIMITY_OUT_MASK
-
Constant GDK_QUESTION_ARROW
constant
GTK.refdoc.GTK.GDK_QUESTION_ARROW
-
Constant GDK_RELEASE_MASK
constant
GTK.refdoc.GTK.GDK_RELEASE_MASK
-
Constant GDK_RGB_DITHER_MAX
constant
GTK.refdoc.GTK.GDK_RGB_DITHER_MAX
-
Constant GDK_RGB_DITHER_NONE
constant
GTK.refdoc.GTK.GDK_RGB_DITHER_NONE
-
Constant GDK_RGB_DITHER_NORMAL
constant
GTK.refdoc.GTK.GDK_RGB_DITHER_NORMAL
-
Constant GDK_RIGHTBUTTON
constant
GTK.refdoc.GTK.GDK_RIGHTBUTTON
-
Constant GDK_RIGHT_PTR
constant
GTK.refdoc.GTK.GDK_RIGHT_PTR
-
Constant GDK_RIGHT_SIDE
constant
GTK.refdoc.GTK.GDK_RIGHT_SIDE
-
Constant GDK_RIGHT_TEE
constant
GTK.refdoc.GTK.GDK_RIGHT_TEE
-
Constant GDK_RTL_LOGO
constant
GTK.refdoc.GTK.GDK_RTL_LOGO
-
Constant GDK_SAILBOAT
constant
GTK.refdoc.GTK.GDK_SAILBOAT
-
Constant GDK_SB_DOWN_ARROW
constant
GTK.refdoc.GTK.GDK_SB_DOWN_ARROW
-
Constant GDK_SB_H_DOUBLE_ARROW
constant
GTK.refdoc.GTK.GDK_SB_H_DOUBLE_ARROW
-
Constant GDK_SB_LEFT_ARROW
constant
GTK.refdoc.GTK.GDK_SB_LEFT_ARROW
-
Constant GDK_SB_RIGHT_ARROW
constant
GTK.refdoc.GTK.GDK_SB_RIGHT_ARROW
-
Constant GDK_SB_UP_ARROW
constant
GTK.refdoc.GTK.GDK_SB_UP_ARROW
-
Constant GDK_SB_V_DOUBLE_ARROW
constant
GTK.refdoc.GTK.GDK_SB_V_DOUBLE_ARROW
-
Constant GDK_SCROLL
constant
GTK.refdoc.GTK.GDK_SCROLL
-
Constant GDK_SCROLL_DOWN
constant
GTK.refdoc.GTK.GDK_SCROLL_DOWN
-
Constant GDK_SCROLL_LEFT
constant
GTK.refdoc.GTK.GDK_SCROLL_LEFT
-
Constant GDK_SCROLL_MASK
constant
GTK.refdoc.GTK.GDK_SCROLL_MASK
-
Constant GDK_SCROLL_RIGHT
constant
GTK.refdoc.GTK.GDK_SCROLL_RIGHT
-
Constant GDK_SCROLL_UP
constant
GTK.refdoc.GTK.GDK_SCROLL_UP
-
Constant GDK_SELECTION_CLEAR
constant
GTK.refdoc.GTK.GDK_SELECTION_CLEAR
-
Constant GDK_SELECTION_NOTIFY
constant
GTK.refdoc.GTK.GDK_SELECTION_NOTIFY
-
Constant GDK_SELECTION_REQUEST
constant
GTK.refdoc.GTK.GDK_SELECTION_REQUEST
-
Constant GDK_SET
constant
GTK.refdoc.GTK.GDK_SET
-
Constant GDK_SETTING
constant
GTK.refdoc.GTK.GDK_SETTING
-
Constant GDK_SETTING_ACTION_CHANGED
constant
GTK.refdoc.GTK.GDK_SETTING_ACTION_CHANGED
-
Constant GDK_SETTING_ACTION_DELETED
constant
GTK.refdoc.GTK.GDK_SETTING_ACTION_DELETED
-
Constant GDK_SETTING_ACTION_NEW
constant
GTK.refdoc.GTK.GDK_SETTING_ACTION_NEW
-
Constant GDK_SHIFT_MASK
constant
GTK.refdoc.GTK.GDK_SHIFT_MASK
-
Constant GDK_SHUTTLE
constant
GTK.refdoc.GTK.GDK_SHUTTLE
-
Constant GDK_SIZING
constant
GTK.refdoc.GTK.GDK_SIZING
-
Constant GDK_SOLID
constant
GTK.refdoc.GTK.GDK_SOLID
-
Constant GDK_SOURCE_CURSOR
constant
GTK.refdoc.GTK.GDK_SOURCE_CURSOR
-
Constant GDK_SOURCE_ERASER
constant
GTK.refdoc.GTK.GDK_SOURCE_ERASER
-
Constant GDK_SOURCE_MOUSE
constant
GTK.refdoc.GTK.GDK_SOURCE_MOUSE
-
Constant GDK_SOURCE_PEN
constant
GTK.refdoc.GTK.GDK_SOURCE_PEN
-
Constant GDK_SPIDER
constant
GTK.refdoc.GTK.GDK_SPIDER
-
Constant GDK_SPRAYCAN
constant
GTK.refdoc.GTK.GDK_SPRAYCAN
-
Constant GDK_STAR
constant
GTK.refdoc.GTK.GDK_STAR
-
Constant GDK_STIPPLED
constant
GTK.refdoc.GTK.GDK_STIPPLED
-
Constant GDK_STRUCTURE_MASK
constant
GTK.refdoc.GTK.GDK_STRUCTURE_MASK
-
Constant GDK_SUBSTRUCTURE_MASK
constant
GTK.refdoc.GTK.GDK_SUBSTRUCTURE_MASK
-
Constant GDK_TARGET
constant
GTK.refdoc.GTK.GDK_TARGET
-
Constant GDK_TCROSS
constant
GTK.refdoc.GTK.GDK_TCROSS
-
Constant GDK_TILED
constant
GTK.refdoc.GTK.GDK_TILED
-
Constant GDK_TOP_LEFT_ARROW
constant
GTK.refdoc.GTK.GDK_TOP_LEFT_ARROW
-
Constant GDK_TOP_LEFT_CORNER
constant
GTK.refdoc.GTK.GDK_TOP_LEFT_CORNER
-
Constant GDK_TOP_RIGHT_CORNER
constant
GTK.refdoc.GTK.GDK_TOP_RIGHT_CORNER
-
Constant GDK_TOP_SIDE
constant
GTK.refdoc.GTK.GDK_TOP_SIDE
-
Constant GDK_TOP_TEE
constant
GTK.refdoc.GTK.GDK_TOP_TEE
-
Constant GDK_TREK
constant
GTK.refdoc.GTK.GDK_TREK
-
Constant GDK_UL_ANGLE
constant
GTK.refdoc.GTK.GDK_UL_ANGLE
-
Constant GDK_UMBRELLA
constant
GTK.refdoc.GTK.GDK_UMBRELLA
-
Constant GDK_UNMAP
constant
GTK.refdoc.GTK.GDK_UNMAP
-
Constant GDK_UR_ANGLE
constant
GTK.refdoc.GTK.GDK_UR_ANGLE
-
Constant GDK_VISIBILITY_FULLY_OBSCURED
constant
GTK.refdoc.GTK.GDK_VISIBILITY_FULLY_OBSCURED
-
Constant GDK_VISIBILITY_NOTIFY
constant
GTK.refdoc.GTK.GDK_VISIBILITY_NOTIFY
-
Constant GDK_VISIBILITY_NOTIFY_MASK
constant
GTK.refdoc.GTK.GDK_VISIBILITY_NOTIFY_MASK
-
Constant GDK_VISIBILITY_PARTIAL
constant
GTK.refdoc.GTK.GDK_VISIBILITY_PARTIAL
-
Constant GDK_VISIBILITY_UNOBSCURED
constant
GTK.refdoc.GTK.GDK_VISIBILITY_UNOBSCURED
-
Constant GDK_VISUAL_DIRECT_COLOR
constant
GTK.refdoc.GTK.GDK_VISUAL_DIRECT_COLOR
-
Constant GDK_VISUAL_GRAYSCALE
constant
GTK.refdoc.GTK.GDK_VISUAL_GRAYSCALE
-
Constant GDK_VISUAL_PSEUDO_COLOR
constant
GTK.refdoc.GTK.GDK_VISUAL_PSEUDO_COLOR
-
Constant GDK_VISUAL_STATIC_COLOR
constant
GTK.refdoc.GTK.GDK_VISUAL_STATIC_COLOR
-
Constant GDK_VISUAL_STATIC_GRAY
constant
GTK.refdoc.GTK.GDK_VISUAL_STATIC_GRAY
-
Constant GDK_VISUAL_TRUE_COLOR
constant
GTK.refdoc.GTK.GDK_VISUAL_TRUE_COLOR
-
Constant GDK_WATCH
constant
GTK.refdoc.GTK.GDK_WATCH
-
Constant GDK_WA_COLORMAP
constant
GTK.refdoc.GTK.GDK_WA_COLORMAP
-
Constant GDK_WA_CURSOR
constant
GTK.refdoc.GTK.GDK_WA_CURSOR
-
Constant GDK_WA_NOREDIR
constant
GTK.refdoc.GTK.GDK_WA_NOREDIR
-
Constant GDK_WA_TITLE
constant
GTK.refdoc.GTK.GDK_WA_TITLE
-
Constant GDK_WA_VISUAL
constant
GTK.refdoc.GTK.GDK_WA_VISUAL
-
Constant GDK_WA_WMCLASS
constant
GTK.refdoc.GTK.GDK_WA_WMCLASS
-
Constant GDK_WA_X
constant
GTK.refdoc.GTK.GDK_WA_X
-
Constant GDK_WA_Y
constant
GTK.refdoc.GTK.GDK_WA_Y
-
Constant GDK_WINDING_RULE
constant
GTK.refdoc.GTK.GDK_WINDING_RULE
-
Constant GDK_WINDOW_CHILD
constant
GTK.refdoc.GTK.GDK_WINDOW_CHILD
-
Constant GDK_WINDOW_DIALOG
constant
GTK.refdoc.GTK.GDK_WINDOW_DIALOG
-
Constant GDK_WINDOW_EDGE_EAST
constant
GTK.refdoc.GTK.GDK_WINDOW_EDGE_EAST
-
Constant GDK_WINDOW_EDGE_NORTH
constant
GTK.refdoc.GTK.GDK_WINDOW_EDGE_NORTH
-
Constant GDK_WINDOW_EDGE_NORTH_EAST
constant
GTK.refdoc.GTK.GDK_WINDOW_EDGE_NORTH_EAST
-
Constant GDK_WINDOW_EDGE_NORTH_WEST
constant
GTK.refdoc.GTK.GDK_WINDOW_EDGE_NORTH_WEST
-
Constant GDK_WINDOW_EDGE_SOUTH
constant
GTK.refdoc.GTK.GDK_WINDOW_EDGE_SOUTH
-
Constant GDK_WINDOW_EDGE_SOUTH_EAST
constant
GTK.refdoc.GTK.GDK_WINDOW_EDGE_SOUTH_EAST
-
Constant GDK_WINDOW_EDGE_SOUTH_WEST
constant
GTK.refdoc.GTK.GDK_WINDOW_EDGE_SOUTH_WEST
-
Constant GDK_WINDOW_EDGE_WEST
constant
GTK.refdoc.GTK.GDK_WINDOW_EDGE_WEST
-
Constant GDK_WINDOW_FOREIGN
constant
GTK.refdoc.GTK.GDK_WINDOW_FOREIGN
-
Constant GDK_WINDOW_ROOT
constant
GTK.refdoc.GTK.GDK_WINDOW_ROOT
-
Constant GDK_WINDOW_STATE
constant
GTK.refdoc.GTK.GDK_WINDOW_STATE
-
Constant GDK_WINDOW_STATE_FULLSCREEN
constant
GTK.refdoc.GTK.GDK_WINDOW_STATE_FULLSCREEN
-
Constant GDK_WINDOW_STATE_ICONIFIED
constant
GTK.refdoc.GTK.GDK_WINDOW_STATE_ICONIFIED
-
Constant GDK_WINDOW_STATE_MAXIMIZED
constant
GTK.refdoc.GTK.GDK_WINDOW_STATE_MAXIMIZED
-
Constant GDK_WINDOW_STATE_STICKY
constant
GTK.refdoc.GTK.GDK_WINDOW_STATE_STICKY
-
Constant GDK_WINDOW_STATE_WITHDRAWN
constant
GTK.refdoc.GTK.GDK_WINDOW_STATE_WITHDRAWN
-
Constant GDK_WINDOW_TEMP
constant
GTK.refdoc.GTK.GDK_WINDOW_TEMP
-
Constant GDK_WINDOW_TOPLEVEL
constant
GTK.refdoc.GTK.GDK_WINDOW_TOPLEVEL
-
Constant GDK_WINDOW_TYPE_HINT_DESKTOP
constant
GTK.refdoc.GTK.GDK_WINDOW_TYPE_HINT_DESKTOP
-
Constant GDK_WINDOW_TYPE_HINT_DIALOG
constant
GTK.refdoc.GTK.GDK_WINDOW_TYPE_HINT_DIALOG
-
Constant GDK_WINDOW_TYPE_HINT_DOCK
constant
GTK.refdoc.GTK.GDK_WINDOW_TYPE_HINT_DOCK
-
Constant GDK_WINDOW_TYPE_HINT_MENU
constant
GTK.refdoc.GTK.GDK_WINDOW_TYPE_HINT_MENU
-
Constant GDK_WINDOW_TYPE_HINT_NORMAL
constant
GTK.refdoc.GTK.GDK_WINDOW_TYPE_HINT_NORMAL
-
Constant GDK_WINDOW_TYPE_HINT_SPLASHSCREEN
constant
GTK.refdoc.GTK.GDK_WINDOW_TYPE_HINT_SPLASHSCREEN
-
Constant GDK_WINDOW_TYPE_HINT_TOOLBAR
constant
GTK.refdoc.GTK.GDK_WINDOW_TYPE_HINT_TOOLBAR
-
Constant GDK_WINDOW_TYPE_HINT_UTILITY
constant
GTK.refdoc.GTK.GDK_WINDOW_TYPE_HINT_UTILITY
-
Constant GDK_XOR
constant
GTK.refdoc.GTK.GDK_XOR
-
Constant GDK_XTERM
constant
GTK.refdoc.GTK.GDK_XTERM
-
Constant GDK_X_CURSOR
constant
GTK.refdoc.GTK.GDK_X_CURSOR
-
Constant ACCEL_LOCKED
constant
GTK.refdoc.GTK.ACCEL_LOCKED
-
Constant ACCEL_MASK
constant
GTK.refdoc.GTK.ACCEL_MASK
-
Constant ACCEL_VISIBLE
constant
GTK.refdoc.GTK.ACCEL_VISIBLE
-
Constant ANCHOR_CENTER
constant
GTK.refdoc.GTK.ANCHOR_CENTER
-
Constant ANCHOR_E
constant
GTK.refdoc.GTK.ANCHOR_E
-
Constant ANCHOR_EAST
constant
GTK.refdoc.GTK.ANCHOR_EAST
-
Constant ANCHOR_N
constant
GTK.refdoc.GTK.ANCHOR_N
-
Constant ANCHOR_NE
constant
GTK.refdoc.GTK.ANCHOR_NE
-
Constant ANCHOR_NORTH
constant
GTK.refdoc.GTK.ANCHOR_NORTH
-
Constant ANCHOR_NORTH_EAST
constant
GTK.refdoc.GTK.ANCHOR_NORTH_EAST
-
Constant ANCHOR_NORTH_WEST
constant
GTK.refdoc.GTK.ANCHOR_NORTH_WEST
-
Constant ANCHOR_NW
constant
GTK.refdoc.GTK.ANCHOR_NW
-
Constant ANCHOR_S
constant
GTK.refdoc.GTK.ANCHOR_S
-
Constant ANCHOR_SE
constant
GTK.refdoc.GTK.ANCHOR_SE
-
Constant ANCHOR_SOUTH
constant
GTK.refdoc.GTK.ANCHOR_SOUTH
-
Constant ANCHOR_SOUTH_EAST
constant
GTK.refdoc.GTK.ANCHOR_SOUTH_EAST
-
Constant ANCHOR_SOUTH_WEST
constant
GTK.refdoc.GTK.ANCHOR_SOUTH_WEST
-
Constant ANCHOR_SW
constant
GTK.refdoc.GTK.ANCHOR_SW
-
Constant ANCHOR_W
constant
GTK.refdoc.GTK.ANCHOR_W
-
Constant ANCHOR_WEST
constant
GTK.refdoc.GTK.ANCHOR_WEST
-
Constant APP_PAINTABLE
constant
GTK.refdoc.GTK.APP_PAINTABLE
-
Constant ARROW_DOWN
constant
GTK.refdoc.GTK.ARROW_DOWN
-
Constant ARROW_LEFT
constant
GTK.refdoc.GTK.ARROW_LEFT
-
Constant ARROW_RIGHT
constant
GTK.refdoc.GTK.ARROW_RIGHT
-
Constant ARROW_UP
constant
GTK.refdoc.GTK.ARROW_UP
-
Constant BUTTONBOX_DEFAULT_STYLE
constant
GTK.refdoc.GTK.BUTTONBOX_DEFAULT_STYLE
-
Constant BUTTONBOX_EDGE
constant
GTK.refdoc.GTK.BUTTONBOX_EDGE
-
Constant BUTTONBOX_END
constant
GTK.refdoc.GTK.BUTTONBOX_END
-
Constant BUTTONBOX_SPREAD
constant
GTK.refdoc.GTK.BUTTONBOX_SPREAD
-
Constant BUTTONBOX_START
constant
GTK.refdoc.GTK.BUTTONBOX_START
-
Constant BUTTONS_CANCEL
constant
GTK.refdoc.GTK.BUTTONS_CANCEL
-
Constant BUTTONS_CLOSE
constant
GTK.refdoc.GTK.BUTTONS_CLOSE
-
Constant BUTTONS_NONE
constant
GTK.refdoc.GTK.BUTTONS_NONE
-
Constant BUTTONS_OK
constant
GTK.refdoc.GTK.BUTTONS_OK
-
Constant BUTTONS_OK_CANCEL
constant
GTK.refdoc.GTK.BUTTONS_OK_CANCEL
-
Constant BUTTONS_YES_NO
constant
GTK.refdoc.GTK.BUTTONS_YES_NO
-
Constant CALENDAR_NO_MONTH_CHANGE
constant
GTK.refdoc.GTK.CALENDAR_NO_MONTH_CHANGE
-
Constant CALENDAR_SHOW_DAY_NAMES
constant
GTK.refdoc.GTK.CALENDAR_SHOW_DAY_NAMES
-
Constant CALENDAR_SHOW_HEADING
constant
GTK.refdoc.GTK.CALENDAR_SHOW_HEADING
-
Constant CALENDAR_SHOW_WEEK_NUMBERS
constant
GTK.refdoc.GTK.CALENDAR_SHOW_WEEK_NUMBERS
-
Constant CALENDAR_WEEK_START_MONDAY
constant
GTK.refdoc.GTK.CALENDAR_WEEK_START_MONDAY
-
Constant CAN_DEFAULT
constant
GTK.refdoc.GTK.CAN_DEFAULT
-
Constant CAN_FOCUS
constant
GTK.refdoc.GTK.CAN_FOCUS
-
Constant CELL_RENDERER_INSENSITIVE
constant
GTK.refdoc.GTK.CELL_RENDERER_INSENSITIVE
-
Constant CELL_RENDERER_MODE_ACTIVATABLE
constant
GTK.refdoc.GTK.CELL_RENDERER_MODE_ACTIVATABLE
-
Constant CELL_RENDERER_MODE_EDITABLE
constant
GTK.refdoc.GTK.CELL_RENDERER_MODE_EDITABLE
-
Constant CELL_RENDERER_MODE_INERT
constant
GTK.refdoc.GTK.CELL_RENDERER_MODE_INERT
-
Constant CELL_RENDERER_PRELIT
constant
GTK.refdoc.GTK.CELL_RENDERER_PRELIT
-
Constant CELL_RENDERER_SELECTED
constant
GTK.refdoc.GTK.CELL_RENDERER_SELECTED
-
Constant CELL_RENDERER_SORTED
constant
GTK.refdoc.GTK.CELL_RENDERER_SORTED
-
Constant CENTIMETERS
constant
GTK.refdoc.GTK.CENTIMETERS
-
Constant COMPOSITE_CHILD
constant
GTK.refdoc.GTK.COMPOSITE_CHILD
-
Constant CORNER_BOTTOM_LEFT
constant
GTK.refdoc.GTK.CORNER_BOTTOM_LEFT
-
Constant CORNER_BOTTOM_RIGHT
constant
GTK.refdoc.GTK.CORNER_BOTTOM_RIGHT
-
Constant CORNER_TOP_LEFT
constant
GTK.refdoc.GTK.CORNER_TOP_LEFT
-
Constant CORNER_TOP_RIGHT
constant
GTK.refdoc.GTK.CORNER_TOP_RIGHT
-
Constant CURVE_TYPE_FREE
constant
GTK.refdoc.GTK.CURVE_TYPE_FREE
-
Constant CURVE_TYPE_LINEAR
constant
GTK.refdoc.GTK.CURVE_TYPE_LINEAR
-
Constant CURVE_TYPE_SPLINE
constant
GTK.refdoc.GTK.CURVE_TYPE_SPLINE
-
Constant DELETE_CHARS
constant
GTK.refdoc.GTK.DELETE_CHARS
-
Constant DELETE_DISPLAY_LINES
constant
GTK.refdoc.GTK.DELETE_DISPLAY_LINES
-
Constant DELETE_DISPLAY_LINE_ENDS
constant
GTK.refdoc.GTK.DELETE_DISPLAY_LINE_ENDS
-
Constant DELETE_PARAGRAPHS
constant
GTK.refdoc.GTK.DELETE_PARAGRAPHS
-
Constant DELETE_PARAGRAPH_ENDS
constant
GTK.refdoc.GTK.DELETE_PARAGRAPH_ENDS
-
Constant DELETE_WHITESPACE
constant
GTK.refdoc.GTK.DELETE_WHITESPACE
-
Constant DELETE_WORDS
constant
GTK.refdoc.GTK.DELETE_WORDS
-
Constant DELETE_WORD_ENDS
constant
GTK.refdoc.GTK.DELETE_WORD_ENDS
-
Constant DEST_DEFAULT_ALL
constant
GTK.refdoc.GTK.DEST_DEFAULT_ALL
-
Constant DEST_DEFAULT_DROP
constant
GTK.refdoc.GTK.DEST_DEFAULT_DROP
-
Constant DEST_DEFAULT_HIGHLIGHT
constant
GTK.refdoc.GTK.DEST_DEFAULT_HIGHLIGHT
-
Constant DEST_DEFAULT_MOTION
constant
GTK.refdoc.GTK.DEST_DEFAULT_MOTION
-
Constant DIALOG_DESTROY_WITH_PARENT
constant
GTK.refdoc.GTK.DIALOG_DESTROY_WITH_PARENT
-
Constant DIALOG_MODAL
constant
GTK.refdoc.GTK.DIALOG_MODAL
-
Constant DIALOG_NO_SEPARATOR
constant
GTK.refdoc.GTK.DIALOG_NO_SEPARATOR
-
Constant DIR_DOWN
constant
GTK.refdoc.GTK.DIR_DOWN
-
Constant DIR_LEFT
constant
GTK.refdoc.GTK.DIR_LEFT
-
Constant DIR_RIGHT
constant
GTK.refdoc.GTK.DIR_RIGHT
-
Constant DIR_TAB_BACKWARD
constant
GTK.refdoc.GTK.DIR_TAB_BACKWARD
-
Constant DIR_TAB_FORWARD
constant
GTK.refdoc.GTK.DIR_TAB_FORWARD
-
Constant DIR_UP
constant
GTK.refdoc.GTK.DIR_UP
-
Constant DOUBLE_BUFFERED
constant
GTK.refdoc.GTK.DOUBLE_BUFFERED
-
Constant EXPAND
constant
GTK.refdoc.GTK.EXPAND
-
Constant EXPANDER_COLLAPSED
constant
GTK.refdoc.GTK.EXPANDER_COLLAPSED
-
Constant EXPANDER_EXPANDED
constant
GTK.refdoc.GTK.EXPANDER_EXPANDED
-
Constant EXPANDER_SEMI_COLLAPSED
constant
GTK.refdoc.GTK.EXPANDER_SEMI_COLLAPSED
-
Constant EXPANDER_SEMI_EXPANDED
constant
GTK.refdoc.GTK.EXPANDER_SEMI_EXPANDED
-
Constant FILL
constant
GTK.refdoc.GTK.FILL
-
Constant FLOATING
constant
GTK.refdoc.GTK.FLOATING
-
Constant HAS_DEFAULT
constant
GTK.refdoc.GTK.HAS_DEFAULT
-
Constant HAS_FOCUS
constant
GTK.refdoc.GTK.HAS_FOCUS
-
Constant HAS_GRAB
constant
GTK.refdoc.GTK.HAS_GRAB
-
Constant ICON_SIZE_BUTTON
constant
GTK.refdoc.GTK.ICON_SIZE_BUTTON
-
Constant ICON_SIZE_DIALOG
constant
GTK.refdoc.GTK.ICON_SIZE_DIALOG
-
Constant ICON_SIZE_DND
constant
GTK.refdoc.GTK.ICON_SIZE_DND
-
Constant ICON_SIZE_INVALID
constant
GTK.refdoc.GTK.ICON_SIZE_INVALID
-
Constant ICON_SIZE_LARGE_TOOLBAR
constant
GTK.refdoc.GTK.ICON_SIZE_LARGE_TOOLBAR
-
Constant ICON_SIZE_MENU
constant
GTK.refdoc.GTK.ICON_SIZE_MENU
-
Constant ICON_SIZE_SMALL_TOOLBAR
constant
GTK.refdoc.GTK.ICON_SIZE_SMALL_TOOLBAR
-
Constant IMAGE_ANIMATION
constant
GTK.refdoc.GTK.IMAGE_ANIMATION
-
Constant IMAGE_EMPTY
constant
GTK.refdoc.GTK.IMAGE_EMPTY
-
Constant IMAGE_ICON_SET
constant
GTK.refdoc.GTK.IMAGE_ICON_SET
-
Constant IMAGE_IMAGE
constant
GTK.refdoc.GTK.IMAGE_IMAGE
-
Constant IMAGE_PIXBUF
constant
GTK.refdoc.GTK.IMAGE_PIXBUF
-
Constant IMAGE_PIXMAP
constant
GTK.refdoc.GTK.IMAGE_PIXMAP
-
Constant IMAGE_STOCK
constant
GTK.refdoc.GTK.IMAGE_STOCK
-
Constant IM_PREEDIT_CALLBACK
constant
GTK.refdoc.GTK.IM_PREEDIT_CALLBACK
-
Constant IM_PREEDIT_NOTHING
constant
GTK.refdoc.GTK.IM_PREEDIT_NOTHING
-
Constant IM_STATUS_CALLBACK
constant
GTK.refdoc.GTK.IM_STATUS_CALLBACK
-
Constant IM_STATUS_NOTHING
constant
GTK.refdoc.GTK.IM_STATUS_NOTHING
-
Constant INCHES
constant
GTK.refdoc.GTK.INCHES
-
Constant IN_DESTRUCTION
constant
GTK.refdoc.GTK.IN_DESTRUCTION
-
Constant JUSTIFY_CENTER
constant
GTK.refdoc.GTK.JUSTIFY_CENTER
-
Constant JUSTIFY_FILL
constant
GTK.refdoc.GTK.JUSTIFY_FILL
-
Constant JUSTIFY_LEFT
constant
GTK.refdoc.GTK.JUSTIFY_LEFT
-
Constant JUSTIFY_RIGHT
constant
GTK.refdoc.GTK.JUSTIFY_RIGHT
-
Constant MAPPED
constant
GTK.refdoc.GTK.MAPPED
-
Constant MENU_DIR_CHILD
constant
GTK.refdoc.GTK.MENU_DIR_CHILD
-
Constant MENU_DIR_NEXT
constant
GTK.refdoc.GTK.MENU_DIR_NEXT
-
Constant MENU_DIR_PARENT
constant
GTK.refdoc.GTK.MENU_DIR_PARENT
-
Constant MENU_DIR_PREV
constant
GTK.refdoc.GTK.MENU_DIR_PREV
-
Constant MESSAGE_ERROR
constant
GTK.refdoc.GTK.MESSAGE_ERROR
-
Constant MESSAGE_INFO
constant
GTK.refdoc.GTK.MESSAGE_INFO
-
Constant MESSAGE_QUESTION
constant
GTK.refdoc.GTK.MESSAGE_QUESTION
-
Constant MESSAGE_WARNING
constant
GTK.refdoc.GTK.MESSAGE_WARNING
-
Constant MOVEMENT_BUFFER_ENDS
constant
GTK.refdoc.GTK.MOVEMENT_BUFFER_ENDS
-
Constant MOVEMENT_DISPLAY_LINES
constant
GTK.refdoc.GTK.MOVEMENT_DISPLAY_LINES
-
Constant MOVEMENT_DISPLAY_LINE_ENDS
constant
GTK.refdoc.GTK.MOVEMENT_DISPLAY_LINE_ENDS
-
Constant MOVEMENT_LOGICAL_POSITIONS
constant
GTK.refdoc.GTK.MOVEMENT_LOGICAL_POSITIONS
-
Constant MOVEMENT_PAGES
constant
GTK.refdoc.GTK.MOVEMENT_PAGES
-
Constant MOVEMENT_PARAGRAPHS
constant
GTK.refdoc.GTK.MOVEMENT_PARAGRAPHS
-
Constant MOVEMENT_PARAGRAPH_ENDS
constant
GTK.refdoc.GTK.MOVEMENT_PARAGRAPH_ENDS
-
Constant MOVEMENT_VISUAL_POSITIONS
constant
GTK.refdoc.GTK.MOVEMENT_VISUAL_POSITIONS
-
Constant MOVEMENT_WORDS
constant
GTK.refdoc.GTK.MOVEMENT_WORDS
-
Constant NO_REPARENT
constant
GTK.refdoc.GTK.NO_REPARENT
-
Constant NO_WINDOW
constant
GTK.refdoc.GTK.NO_WINDOW
-
Constant ORIENTATION_HORIZONTAL
constant
GTK.refdoc.GTK.ORIENTATION_HORIZONTAL
-
Constant ORIENTATION_VERTICAL
constant
GTK.refdoc.GTK.ORIENTATION_VERTICAL
-
Constant PACK_END
constant
GTK.refdoc.GTK.PACK_END
-
Constant PACK_START
constant
GTK.refdoc.GTK.PACK_START
-
Constant PARENT_SENSITIVE
constant
GTK.refdoc.GTK.PARENT_SENSITIVE
-
Constant PATH_CLASS
constant
GTK.refdoc.GTK.PATH_CLASS
-
Constant PATH_PRIO_APPLICATION
constant
GTK.refdoc.GTK.PATH_PRIO_APPLICATION
-
Constant PATH_PRIO_GTK
constant
GTK.refdoc.GTK.PATH_PRIO_GTK
-
Constant PATH_PRIO_HIGHEST
constant
GTK.refdoc.GTK.PATH_PRIO_HIGHEST
-
Constant PATH_PRIO_LOWEST
constant
GTK.refdoc.GTK.PATH_PRIO_LOWEST
-
Constant PATH_PRIO_RC
constant
GTK.refdoc.GTK.PATH_PRIO_RC
-
Constant PATH_PRIO_THEME
constant
GTK.refdoc.GTK.PATH_PRIO_THEME
-
Constant PATH_WIDGET
constant
GTK.refdoc.GTK.PATH_WIDGET
-
Constant PATH_WIDGET_CLASS
constant
GTK.refdoc.GTK.PATH_WIDGET_CLASS
-
Constant PIXELS
constant
GTK.refdoc.GTK.PIXELS
-
Constant POLICY_ALWAYS
constant
GTK.refdoc.GTK.POLICY_ALWAYS
-
Constant POLICY_AUTOMATIC
constant
GTK.refdoc.GTK.POLICY_AUTOMATIC
-
Constant POLICY_NEVER
constant
GTK.refdoc.GTK.POLICY_NEVER
-
Constant POS_BOTTOM
constant
GTK.refdoc.GTK.POS_BOTTOM
-
Constant POS_LEFT
constant
GTK.refdoc.GTK.POS_LEFT
-
Constant POS_RIGHT
constant
GTK.refdoc.GTK.POS_RIGHT
-
Constant POS_TOP
constant
GTK.refdoc.GTK.POS_TOP
-
Constant PROGRESS_BOTTOM_TO_TOP
constant
GTK.refdoc.GTK.PROGRESS_BOTTOM_TO_TOP
-
Constant PROGRESS_CONTINUOUS
constant
GTK.refdoc.GTK.PROGRESS_CONTINUOUS
-
Constant PROGRESS_DISCRETE
constant
GTK.refdoc.GTK.PROGRESS_DISCRETE
-
Constant PROGRESS_LEFT_TO_RIGHT
constant
GTK.refdoc.GTK.PROGRESS_LEFT_TO_RIGHT
-
Constant PROGRESS_RIGHT_TO_LEFT
constant
GTK.refdoc.GTK.PROGRESS_RIGHT_TO_LEFT
-
Constant PROGRESS_TOP_TO_BOTTOM
constant
GTK.refdoc.GTK.PROGRESS_TOP_TO_BOTTOM
-
Constant RC_BASE
constant
GTK.refdoc.GTK.RC_BASE
-
Constant RC_BG
constant
GTK.refdoc.GTK.RC_BG
-
Constant RC_FG
constant
GTK.refdoc.GTK.RC_FG
-
Constant RC_STYLE
constant
GTK.refdoc.GTK.RC_STYLE
-
Constant RC_TEXT
constant
GTK.refdoc.GTK.RC_TEXT
-
Constant RC_TOKEN_ACTIVE
constant
GTK.refdoc.GTK.RC_TOKEN_ACTIVE
-
Constant RC_TOKEN_APPLICATION
constant
GTK.refdoc.GTK.RC_TOKEN_APPLICATION
-
Constant RC_TOKEN_BASE
constant
GTK.refdoc.GTK.RC_TOKEN_BASE
-
Constant RC_TOKEN_BG
constant
GTK.refdoc.GTK.RC_TOKEN_BG
-
Constant RC_TOKEN_BG_PIXMAP
constant
GTK.refdoc.GTK.RC_TOKEN_BG_PIXMAP
-
Constant RC_TOKEN_BIND
constant
GTK.refdoc.GTK.RC_TOKEN_BIND
-
Constant RC_TOKEN_BINDING
constant
GTK.refdoc.GTK.RC_TOKEN_BINDING
-
Constant RC_TOKEN_CLASS
constant
GTK.refdoc.GTK.RC_TOKEN_CLASS
-
Constant RC_TOKEN_ENGINE
constant
GTK.refdoc.GTK.RC_TOKEN_ENGINE
-
Constant RC_TOKEN_FG
constant
GTK.refdoc.GTK.RC_TOKEN_FG
-
Constant RC_TOKEN_FONT
constant
GTK.refdoc.GTK.RC_TOKEN_FONT
-
Constant RC_TOKEN_FONTSET
constant
GTK.refdoc.GTK.RC_TOKEN_FONTSET
-
Constant RC_TOKEN_FONT_NAME
constant
GTK.refdoc.GTK.RC_TOKEN_FONT_NAME
-
Constant RC_TOKEN_GTK
constant
GTK.refdoc.GTK.RC_TOKEN_GTK
-
Constant RC_TOKEN_HIGHEST
constant
GTK.refdoc.GTK.RC_TOKEN_HIGHEST
-
Constant RC_TOKEN_IM_MODULE_FILE
constant
GTK.refdoc.GTK.RC_TOKEN_IM_MODULE_FILE
-
Constant RC_TOKEN_IM_MODULE_PATH
constant
GTK.refdoc.GTK.RC_TOKEN_IM_MODULE_PATH
-
Constant RC_TOKEN_INCLUDE
constant
GTK.refdoc.GTK.RC_TOKEN_INCLUDE
-
Constant RC_TOKEN_INSENSITIVE
constant
GTK.refdoc.GTK.RC_TOKEN_INSENSITIVE
-
Constant RC_TOKEN_INVALID
constant
GTK.refdoc.GTK.RC_TOKEN_INVALID
-
Constant RC_TOKEN_LAST
constant
GTK.refdoc.GTK.RC_TOKEN_LAST
-
Constant RC_TOKEN_LOWEST
constant
GTK.refdoc.GTK.RC_TOKEN_LOWEST
-
Constant RC_TOKEN_LTR
constant
GTK.refdoc.GTK.RC_TOKEN_LTR
-
Constant RC_TOKEN_MODULE_PATH
constant
GTK.refdoc.GTK.RC_TOKEN_MODULE_PATH
-
Constant RC_TOKEN_NORMAL
constant
GTK.refdoc.GTK.RC_TOKEN_NORMAL
-
Constant RC_TOKEN_PIXMAP_PATH
constant
GTK.refdoc.GTK.RC_TOKEN_PIXMAP_PATH
-
Constant RC_TOKEN_PRELIGHT
constant
GTK.refdoc.GTK.RC_TOKEN_PRELIGHT
-
Constant RC_TOKEN_RC
constant
GTK.refdoc.GTK.RC_TOKEN_RC
-
Constant RC_TOKEN_RTL
constant
GTK.refdoc.GTK.RC_TOKEN_RTL
-
Constant RC_TOKEN_SELECTED
constant
GTK.refdoc.GTK.RC_TOKEN_SELECTED
-
Constant RC_TOKEN_STOCK
constant
GTK.refdoc.GTK.RC_TOKEN_STOCK
-
Constant RC_TOKEN_STYLE
constant
GTK.refdoc.GTK.RC_TOKEN_STYLE
-
Constant RC_TOKEN_TEXT
constant
GTK.refdoc.GTK.RC_TOKEN_TEXT
-
Constant RC_TOKEN_THEME
constant
GTK.refdoc.GTK.RC_TOKEN_THEME
-
Constant RC_TOKEN_WIDGET
constant
GTK.refdoc.GTK.RC_TOKEN_WIDGET
-
Constant RC_TOKEN_WIDGET_CLASS
constant
GTK.refdoc.GTK.RC_TOKEN_WIDGET_CLASS
-
Constant RC_TOKEN_XTHICKNESS
constant
GTK.refdoc.GTK.RC_TOKEN_XTHICKNESS
-
Constant RC_TOKEN_YTHICKNESS
constant
GTK.refdoc.GTK.RC_TOKEN_YTHICKNESS
-
Constant REALIZED
constant
GTK.refdoc.GTK.REALIZED
-
Constant RECEIVES_DEFAULT
constant
GTK.refdoc.GTK.RECEIVES_DEFAULT
-
Constant RELIEF_HALF
constant
GTK.refdoc.GTK.RELIEF_HALF
-
Constant RELIEF_NONE
constant
GTK.refdoc.GTK.RELIEF_NONE
-
Constant RELIEF_NORMAL
constant
GTK.refdoc.GTK.RELIEF_NORMAL
-
Constant RESERVED_1
constant
GTK.refdoc.GTK.RESERVED_1
-
Constant RESERVED_2
constant
GTK.refdoc.GTK.RESERVED_2
-
Constant RESIZE_IMMEDIATE
constant
GTK.refdoc.GTK.RESIZE_IMMEDIATE
-
Constant RESIZE_PARENT
constant
GTK.refdoc.GTK.RESIZE_PARENT
-
Constant RESIZE_QUEUE
constant
GTK.refdoc.GTK.RESIZE_QUEUE
-
Constant RESPONSE_ACCEPT
constant
GTK.refdoc.GTK.RESPONSE_ACCEPT
-
Constant RESPONSE_APPLY
constant
GTK.refdoc.GTK.RESPONSE_APPLY
-
Constant RESPONSE_CANCEL
constant
GTK.refdoc.GTK.RESPONSE_CANCEL
-
Constant RESPONSE_CLOSE
constant
GTK.refdoc.GTK.RESPONSE_CLOSE
-
Constant RESPONSE_DELETE_EVENT
constant
GTK.refdoc.GTK.RESPONSE_DELETE_EVENT
-
Constant RESPONSE_HELP
constant
GTK.refdoc.GTK.RESPONSE_HELP
-
Constant RESPONSE_NO
constant
GTK.refdoc.GTK.RESPONSE_NO
-
Constant RESPONSE_NONE
constant
GTK.refdoc.GTK.RESPONSE_NONE
-
Constant RESPONSE_OK
constant
GTK.refdoc.GTK.RESPONSE_OK
-
Constant RESPONSE_REJECT
constant
GTK.refdoc.GTK.RESPONSE_REJECT
-
Constant RESPONSE_YES
constant
GTK.refdoc.GTK.RESPONSE_YES
-
Constant SCROLL_END
constant
GTK.refdoc.GTK.SCROLL_END
-
Constant SCROLL_JUMP
constant
GTK.refdoc.GTK.SCROLL_JUMP
-
Constant SCROLL_NONE
constant
GTK.refdoc.GTK.SCROLL_NONE
-
Constant SCROLL_PAGE_BACKWARD
constant
GTK.refdoc.GTK.SCROLL_PAGE_BACKWARD
-
Constant SCROLL_PAGE_DOWN
constant
GTK.refdoc.GTK.SCROLL_PAGE_DOWN
-
Constant SCROLL_PAGE_FORWARD
constant
GTK.refdoc.GTK.SCROLL_PAGE_FORWARD
-
Constant SCROLL_PAGE_LEFT
constant
GTK.refdoc.GTK.SCROLL_PAGE_LEFT
-
Constant SCROLL_PAGE_RIGHT
constant
GTK.refdoc.GTK.SCROLL_PAGE_RIGHT
-
Constant SCROLL_PAGE_UP
constant
GTK.refdoc.GTK.SCROLL_PAGE_UP
-
Constant SCROLL_START
constant
GTK.refdoc.GTK.SCROLL_START
-
Constant SCROLL_STEP_BACKWARD
constant
GTK.refdoc.GTK.SCROLL_STEP_BACKWARD
-
Constant SCROLL_STEP_DOWN
constant
GTK.refdoc.GTK.SCROLL_STEP_DOWN
-
Constant SCROLL_STEP_FORWARD
constant
GTK.refdoc.GTK.SCROLL_STEP_FORWARD
-
Constant SCROLL_STEP_LEFT
constant
GTK.refdoc.GTK.SCROLL_STEP_LEFT
-
Constant SCROLL_STEP_RIGHT
constant
GTK.refdoc.GTK.SCROLL_STEP_RIGHT
-
Constant SCROLL_STEP_UP
constant
GTK.refdoc.GTK.SCROLL_STEP_UP
-
Constant SELECTION_BROWSE
constant
GTK.refdoc.GTK.SELECTION_BROWSE
-
Constant SELECTION_MULTIPLE
constant
GTK.refdoc.GTK.SELECTION_MULTIPLE
-
Constant SELECTION_NONE
constant
GTK.refdoc.GTK.SELECTION_NONE
-
Constant SELECTION_SINGLE
constant
GTK.refdoc.GTK.SELECTION_SINGLE
-
Constant SENSITIVE
constant
GTK.refdoc.GTK.SENSITIVE
-
Constant SHADOW_ETCHED_IN
constant
GTK.refdoc.GTK.SHADOW_ETCHED_IN
-
Constant SHADOW_ETCHED_OUT
constant
GTK.refdoc.GTK.SHADOW_ETCHED_OUT
-
Constant SHADOW_IN
constant
GTK.refdoc.GTK.SHADOW_IN
-
Constant SHADOW_NONE
constant
GTK.refdoc.GTK.SHADOW_NONE
-
Constant SHADOW_OUT
constant
GTK.refdoc.GTK.SHADOW_OUT
-
Constant SHRINK
constant
GTK.refdoc.GTK.SHRINK
-
Constant SIZE_GROUP_BOTH
constant
GTK.refdoc.GTK.SIZE_GROUP_BOTH
-
Constant SIZE_GROUP_HORIZONTAL
constant
GTK.refdoc.GTK.SIZE_GROUP_HORIZONTAL
-
Constant SIZE_GROUP_NONE
constant
GTK.refdoc.GTK.SIZE_GROUP_NONE
-
Constant SIZE_GROUP_VERTICAL
constant
GTK.refdoc.GTK.SIZE_GROUP_VERTICAL
-
Constant SORT_ASCENDING
constant
GTK.refdoc.GTK.SORT_ASCENDING
-
Constant SORT_DESCENDING
constant
GTK.refdoc.GTK.SORT_DESCENDING
-
Constant SPIN_END
constant
GTK.refdoc.GTK.SPIN_END
-
Constant SPIN_HOME
constant
GTK.refdoc.GTK.SPIN_HOME
-
Constant SPIN_PAGE_BACKWARD
constant
GTK.refdoc.GTK.SPIN_PAGE_BACKWARD
-
Constant SPIN_PAGE_FORWARD
constant
GTK.refdoc.GTK.SPIN_PAGE_FORWARD
-
Constant SPIN_STEP_BACKWARD
constant
GTK.refdoc.GTK.SPIN_STEP_BACKWARD
-
Constant SPIN_STEP_FORWARD
constant
GTK.refdoc.GTK.SPIN_STEP_FORWARD
-
Constant SPIN_USER_DEFINED
constant
GTK.refdoc.GTK.SPIN_USER_DEFINED
-
Constant STATE_ACTIVE
constant
GTK.refdoc.GTK.STATE_ACTIVE
-
Constant STATE_INSENSITIVE
constant
GTK.refdoc.GTK.STATE_INSENSITIVE
-
Constant STATE_NORMAL
constant
GTK.refdoc.GTK.STATE_NORMAL
-
Constant STATE_PRELIGHT
constant
GTK.refdoc.GTK.STATE_PRELIGHT
-
Constant STATE_SELECTED
constant
GTK.refdoc.GTK.STATE_SELECTED
-
Constant STOCK_ADD
constant
GTK.refdoc.GTK.STOCK_ADD
-
Constant STOCK_APPLY
constant
GTK.refdoc.GTK.STOCK_APPLY
-
Constant STOCK_BOLD
constant
GTK.refdoc.GTK.STOCK_BOLD
-
Constant STOCK_CANCEL
constant
GTK.refdoc.GTK.STOCK_CANCEL
-
Constant STOCK_CDROM
constant
GTK.refdoc.GTK.STOCK_CDROM
-
Constant STOCK_CLEAR
constant
GTK.refdoc.GTK.STOCK_CLEAR
-
Constant STOCK_CLOSE
constant
GTK.refdoc.GTK.STOCK_CLOSE
-
Constant STOCK_COLOR_PICKER
constant
GTK.refdoc.GTK.STOCK_COLOR_PICKER
-
Constant STOCK_CONVERT
constant
GTK.refdoc.GTK.STOCK_CONVERT
-
Constant STOCK_COPY
constant
GTK.refdoc.GTK.STOCK_COPY
-
Constant STOCK_CUT
constant
GTK.refdoc.GTK.STOCK_CUT
-
Constant STOCK_DELETE
constant
GTK.refdoc.GTK.STOCK_DELETE
-
Constant STOCK_DIALOG_ERROR
constant
GTK.refdoc.GTK.STOCK_DIALOG_ERROR
-
Constant STOCK_DIALOG_INFO
constant
GTK.refdoc.GTK.STOCK_DIALOG_INFO
-
Constant STOCK_DIALOG_QUESTION
constant
GTK.refdoc.GTK.STOCK_DIALOG_QUESTION
-
Constant STOCK_DIALOG_WARNING
constant
GTK.refdoc.GTK.STOCK_DIALOG_WARNING
-
Constant STOCK_DND
constant
GTK.refdoc.GTK.STOCK_DND
-
Constant STOCK_DND_MULTIPLE
constant
GTK.refdoc.GTK.STOCK_DND_MULTIPLE
-
Constant STOCK_EXECUTE
constant
GTK.refdoc.GTK.STOCK_EXECUTE
-
Constant STOCK_FIND
constant
GTK.refdoc.GTK.STOCK_FIND
-
Constant STOCK_FIND_AND_REPLACE
constant
GTK.refdoc.GTK.STOCK_FIND_AND_REPLACE
-
Constant STOCK_FLOPPY
constant
GTK.refdoc.GTK.STOCK_FLOPPY
-
Constant STOCK_GOTO_BOTTOM
constant
GTK.refdoc.GTK.STOCK_GOTO_BOTTOM
-
Constant STOCK_GOTO_FIRST
constant
GTK.refdoc.GTK.STOCK_GOTO_FIRST
-
Constant STOCK_GOTO_LAST
constant
GTK.refdoc.GTK.STOCK_GOTO_LAST
-
Constant STOCK_GOTO_TOP
constant
GTK.refdoc.GTK.STOCK_GOTO_TOP
-
Constant STOCK_GO_BACK
constant
GTK.refdoc.GTK.STOCK_GO_BACK
-
Constant STOCK_GO_DOWN
constant
GTK.refdoc.GTK.STOCK_GO_DOWN
-
Constant STOCK_GO_FORWARD
constant
GTK.refdoc.GTK.STOCK_GO_FORWARD
-
Constant STOCK_GO_UP
constant
GTK.refdoc.GTK.STOCK_GO_UP
-
Constant STOCK_HELP
constant
GTK.refdoc.GTK.STOCK_HELP
-
Constant STOCK_HOME
constant
GTK.refdoc.GTK.STOCK_HOME
-
Constant STOCK_INDEX
constant
GTK.refdoc.GTK.STOCK_INDEX
-
Constant STOCK_ITALIC
constant
GTK.refdoc.GTK.STOCK_ITALIC
-
Constant STOCK_JUMP_TO
constant
GTK.refdoc.GTK.STOCK_JUMP_TO
-
Constant STOCK_JUSTIFY_CENTER
constant
GTK.refdoc.GTK.STOCK_JUSTIFY_CENTER
-
Constant STOCK_JUSTIFY_FILL
constant
GTK.refdoc.GTK.STOCK_JUSTIFY_FILL
-
Constant STOCK_JUSTIFY_LEFT
constant
GTK.refdoc.GTK.STOCK_JUSTIFY_LEFT
-
Constant STOCK_JUSTIFY_RIGHT
constant
GTK.refdoc.GTK.STOCK_JUSTIFY_RIGHT
-
Constant STOCK_MISSING_IMAGE
constant
GTK.refdoc.GTK.STOCK_MISSING_IMAGE
-
Constant STOCK_NEW
constant
GTK.refdoc.GTK.STOCK_NEW
-
Constant STOCK_NO
constant
GTK.refdoc.GTK.STOCK_NO
-
Constant STOCK_OK
constant
GTK.refdoc.GTK.STOCK_OK
-
Constant STOCK_OPEN
constant
GTK.refdoc.GTK.STOCK_OPEN
-
Constant STOCK_PASTE
constant
GTK.refdoc.GTK.STOCK_PASTE
-
Constant STOCK_PREFERENCES
constant
GTK.refdoc.GTK.STOCK_PREFERENCES
-
Constant STOCK_PRINT
constant
GTK.refdoc.GTK.STOCK_PRINT
-
Constant STOCK_PRINT_PREVIEW
constant
GTK.refdoc.GTK.STOCK_PRINT_PREVIEW
-
Constant STOCK_PROPERTIES
constant
GTK.refdoc.GTK.STOCK_PROPERTIES
-
Constant STOCK_QUIT
constant
GTK.refdoc.GTK.STOCK_QUIT
-
Constant STOCK_REDO
constant
GTK.refdoc.GTK.STOCK_REDO
-
Constant STOCK_REFRESH
constant
GTK.refdoc.GTK.STOCK_REFRESH
-
Constant STOCK_REMOVE
constant
GTK.refdoc.GTK.STOCK_REMOVE
-
Constant STOCK_REVERT_TO_SAVED
constant
GTK.refdoc.GTK.STOCK_REVERT_TO_SAVED
-
Constant STOCK_SAVE
constant
GTK.refdoc.GTK.STOCK_SAVE
-
Constant STOCK_SAVE_AS
constant
GTK.refdoc.GTK.STOCK_SAVE_AS
-
Constant STOCK_SELECT_COLOR
constant
GTK.refdoc.GTK.STOCK_SELECT_COLOR
-
Constant STOCK_SELECT_FONT
constant
GTK.refdoc.GTK.STOCK_SELECT_FONT
-
Constant STOCK_SORT_ASCENDING
constant
GTK.refdoc.GTK.STOCK_SORT_ASCENDING
-
Constant STOCK_SORT_DESCENDING
constant
GTK.refdoc.GTK.STOCK_SORT_DESCENDING
-
Constant STOCK_SPELL_CHECK
constant
GTK.refdoc.GTK.STOCK_SPELL_CHECK
-
Constant STOCK_STOP
constant
GTK.refdoc.GTK.STOCK_STOP
-
Constant STOCK_STRIKETHROUGH
constant
GTK.refdoc.GTK.STOCK_STRIKETHROUGH
-
Constant STOCK_UNDELETE
constant
GTK.refdoc.GTK.STOCK_UNDELETE
-
Constant STOCK_UNDERLINE
constant
GTK.refdoc.GTK.STOCK_UNDERLINE
-
Constant STOCK_UNDO
constant
GTK.refdoc.GTK.STOCK_UNDO
-
Constant STOCK_YES
constant
GTK.refdoc.GTK.STOCK_YES
-
Constant STOCK_ZOOM_100
constant
GTK.refdoc.GTK.STOCK_ZOOM_100
-
Constant STOCK_ZOOM_FIT
constant
GTK.refdoc.GTK.STOCK_ZOOM_FIT
-
Constant STOCK_ZOOM_IN
constant
GTK.refdoc.GTK.STOCK_ZOOM_IN
-
Constant STOCK_ZOOM_OUT
constant
GTK.refdoc.GTK.STOCK_ZOOM_OUT
-
Constant TARGET_SAME_APP
constant
GTK.refdoc.GTK.TARGET_SAME_APP
-
Constant TARGET_SAME_WIDGET
constant
GTK.refdoc.GTK.TARGET_SAME_WIDGET
-
Constant TEXT_DIR_LTR
constant
GTK.refdoc.GTK.TEXT_DIR_LTR
-
Constant TEXT_DIR_NONE
constant
GTK.refdoc.GTK.TEXT_DIR_NONE
-
Constant TEXT_DIR_RTL
constant
GTK.refdoc.GTK.TEXT_DIR_RTL
-
Constant TEXT_SEARCH_TEXT_ONLY
constant
GTK.refdoc.GTK.TEXT_SEARCH_TEXT_ONLY
-
Constant TEXT_SEARCH_VISIBLE_ONLY
constant
GTK.refdoc.GTK.TEXT_SEARCH_VISIBLE_ONLY
-
Constant TEXT_WINDOW_BOTTOM
constant
GTK.refdoc.GTK.TEXT_WINDOW_BOTTOM
-
Constant TEXT_WINDOW_LEFT
constant
GTK.refdoc.GTK.TEXT_WINDOW_LEFT
-
Constant TEXT_WINDOW_PRIVATE
constant
GTK.refdoc.GTK.TEXT_WINDOW_PRIVATE
-
Constant TEXT_WINDOW_RIGHT
constant
GTK.refdoc.GTK.TEXT_WINDOW_RIGHT
-
Constant TEXT_WINDOW_TEXT
constant
GTK.refdoc.GTK.TEXT_WINDOW_TEXT
-
Constant TEXT_WINDOW_TOP
constant
GTK.refdoc.GTK.TEXT_WINDOW_TOP
-
Constant TEXT_WINDOW_WIDGET
constant
GTK.refdoc.GTK.TEXT_WINDOW_WIDGET
-
Constant TOOLBAR_BOTH
constant
GTK.refdoc.GTK.TOOLBAR_BOTH
-
Constant TOOLBAR_BOTH_HORIZ
constant
GTK.refdoc.GTK.TOOLBAR_BOTH_HORIZ
-
Constant TOOLBAR_ICONS
constant
GTK.refdoc.GTK.TOOLBAR_ICONS
-
Constant TOOLBAR_SPACE_EMPTY
constant
GTK.refdoc.GTK.TOOLBAR_SPACE_EMPTY
-
Constant TOOLBAR_SPACE_LINE
constant
GTK.refdoc.GTK.TOOLBAR_SPACE_LINE
-
Constant TOOLBAR_TEXT
constant
GTK.refdoc.GTK.TOOLBAR_TEXT
-
Constant TOPLEVEL
constant
GTK.refdoc.GTK.TOPLEVEL
-
Constant TREE_MODEL_ITERS_PERSIST
constant
GTK.refdoc.GTK.TREE_MODEL_ITERS_PERSIST
-
Constant TREE_MODEL_LIST_ONLY
constant
GTK.refdoc.GTK.TREE_MODEL_LIST_ONLY
-
Constant TREE_VIEW_COLUMN_AUTOSIZE
constant
GTK.refdoc.GTK.TREE_VIEW_COLUMN_AUTOSIZE
-
Constant TREE_VIEW_COLUMN_FIXED
constant
GTK.refdoc.GTK.TREE_VIEW_COLUMN_FIXED
-
Constant TREE_VIEW_COLUMN_GROW_ONLY
constant
GTK.refdoc.GTK.TREE_VIEW_COLUMN_GROW_ONLY
-
Constant TREE_VIEW_DROP_AFTER
constant
GTK.refdoc.GTK.TREE_VIEW_DROP_AFTER
-
Constant TREE_VIEW_DROP_BEFORE
constant
GTK.refdoc.GTK.TREE_VIEW_DROP_BEFORE
-
Constant TREE_VIEW_DROP_INTO_OR_AFTER
constant
GTK.refdoc.GTK.TREE_VIEW_DROP_INTO_OR_AFTER
-
Constant TREE_VIEW_DROP_INTO_OR_BEFORE
constant
GTK.refdoc.GTK.TREE_VIEW_DROP_INTO_OR_BEFORE
-
Constant UPDATE_ALWAYS
constant
GTK.refdoc.GTK.UPDATE_ALWAYS
-
Constant UPDATE_CONTINUOUS
constant
GTK.refdoc.GTK.UPDATE_CONTINUOUS
-
Constant UPDATE_DELAYED
constant
GTK.refdoc.GTK.UPDATE_DELAYED
-
Constant UPDATE_DISCONTINUOUS
constant
GTK.refdoc.GTK.UPDATE_DISCONTINUOUS
-
Constant UPDATE_IF_VALID
constant
GTK.refdoc.GTK.UPDATE_IF_VALID
-
Constant VISIBILITY_FULL
constant
GTK.refdoc.GTK.VISIBILITY_FULL
-
Constant VISIBILITY_NONE
constant
GTK.refdoc.GTK.VISIBILITY_NONE
-
Constant VISIBILITY_PARTIAL
constant
GTK.refdoc.GTK.VISIBILITY_PARTIAL
-
Constant VISIBLE
constant
GTK.refdoc.GTK.VISIBLE
-
Constant WIDGET_HELP_TOOLTIP
constant
GTK.refdoc.GTK.WIDGET_HELP_TOOLTIP
-
Constant WIDGET_HELP_WHATS_THIS
constant
GTK.refdoc.GTK.WIDGET_HELP_WHATS_THIS
-
Constant WINDOW_POPUP
constant
GTK.refdoc.GTK.WINDOW_POPUP
-
Constant WINDOW_TOPLEVEL
constant
GTK.refdoc.GTK.WINDOW_TOPLEVEL
-
Constant WIN_POS_CENTER
constant
GTK.refdoc.GTK.WIN_POS_CENTER
-
Constant WIN_POS_CENTER_ALWAYS
constant
GTK.refdoc.GTK.WIN_POS_CENTER_ALWAYS
-
Constant WIN_POS_CENTER_ON_PARENT
constant
GTK.refdoc.GTK.WIN_POS_CENTER_ON_PARENT
-
Constant WIN_POS_MOUSE
constant
GTK.refdoc.GTK.WIN_POS_MOUSE
-
Constant WIN_POS_NONE
constant
GTK.refdoc.GTK.WIN_POS_NONE
-
Constant WRAP_CHAR
constant
GTK.refdoc.GTK.WRAP_CHAR
-
Constant WRAP_NONE
constant
GTK.refdoc.GTK.WRAP_NONE
-
Constant WRAP_WORD
constant
GTK.refdoc.GTK.WRAP_WORD
-
Constant TRUE
constant
GTK.refdoc.GTK.TRUE
-
Method add_builtin_icon
void GTK.refdoc.GTK.add_builtin_icon(string name, int size, object(GDK.Pixbuf) 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 GTK+'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 GTK.refdoc.GTK.false()
- Description
Always returns false.
-
Method flush
void GTK.refdoc.GTK.flush()
- Description
Flush GDK. Not normally needed, can be useful while doing calculations.
-
Method get_default_icon_list
array GTK.refdoc.GTK.get_default_icon_list()
- Description
Gets the value set by set_default_icon_list().
-
Method get_default_icon_theme
object(GTK.IconTheme) GTK.refdoc.GTK.get_default_icon_theme()
- Description
Gets the icon theme.
-
Method grab_add
void GTK.refdoc.GTK.grab_add(object(GTK.Widget) widget)
- Description
Grab a widget.
-
Method grab_remove
void GTK.refdoc.GTK.grab_remove(object(GTK.Widget) widget)
- Description
Remove the grab.
-
Method gtk_init
array GTK.refdoc.GTK.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_toplevels
array GTK.refdoc.GTK.list_toplevels()
- Description
Returns a list of all existing toplevel windows.
-
Method low_flush
void GTK.refdoc.GTK.low_flush()
- Description
Flush, but do not process events. Not normally needed.
-
Method main
void GTK.refdoc.GTK.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 GTK.refdoc.GTK.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 GTK.refdoc.GTK.main_level()
- Description
Return the current recursion depth.
-
Method main_quit
void GTK.refdoc.GTK.main_quit()
- Description
Exit from the gtk_main function on the next iteration.
-
Method parse_rc
void GTK.refdoc.GTK.parse_rc(string rc)
- Description
Takes a string and reads it as a gtkrc file.
-
Method root_window
object(GDK.Window) GTK.refdoc.GTK.root_window()
- Description
Returns the root window of the current display
-
Method set_default_icon_list
void GTK.refdoc.GTK.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 setup_gtk
array GTK.refdoc.GTK.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 GTK.setup_gtk(argv);
-
Method true
int GTK.refdoc.GTK.true()
- Description
Always returns true.
|
| CLASS GTK.refdoc.GTK.TreeRowReference |
Methods
create()
destroy()
get_path()
valid()
|
- Description
A TreeRowReference.
-
Method create
object(GTK.TreeRowReference) GTK.refdoc.GTK.TreeRowReference()->create(object(GTK.TreeModel) model, object(GTK.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 destroy
object(GTK.TreeRowReference) GTK.refdoc.GTK.TreeRowReference()->destroy()
- Description
Destructor.
-
Method get_path
object(GTK.TreePath) GTK.refdoc.GTK.TreeRowReference()->get_path()
- Description
Returns a path that the row reference currently points to.
-
Method valid
int GTK.refdoc.GTK.TreeRowReference()->valid()
- Description
Return TRUE if the reference referes to a current valid path.
|
| CLASS GTK.refdoc.GTK.TreePath |
Methods
append_index()
compare()
copy()
create()
destroy()
down()
get_depth()
get_indices()
is_ancestor()
is_descendant()
next()
prepend_index()
prev()
to_string()
up()
|
- Description
TreePath.
-
Method append_index
object(GTK.TreePath) GTK.refdoc.GTK.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 GTK.refdoc.GTK.TreePath()->compare(object(GTK.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
object(GTK.TreePath) GTK.refdoc.GTK.TreePath()->copy()
- Description
Creates a new GTK.TreePath as a copy.
-
Method create
object(GTK.TreePath) GTK.refdoc.GTK.TreePath()->create(string|void path)
- Description
Creates a new GTK.TreePath.
-
Method destroy
object(GTK.TreePath) GTK.refdoc.GTK.TreePath()->destroy()
- Description
Destructor.
-
Method down
object(GTK.TreePath) GTK.refdoc.GTK.TreePath()->down()
- Description
Moves path to point to the first child of the current path.
-
Method get_depth
int GTK.refdoc.GTK.TreePath()->get_depth()
- Description
Returns the current depth of path.
-
Method get_indices
array GTK.refdoc.GTK.TreePath()->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 GTK.refdoc.GTK.TreePath()->is_ancestor(object(GTK.TreePath) descendant)
- Description
Returns TRUE if descendant is a descendant of this path.
-
Method is_descendant
int GTK.refdoc.GTK.TreePath()->is_descendant(object(GTK.TreePath) ancestor)
- Description
Returns TRUE if this path is a descendant of ancestor.
-
Method next
object(GTK.TreePath) GTK.refdoc.GTK.TreePath()->next()
- Description
Moves the path to point to the next node at the current depth.
-
Method prepend_index
object(GTK.TreePath) GTK.refdoc.GTK.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
object(GTK.TreePath) GTK.refdoc.GTK.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 GTK.refdoc.GTK.TreePath()->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
int GTK.refdoc.GTK.TreePath()->up()
- Description
Moves the path to point to its parent node, if it has a parent.
|
| CLASS GTK.refdoc.GTK.TreeSelection |
Methods
get_mode()
get_selected()
get_tree_view()
get_user_data()
iter_is_selected()
path_is_selected()
select_all()
select_iter()
select_path()
select_range()
set_mode()
unselect_all()
unselect_iter()
unselect_path()
unselect_range()
|
- Description
Selections on a treestore.
Signals:
changed
-
Inherit Object
G.Object
-
Method get_mode
int GTK.refdoc.GTK.TreeSelection()->get_mode()
- Description
Gets the selectiom mode.
-
Method get_selected
array GTK.refdoc.GTK.TreeSelection()->get_selected()
- Description
Returns a W(TreeITer) with the currently selected node if this selection
is set to GTK.SELECTION_SINGLE or GTK.SELECTION_BROWSE. Also returns
W(TreeModel) as a convenience. This function will not work if you this
selection is set to GTK.SELECTION_MULTIPLE.
-
Method get_tree_view
object(GTK.TreeView) GTK.refdoc.GTK.TreeSelection()->get_tree_view()
- Description
Returns the tree view associated with this selection.
-
Method get_user_data
object GTK.refdoc.GTK.TreeSelection()->get_user_data()
- Description
Returns the user data for the selection function.
-
Method iter_is_selected
int GTK.refdoc.GTK.TreeSelection()->iter_is_selected(object(GTK.TreeIter) iter)
- Description
Returns true if the row at iter is currently selected.
-
Method path_is_selected
int GTK.refdoc.GTK.TreeSelection()->path_is_selected(object(GTK.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
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeSelection()->select_all()
- Description
Selects all the nodes. This selection must be set to
GTK.SELECTION_MULTIPLE mode.
-
Method select_iter
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeSelection()->select_iter(object(GTK.TreeIter) iter)
- Description
Selects the specified iterator.
-
Method select_path
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeSelection()->select_path(object(GTK.TreePath) path)
- Description
Select the row at path.
-
Method select_range
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeSelection()->select_range(object(GTK.TreePath) start, object(GTK.TreePath) end)
- Description
Selects a range of nodes, determined by start and end inclusive.
This selection must be set to GTK.SELECTION_MULTIPLE mode.
-
Method set_mode
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeSelection()->set_mode(int type)
- Description
Sets the selection mode. If the previous type was GTK.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
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeSelection()->unselect_all()
- Description
Unselects all the nodes.
-
Method unselect_iter
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeSelection()->unselect_iter(object(GTK.TreeIter) iter)
- Description
Unselects the specified iterator.
-
Method unselect_path
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeSelection()->unselect_path(object(GTK.TreePath) path)
- Description
Unselects the row at path.
-
Method unselect_range
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeSelection()->unselect_range(object(GTK.TreePath) start, object(GTK.TreePath) end)
- Description
Unselects a range of nodes, determined by start and end inclusive.
|
| CLASS GTK.refdoc.GTK.TextTag |
Methods
create()
event()
get_priority()
set_priority()
|
- Description
Properties:
string background
int background-full-height
int background-full-height-set
GDK.Color background-gdk
int background-set
GDK.Pixmap background-stipple
int background-stipple-set
int direction
One of
int editable
int editable-set
string family
int family-set
string font
string foreground
GDK.Color foreground-gdk
int foreground-set
GDK.Pixmap foreground-stipple
int foreground-stipple-set
int indent
int indent-set
int invisible
int invisible_set
int justification
One of
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 strikethrough;
int strikethrough-set;
int weight;
int weight-set;
int wrap-mode;
One of
int wrap-mode-set;
Signals:
event
-
Inherit Object
G.Object
-
Method create
object(GTK.TextTag) GTK.refdoc.GTK.TextTag()->create(string name)
- Description
Creates a new text tag.
-
Method event
int GTK.refdoc.GTK.TextTag()->event(object(GTK.G.Object) event_object, object(GDK.Event) event, object(GTK.TextIter) iter)
- Description
Emits the 'event' signal.
-
Method get_priority
int GTK.refdoc.GTK.TextTag()->get_priority()
- Description
Gets the tag priority.
-
Method set_priority
object(GTK.TextTag) GTK.refdoc.GTK.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 GTK.refdoc.GTK.G.Object |
Methods
accel_groups_activate()
destroy()
get_property()
notify()
set_property()
signal_block()
signal_connect()
signal_disconnect()
signal_emit()
signal_unblock()
|
- Description
The base object. All GDK and GTK classes inherit from this.
The Pango classes also inherit from this class.
Signals:
notify
-
Method accel_groups_activate
object(G.Object) GTK.refdoc.GTK.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 destroy
object(G.Object) GTK.refdoc.GTK.G.Object()->destroy()
- Description
Destructor.
-
Method get_property
mixed GTK.refdoc.GTK.G.Object()->get_property(string property)
- Description
Get a property.
-
Method notify
object(G.Object) GTK.refdoc.GTK.G.Object()->notify(string property)
- Description
Emits a "notify" signal for the named property on the object.
-
Method set_property
object(G.Object) GTK.refdoc.GTK.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
object(G.Object) GTK.refdoc.GTK.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 GTK.refdoc.GTK.G.Object()->signal_connect(string signal, function callback, mixed|void callback_arg)
- Description
Connect a signal to a pike function. The function will be called with
the last argument to this function as it's first argument (defaults to 0),
the second argument is always the widget, and any other arguments are the
ones supplied by GTK.
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
object(G.Object) GTK.refdoc.GTK.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
object(G.Object) GTK.refdoc.GTK.G.Object()->signal_emit(string signal_name)
- Description
Send the current named signal.
-
Method signal_unblock
object(G.Object) GTK.refdoc.GTK.G.Object()->signal_unblock(int signal_id)
- Description
Unblock a formerly blocked signal handler. See signal_block() and
signal_connect() for more info.
|
| CLASS GTK.refdoc.GTK.CellRendererText |
Methods
create()
set_fixed_height_from_font()
|
- Description
Properties:
string background
GDK.Color background-gdk
int background-set
int editable
int editable-set
string foreground
GDK.Color foreground-gdk
int foreground-set
string language
int language-set
int rise
int rise-set
float scale
int scale-set
int single-paragraph-mode
int size
float size-points
int size-set
int strikethrough
int strikethrough-set
string text
int width-chars
Signals:
edited
-
Inherit CellRenderer
GTK.CellRenderer
-
Method create
object(GTK.CellRendererText) GTK.refdoc.GTK.CellRendererText()->create()
- 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
object(GTK.CellRendererText) GTK.refdoc.GTK.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 GTK.refdoc.GTK.IconSet |
Methods
add_source()
copy()
create()
destroy()
get_sizes()
|
- Description
Iconset. A single icon.
-
Method add_source
object(GTK.IconSet) GTK.refdoc.GTK.IconSet()->add_source(object(GTK.IconSource) source)
- Description
Icon sets have a list of GTK.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 GTK.IconSet needs base images
to work with. The base images and when to use them are described by a
GTK.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. GTK.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
object(GTK.IconSet) GTK.refdoc.GTK.IconSet()->copy()
- Description
Create a copy.
-
Method create
object(GTK.IconSet) GTK.refdoc.GTK.IconSet()->create(object(GDK.Pixbuf) pixbuf)
- Description
Create a new GTK.IconSet. A GTK.IconSet represents a single icon in
various sizes and widget states. It can provide a GDK.Pixbuf for a given
size and state on request, and automatically caches some of the rendered
GDK.Pixbuf objects.
Normally you would use GTK.Widget->render_icon() instead of using
GTK.IconSet directly. The one case where you'd use GTK.IconSet is to
create application-specific icon sets to place in a GTK.IconFactory.
-
Method destroy
object(GTK.IconSet) GTK.refdoc.GTK.IconSet()->destroy()
- Description
Destructor.
-
Method get_sizes
array GTK.refdoc.GTK.IconSet()->get_sizes()
- Description
Obtains a list of icon sizes this icon set can render.
|
| CLASS GTK.refdoc.GTK.Tooltips |
Methods
create()
disable()
enable()
force_window()
set_tip()
|
- 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 GTK.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
GTK.Data
-
Method create
object(GTK.Tooltips) GTK.refdoc.GTK.Tooltips()->create()
- Description
Creates an empty group of tooltips. This function initialises a
GTK.Tooltips structure. Without at least one such structure, you
can not add tips to your application.
-
Method disable
object(GTK.Tooltips) GTK.refdoc.GTK.Tooltips()->disable()
- Description
Disable this tooltip collection.
-
Method enable
object(GTK.Tooltips) GTK.refdoc.GTK.Tooltips()->enable()
- Description
Enable this tooltip collection.
-
Method force_window
object(GTK.Tooltips) GTK.refdoc.GTK.Tooltips()->force_window()
- Description
Realize the tooltip window (as returned from get_gdkwindow())
-
Method set_tip
object(GTK.Tooltips) GTK.refdoc.GTK.Tooltips()->set_tip(object(GTK.Widget) in, string to)
- Description
Adds a tooltip containing the message tip_text to the specified
W(Widget).
|
| CLASS GTK.refdoc.GTK.ProgressBar |
Methods
create()
get_fraction()
get_orientation()
get_pulse_step()
get_text()
pulse()
set_fraction()
set_orientation()
set_pulse_step()
set_text()
|
- 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.
GTK.ProgressBar()->update(0.1)
../images/gtk_progressbar.png
GTK.ProgressBar()->set_show_text(1)->update(0.3)
../images/gtk_progressbar_2.png
GTK.ProgressBar()->update(0.6)
../images/gtk_progressbar_3.png
GTK.ProgressBar()->update(1.0)
../images/gtk_progressbar_4.png
Properties:
int discrete-blocks
int ellipsize
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
GTK.Progress
-
Method create
object(GTK.ProgressBar) GTK.refdoc.GTK.ProgressBar()->create()
- Description
Create a new progress bar.
The default values are:
Min 0.0, max 1.0, current 0.0
-
Method get_fraction
float GTK.refdoc.GTK.ProgressBar()->get_fraction()
- Description
Returns the current fraction of the task that's been completed.
-
Method get_orientation
int GTK.refdoc.GTK.ProgressBar()->get_orientation()
- Description
Retrieves the current progress bar orientation.
-
Method get_pulse_step
float GTK.refdoc.GTK.ProgressBar()->get_pulse_step()
- Description
Retrieves the pulse step.
-
Method get_text
string GTK.refdoc.GTK.ProgressBar()->get_text()
- Description
Retrieves the text displayed superimposed on the progress bar, if any.
-
Method pulse
object(GTK.ProgressBar) GTK.refdoc.GTK.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_fraction
object(GTK.ProgressBar) GTK.refdoc.GTK.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
object(GTK.ProgressBar) GTK.refdoc.GTK.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
object(GTK.ProgressBar) GTK.refdoc.GTK.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
object(GTK.ProgressBar) GTK.refdoc.GTK.ProgressBar()->set_text(string text)
- Description
Causes the given text to appear superimposed on the progress bar.
|
| CLASS GTK.refdoc.GTK.TreeViewColumn |
Methods
add_attribute()
cell_get_position()
cell_get_size()
cell_is_visible()
cell_set_cell_data()
clear()
clear_attributes()
clicked()
create()
focus_cell()
get_alignment()
get_cell_renderers()
get_clickable()
get_expand()
get_fixed_width()
get_max_width()
get_min_width()
get_reorderable()
get_resizable()
get_sizing()
get_sort_column_id()
get_sort_indicator()
get_sort_order()
get_spacing()
get_title()
get_visible()
get_widget()
get_width()
pack_end()
pack_start()
set_alignment()
set_clickable()
set_expand()
set_fixed_width()
set_max_width()
set_min_width()
set_reorderable()
set_resizable()
set_sizing()
set_sort_column_id()
set_sort_indicator()
set_sort_order()
set_spacing()
set_title()
set_visible()
set_widget()
|
- 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
GTK.Widget widget
int width
Signals:
clicked
-
Inherit Data
GTK.Data
-
Method add_attribute
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->add_attribute(object(GTK.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 GTK.refdoc.GTK.TreeViewColumn()->cell_get_position(object(GTK.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 GTK.refdoc.GTK.TreeViewColumn()->cell_get_size(object(GDK.Rectangle) cell_area)
- Description
Obtains the width and height needed to render the column.
-
Method cell_is_visible
int GTK.refdoc.GTK.TreeViewColumn()->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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->cell_set_cell_data(object(GTK.TreeModel) model, object(GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->clear()
- Description
Unsets all the mappings on all renderers.
-
Method clear_attributes
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->clear_attributes(object(GTK.CellRenderer) cell_renderer)
- Description
Clears all existing attributes previously set.
-
Method clicked
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->clicked()
- Description
Emits the "clicked" signal on the column. This function will only work
if this column is clickable.
-
Method create
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->create(string title, object(GTK.CellRenderer) renderer, string property, int col)
- Description
Creates a new W(TreeViewColumn).
-
Method focus_cell
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->focus_cell(object(GTK.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 GTK.refdoc.GTK.TreeViewColumn()->get_alignment()
- Description
Returns the current x alignment. This value can range between 0.0 and 1.0.
-
Method get_cell_renderers
array GTK.refdoc.GTK.TreeViewColumn()->get_cell_renderers()
- Description
Returns an array of all the cell renderers in the column, in no partciular
order.
-
Method get_clickable
int GTK.refdoc.GTK.TreeViewColumn()->get_clickable()
- Description
Returns true if the user can click on the header for the column.
-
Method get_expand
int GTK.refdoc.GTK.TreeViewColumn()->get_expand()
- Description
Return true if the column expands to take any available space.
-
Method get_fixed_width
int GTK.refdoc.GTK.TreeViewColumn()->get_fixed_width()
- Description
Gets the fixed width of the column.
-
Method get_max_width
int GTK.refdoc.GTK.TreeViewColumn()->get_max_width()
- Description
Returns the maximum width in pixels, or -1 if no maximum width is set.
-
Method get_min_width
int GTK.refdoc.GTK.TreeViewColumn()->get_min_width()
- Description
Returns the minimum width in pixels, or -1 if no minimum width is set.
-
Method get_reorderable
int GTK.refdoc.GTK.TreeViewColumn()->get_reorderable()
- Description
Returns true if the column can be reordered by the user.
-
Method get_resizable
int GTK.refdoc.GTK.TreeViewColumn()->get_resizable()
- Description
Returns true if the column can be resized by the end user.
-
Method get_sizing
int GTK.refdoc.GTK.TreeViewColumn()->get_sizing()
- Description
Returns the current type.
-
Method get_sort_column_id
int GTK.refdoc.GTK.TreeViewColumn()->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 GTK.refdoc.GTK.TreeViewColumn()->get_sort_indicator()
- Description
Gets the value set by set_sort_indicator();
-
Method get_sort_order
int GTK.refdoc.GTK.TreeViewColumn()->get_sort_order()
- Description
Gets the value set by set_sort_order().
-
Method get_spacing
int GTK.refdoc.GTK.TreeViewColumn()->get_spacing()
- Description
Returns the spacing.
-
Method get_title
string GTK.refdoc.GTK.TreeViewColumn()->get_title()
- Description
Returns the title of the widget.
-
Method get_visible
int GTK.refdoc.GTK.TreeViewColumn()->get_visible()
- Description
Returns true if the column is visible.
-
Method get_widget
object(GTK.Widget) GTK.refdoc.GTK.TreeViewColumn()->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 GTK.refdoc.GTK.TreeViewColumn()->get_width()
- Description
Returns the current size in pixels.
-
Method pack_end
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->pack_end(object(GTK.CellRenderer) cell, int expand)
- Description
Packs the cell to the end of the column.
-
Method pack_start
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->pack_start(object(GTK.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 cels for which expand is true.
-
Method set_alignment
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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 GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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 GTK.TREE_VIEW_COLUMN_AUTOSIZE, then the
sizing mode is changed to GTK.TREE_VIEW_COLUMN_GROW_ONLY.
-
Method set_sizing
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.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
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->set_title(string title)
- Description
Sets the title. If a custom widget has been set, then this value is
ignored.
-
Method set_visible
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->set_visible(int visible)
- Description
Sets the visibility.
-
Method set_widget
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeViewColumn()->set_widget(object(GTK.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 GTK.refdoc.GTK.IconSource |
Methods
create()
get_direction()
get_direction_wildcarded()
get_filename()
get_icon_name()
get_pixbuf()
get_size()
get_size_wildcarded()
get_state()
get_state_wildcarded()
set_direction()
set_direction_wildcarded()
set_filename()
set_icon_name()
set_pixbuf()
set_size()
set_size_wildcarded()
set_state()
set_state_wildcarded()
|
- Description
Iconsource.
-
Method create
object(GTK.IconSource) GTK.refdoc.GTK.IconSource()->create()
- Description
Creates a new GTK.IconSource. A GTK.IconSource contains a GDK.Pixbuf (or
image filename) that serves as the base image for one or more of the icons
in a GTK.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. GTK.IconSet contains a list of GTK.IconSource from which it
can derive specific icon variants in the set.
In the simplest case, GTK.IconSet contains one source pixbuf from which it
derives all variants. The convenience function GTK.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 GTK.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 GTK.refdoc.GTK.IconSource()->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 GTK.refdoc.GTK.IconSource()->get_direction_wildcarded()
- Description
Gets the value set by set_direction_wildcarded().
-
Method get_filename
string GTK.refdoc.GTK.IconSource()->get_filename()
- Description
Retrieves the source filename, or empty.
-
Method get_icon_name
string GTK.refdoc.GTK.IconSource()->get_icon_name()
- Description
Retrieves the source icon name, or empty.
-
Method get_pixbuf
object(GDK.Pixbuf) GTK.refdoc.GTK.IconSource()->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 GTK.IconSource passed to the
GTK.Style->render_icon() virtual function.
-
Method get_size
int GTK.refdoc.GTK.IconSource()->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 GTK.refdoc.GTK.IconSource()->get_size_wildcarded()
- Description
Gets the value set by set_size_wildcarded().
-
Method get_state
int GTK.refdoc.GTK.IconSource()->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 GTK.refdoc.GTK.IconSource()->get_state_wildcarded()
- Description
Gets the value set by set_state_wildcarded().
-
Method set_direction
object(GTK.IconSource) GTK.refdoc.GTK.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
object(GTK.IconSource) GTK.refdoc.GTK.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.
GTK.IconSet prefers non-wildcarded sources (exact matches) over wildcarded
sources, and will use an exact match when possible.
-
Method set_filename
object(GTK.IconSource) GTK.refdoc.GTK.IconSource()->set_filename(string filename)
- Description
Sets the name of an image file to use as a base image when creating icon
variants for GTK.IconSet. The filename must be absolute.
-
Method set_icon_name
object(GTK.IconSource) GTK.refdoc.GTK.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
object(GTK.IconSource) GTK.refdoc.GTK.IconSource()->set_pixbuf(object(GDK.Pixbuf) pixbuf)
- Description
Sets a pixbuf to use as a base image.
-
Method set_size
object(GTK.IconSource) GTK.refdoc.GTK.IconSource()->set_size(int size)
- Description
Sets the icon size this icon source is intended to be with.
-
Method set_size_wildcarded
object(GTK.IconSource) GTK.refdoc.GTK.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
object(GTK.IconSource) GTK.refdoc.GTK.IconSource()->set_state(int state)
- Description
Sets the widget state this icon source is intended to be used with.
-
Method set_state_wildcarded
object(GTK.IconSource) GTK.refdoc.GTK.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 GTK.refdoc.GTK.CellRenderer |
Methods
activate()
get_fixed_size()
get_size()
render()
set_fixed_size()
start_editing()
|
- Description
Properties:
string cell-background
GDK.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
-
Inherit Data
GTK.Data
-
Method activate
int GTK.refdoc.GTK.CellRenderer()->activate(object(GDK.Event) event, object(GTK.Widget) widget, string path, object(GDK.Rectangle) background_area, object(GDK.Rectangle) 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 GTK.refdoc.GTK.CellRenderer()->get_fixed_size()
- Description
Fills in width and height with the appropriate size of the cell.
-
Method get_size
mapping GTK.refdoc.GTK.CellRenderer()->get_size(object(GTK.Widget) widget, object(GDK.Rectangle) 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
object(GTK.CellRenderer) GTK.refdoc.GTK.CellRenderer()->render(object(GDK.Window) window, object(GTK.Widget) widget, object(GDK.Rectangle) background_area, object(GDK.Rectangle) cell_area, object(GDK.Rectangle) 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_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
object(GTK.CellRenderer) GTK.refdoc.GTK.CellRenderer()->set_fixed_size(int width, int height)
- Description
Sets the renderer size to be explicit, independent of the properties set.
-
Method start_editing
object(GTK.CellRenderer) GTK.refdoc.GTK.CellRenderer()->start_editing(object(GDK.Event) event, object(GTK.Widget) widget, string path, object(GDK.Rectangle) background_area, object(GDK.Rectangle) cell_area, int flags)
- Description
Passes an activate event to the cell renderer for possible processing.
|
| CLASS GTK.refdoc.GTK.Arrow |
Methods
create()
set()
|
- Description
An arrow pointing in one of four directions. The 'etched' shadow
types does not work.
GTK.Arrow(GTK.ARROW_UP, GTK.SHADOW_OUT)
../images/gtk_arrow.png
GTK.Arrow(GTK.ARROW_LEFT, GTK.SHADOW_IN)
../images/gtk_arrow_2.png
GTK.Arrow(GTK.ARROW_RIGHT, GTK.SHADOW_IN)
../images/gtk_arrow_3.png
GTK.Arrow(GTK.ARROW_DOWN, GTK.SHADOW_OUT)
../images/gtk_arrow_4.png
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
GTK.Misc
-
Method create
object(GTK.Arrow) GTK.refdoc.GTK.Arrow()->create(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.
-
Method set
object(GTK.Arrow) GTK.refdoc.GTK.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 GTK.refdoc.GTK.Table |
Methods
attach()
attach_defaults()
create()
get_col_spacing()
get_default_col_spacing()
get_default_row_spacing()
get_homogeneous()
get_row_spacing()
resize()
set_col_spacing()
set_col_spacings()
set_homogeneous()
set_row_spacing()
set_row_spacings()
|
- Description
The Gtk.Table allow the programmer to arrange widgets in rows and
columns, making it easy to align many widgets next to each other,
horizontally and vertically.
GTK.Table(2,2,0)->attach_defaults( GTK.Label("0,0"), 0, 1, 0, 1)->attach_defaults( GTK.Label("0,1"), 0, 1, 1, 2)->attach_defaults( GTK.Label("1,0"), 1, 2, 0, 1)->attach_defaults( GTK.Label("1,1"), 1, 2, 1, 2)->set_col_spacings(10)->set_row_spacings(10)
../images/gtk_table.png
GTK.Table(2,2,0)->attach_defaults( GTK.Label("0,0-1,0"), 0, 2, 0, 1)->attach_defaults( GTK.Label("0,1"), 0, 1, 1, 2)->attach_defaults( GTK.Label("1,1"), 1, 2, 1, 2)->set_col_spacings(10)->set_row_spacings(10)
../images/gtk_table_2.png
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
GTK.Container
-
Method attach
object(GTK.Table) GTK.refdoc.GTK.Table()->attach(object(GTK.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> GTK.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> GTK.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> GTK.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
object(GTK.Table) GTK.refdoc.GTK.Table()->attach_defaults(object(GTK.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 GTK.Fill|GTK.Expand. For
the padding it is 0.
-
Method create
object(GTK.Table) GTK.refdoc.GTK.Table()->create(int width, int height, int 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 GTK.refdoc.GTK.Table()->get_col_spacing(int col)
- Description
Gets the amound of space between col and col+1.
-
Method get_default_col_spacing
int GTK.refdoc.GTK.Table()->get_default_col_spacing()
- Description
Gets the default column spacing for the table.
-
Method get_default_row_spacing
int GTK.refdoc.GTK.Table()->get_default_row_spacing()
- Description
Gets the default row spacing for the table.
-
Method get_homogeneous
int GTK.refdoc.GTK.Table()->get_homogeneous()
- Description
Returns whether the table cells are all constrained to the same
width and height.
-
Method get_row_spacing
int GTK.refdoc.GTK.Table()->get_row_spacing(int row)
- Description
Gets the amount of space between row and row+1.
-
Method resize
object(GTK.Table) GTK.refdoc.GTK.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
object(GTK.Table) GTK.refdoc.GTK.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
object(GTK.Table) GTK.refdoc.GTK.Table()->set_col_spacings(int spacing)
- Description
Sets the space between every column in the table equal to spacing.
-
Method set_homogeneous
object(GTK.Table) GTK.refdoc.GTK.Table()->set_homogeneous(int homogeneousp)
- Description
Set the homogeneous flag.
-
Method set_row_spacing
object(GTK.Table) GTK.refdoc.GTK.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
object(GTK.Table) GTK.refdoc.GTK.Table()->set_row_spacings(int spacing)
- Description
Sets the space between every row in the table equal to spacing.
|
| CLASS GTK.refdoc.GTK.Item |
Methods
deselect()
select()
toggle()
|
- Description
This class is inherited by all 'item' type of widgets.
Signals:
deselect
select
toggle
-
Inherit Bin
GTK.Bin
-
Method deselect
object(GTK.Item) GTK.refdoc.GTK.Item()->deselect()
- Description
Emulate a 'deselect' event.
-
Method select
object(GTK.Item) GTK.refdoc.GTK.Item()->select()
- Description
Emulate a 'select' event.
-
Method toggle
object(GTK.Item) GTK.refdoc.GTK.Item()->toggle()
- Description
Emulate a 'toggle' event.
|
| CLASS GTK.refdoc.GTK.HandleBox |
Methods
create()
get_handle_position()
get_shadow_type()
get_snap_edge()
set_handle_position()
set_shadow_type()
set_snap_edge()
|
- 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.
GTK.HandleBox()->add(GTK.Label("The contents"))
../images/gtk_handlebox.png
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
GTK.Bin
-
Method create
object(GTK.HandleBox) GTK.refdoc.GTK.HandleBox()->create()
- Description
Create a new handle box widget.
-
Method get_handle_position
int GTK.refdoc.GTK.HandleBox()->get_handle_position()
- Description
Get the handle position.
-
Method get_shadow_type
int GTK.refdoc.GTK.HandleBox()->get_shadow_type()
- Description
Get the shadow type.
-
Method get_snap_edge
int GTK.refdoc.GTK.HandleBox()->get_snap_edge()
- Description
Get the snap edge.
-
Method set_handle_position
object(GTK.HandleBox) GTK.refdoc.GTK.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
object(GTK.HandleBox) GTK.refdoc.GTK.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
object(GTK.HandleBox) GTK.refdoc.GTK.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 GTK.refdoc.GTK.Label |
Methods
create()
get_justify()
get_label()
get_layout()
get_layout_offsets()
get_line_wrap()
get_mnemonic_keyval()
get_mnemonic_widget()
get_selectable()
get_selection_bounds()
get_text()
get_use_markup()
get_use_underline()
select_region()
set_justify()
set_label()
set_line_wrap()
set_markup()
set_markup_with_mnemonic()
set_mnemonic_widget()
set_pattern()
set_selectable()
set_text()
set_text_with_mnemonic()
set_use_markup()
set_use_underline()
|
- Description
A simple text label.
GTK.Label("A simple text label")
../images/gtk_label.png
GTK.Label("Multi\nline text\nlabel here")
../images/gtk_label_2.png
GTK.Label("Multi\nline text\nlabel here")->set_justify(GTK.JUSTIFY_LEFT)
../images/gtk_label_3.png
GTK.Label("Multi\nline text\nlabel here")->set_justify(GTK.JUSTIFY_RIGHT)
../images/gtk_label_4.png
Properties:
float angle
Pango.AttrList attributes
int cursor-position
int ellipsize
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
GTK.Misc
-
Method create
object(GTK.Label) GTK.refdoc.GTK.Label()->create(string text)
- Description
Creates a new label.
-
Method get_justify
int GTK.refdoc.GTK.Label()->get_justify()
- Description
Returns the justification of the label.
-
Method get_label
string GTK.refdoc.GTK.Label()->get_label()
- Description
Fetches the text from a label widget including any underlines indicating
mnemonics and Pango markup.
-
Method get_layout
object(Pango.Layout) GTK.refdoc.GTK.Label()->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 GTK.refdoc.GTK.Label()->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 GTK.EventBox
to receive the events, and pack the label inside it, since labels are a
GTK.NO_WINDOW widget. Remember when using the Pango.Layout functions you
need to convert to and from pixels using GTK.PANGO_SCALE.
-
Method get_line_wrap
int GTK.refdoc.GTK.Label()->get_line_wrap()
- Description
Returns whether lines in the label are automatically wrapped.
-
Method get_mnemonic_keyval
int GTK.refdoc.GTK.Label()->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
object(GTK.Widget) GTK.refdoc.GTK.Label()->get_mnemonic_widget()
- Description
Retrieves the target of the mnemonic (keyboard shortcut).
-
Method get_selectable
int GTK.refdoc.GTK.Label()->get_selectable()
- Description
Gets the value set by set_selectable().
-
Method get_selection_bounds
mapping GTK.refdoc.GTK.Label()->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_text
string GTK.refdoc.GTK.Label()->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 GTK.refdoc.GTK.Label()->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 GTK.refdoc.GTK.Label()->get_use_underline()
- Description
Returns whether an embedded underline in the label indicates a mnemonic.
-
Method select_region
object(GTK.Label) GTK.refdoc.GTK.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_justify
object(GTK.Label) GTK.refdoc.GTK.Label()->set_justify(int jtype)
- Description
Sets the alignment of the lines in the text of the label relative to each
other. GTK.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
object(GTK.Label) GTK.refdoc.GTK.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
object(GTK.Label) GTK.refdoc.GTK.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_markup
object(GTK.Label) GTK.refdoc.GTK.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
object(GTK.Label) GTK.refdoc.GTK.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_mnemonic_widget
object(GTK.Label) GTK.refdoc.GTK.Label()->set_mnemonic_widget(object(GTK.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
GTK.Button or GTK.Notebook tab) it is automatically associated with the
correct widget, but sometimes (i.e. when the target is a GTK.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
object(GTK.Label) GTK.refdoc.GTK.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
object(GTK.Label) GTK.refdoc.GTK.Label()->set_selectable(int setting)
- Description
Selectable labels allow the user to select text from the label, for copy
and past.
-
Method set_text
object(GTK.Label) GTK.refdoc.GTK.Label()->set_text(string text)
- Description
Set the text in the label
-
Method set_text_with_mnemonic
object(GTK.Label) GTK.refdoc.GTK.Label()->set_text_with_mnemonic(string text)
- 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
object(GTK.Label) GTK.refdoc.GTK.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
object(GTK.Label) GTK.refdoc.GTK.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.
|
| CLASS GTK.refdoc.GTK.AccelGroup |
Methods
connect()
connect_by_path()
create()
disconnect()
lock()
unlock()
|
- Description
An AccelGroup stores keybindings.
A group is automatically created by W(MenuFactory)
NOIMG
Signals:
accel_activate
accel_changed
-
Inherit Object
G.Object
-
Method connect
object(GTK.AccelGroup) GTK.refdoc.GTK.AccelGroup()->connect(int accel_key, int accel_mods, int accel_flags, function cb, mixed user_data)
- Description
Installs an accelerator in this group.
-
Method connect_by_path
object(GTK.AccelGroup) GTK.refdoc.GTK.AccelGroup()->connect_by_path(string accel_path, function 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
object(GTK.AccelGroup) GTK.refdoc.GTK.AccelGroup()->create()
- Description
Create a new accelerator group
-
Method disconnect
object(GTK.AccelGroup) GTK.refdoc.GTK.AccelGroup()->disconnect(int accel_key, int accel_mods)
- Description
Removes an accelerator previously installed.
-
Method lock
object(GTK.AccelGroup) GTK.refdoc.GTK.AccelGroup()->lock()
- Description
Locks the group.
-
Method unlock
object(GTK.AccelGroup) GTK.refdoc.GTK.AccelGroup()->unlock()
- Description
Undoes the last call to lock().
|
| CLASS GTK.refdoc.GTK.TearoffMenuItem |
Methods
create()
|
- Description
A GTK.TearoffMenuItem is a special W(MenuItem) which is used to
tear off and reattach its menu.
When its menu is shown normally, the GTK.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 GTK.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.
GTK.TearoffMenuItem()->set_size_request(100,0)
../images/gtk_tearoffmenuitem.png
-
Inherit MenuItem
GTK.MenuItem
-
Method create
object(GTK.TearoffMenuItem) GTK.refdoc.GTK.TearoffMenuItem()->create()
- Description
Create a new tearoff menu item
|
| CLASS GTK.refdoc.GTK.Image |
Methods
create()
get_animation()
get_image()
get_pixbuf()
get_pixmap()
get_stock()
get_storage_type()
set_from_animation()
set_from_file()
set_from_pixbuf()
set_from_stock()
|
- 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 GDK.Image and GDK.Pixmap.
GTK.Image(GDK.Pixbuf()->set_from_file("tornado_nguyen_big.jpg"));
../images/gtk_image.png
Properties:
string file
string icon-name
icon-set
int icon-size
GDK.Image image
GDK.Pixmap mask
GDK.Pixbuf pixbuf
GDK.PixbufAnimation pixbuf-animation
int pixel-size
GDK.Pixmap pixmap
string stock
int storage-type IMAGE_ANIMATION, IMAGE_EMPTY, IMAGE_ICON_SET, IMAGE_IMAGE, IMAGE_PIXBUF, IMAGE_PIXMAP and IMAGE_STOCK
-
Inherit Misc
GTK.Misc
-
Method create
object(GTK.Image) GTK.refdoc.GTK.Image()->create(string|object(GdkPixbufAnimation)|object(GdkImage)|object(GdkPixmap)|void file, object(GDK.Bitmap) mask)
- Description
Create a new W(Image) from either a file or a GDK.Pixbuf.
-
Method get_animation
object(GDK.PixbufAnimation) GTK.refdoc.GTK.Image()->get_animation()
- Description
Gets the GDK.PixbufAnimation being displayed.
-
Method get_image
mapping GTK.refdoc.GTK.Image()->get_image()
- Description
Returns ([ "image":GDK.Image img, "mask":GDK.Bitmap mask ])
-
Method get_pixbuf
object(GDK.Pixbuf) GTK.refdoc.GTK.Image()->get_pixbuf()
- Description
Gets the GDK.Pixbuf being displayed. The storage type of the image must
be GTK.IMAGE_EMPTY or GTK.IMAGE_PIXBUF).
-
Method get_pixmap
mapping GTK.refdoc.GTK.Image()->get_pixmap()
- Description
Gets the pixmap and mask.
-
Method get_stock
mapping GTK.refdoc.GTK.Image()->get_stock()
- Description
Gets the stock icon name and size.
-
Method get_storage_type
int GTK.refdoc.GTK.Image()->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 GTK.IMAGE_EMPTY.
One of IMAGE_ANIMATION, IMAGE_EMPTY, IMAGE_ICON_SET, IMAGE_IMAGE, IMAGE_PIXBUF, IMAGE_PIXMAP and IMAGE_STOCK
-
Method set_from_animation
object(GTK.Image) GTK.refdoc.GTK.Image()->set_from_animation(object(GDK.PixbufAnimation) anim)
- Description
Causes the W(Image) to display the given animation.
-
Method set_from_file
object(GTK.Image) GTK.refdoc.GTK.Image()->set_from_file(string filename)
- Description
Set the image from a file.
-
Method set_from_pixbuf
object(GTK.Image) GTK.refdoc.GTK.Image()->set_from_pixbuf(object(GDK.Pixbuf) pixbuf)
- Description
Set image from a pixbuf
-
Method set_from_stock
object(GTK.Image) GTK.refdoc.GTK.Image()->set_from_stock(string stock_id, int size)
- Description
Sets from a stock icon. Sample icon names are GTK.STOCK_OPEN,
GTK.STOCK_EXIT. Sample stock sizes are GTK.ICON_SIZE_MENU,
GTK.ICON_SIZE_SMALL_TOOLBAR. If the stock name isn't known, the image
will be empty.
|
| CLASS GTK.refdoc.GTK.CheckButton |
Methods
create()
|
- 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.
GTK.Check_button( "title" )
../images/gtk_checkbutton.png
Style properties:
int indicator-size
int indicator-spacing
-
Inherit ToggleButton
GTK.ToggleButton
-
Method create
object(GTK.CheckButton) GTK.refdoc.GTK.CheckButton()->create(string|void label)
- 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 GTK.refdoc.GTK.FontSelection |
Methods
create()
get_font_name()
get_preview_text()
set_font_name()
set_preview_text()
|
- 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).
GTK.FontSelection();
../images/gtk_fontselection.png
Properties:
string font-name
string preview-text
-
Inherit Vbox
GTK.Vbox
-
Method create
object(GTK.FontSelection) GTK.refdoc.GTK.FontSelection()->create()
- Description
Create a new GTK.FontSelection widget.
-
Method get_font_name
string GTK.refdoc.GTK.FontSelection()->get_font_name()
- Description
Gets the currently-selected font name.
-
Method get_preview_text
string GTK.refdoc.GTK.FontSelection()->get_preview_text()
- Description
Gets the text displayed in the preview area.
-
Method set_font_name
object(GTK.FontSelection) GTK.refdoc.GTK.FontSelection()->set_font_name(string fontname)
- Description
This sets the currently displayed font.
-
Method set_preview_text
object(GTK.FontSelection) GTK.refdoc.GTK.FontSelection()->set_preview_text(string text)
- Description
Sets the text displayed in the preview area.
|
| CLASS GTK.refdoc.GTK.Box |
Methods
get_homogeneous()
get_spacing()
pack_end()
pack_end_defaults()
pack_start()
pack_start_defaults()
query_child_packing()
reorder_child()
set_child_packing()
set_homogeneous()
set_spacing()
|
- 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
GTK.Container
-
Method get_homogeneous
int GTK.refdoc.GTK.Box()->get_homogeneous()
- Description
Returns whether the box is homogeneous.
-
Method get_spacing
int GTK.refdoc.GTK.Box()->get_spacing()
- Description
Gets the spacing.
-
Method pack_end
object(GTK.Box) GTK.refdoc.GTK.Box()->pack_end(object(GTK.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
object(GTK.Box) GTK.refdoc.GTK.Box()->pack_end_defaults(object(GTK.Widget) widget)
- Description
The argument is the widget to add.
-
Method pack_start
object(GTK.Box) GTK.refdoc.GTK.Box()->pack_start(object(GTK.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
object(GTK.Box) GTK.refdoc.GTK.Box()->pack_start_defaults(object(GTK.Widget) widget)
- Description
The argument is the widget to add. This function is equivalent to 'add'
-
Method query_child_packing
mapping GTK.refdoc.GTK.Box()->query_child_packing(object(GTK.Widget) child)
- Description
Return a mapping:
([ "expand":expandp, "fill":fillp, "padding":paddingp, "type":type ])
-
Method reorder_child
object(GTK.Box) GTK.refdoc.GTK.Box()->reorder_child(object(GTK.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
object(GTK.Box) GTK.refdoc.GTK.Box()->set_child_packing(object(GTK.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_END and PACK_START.
You can emulate pack_start and pack_end with add and set_child_packing.
-
Method set_homogeneous
object(GTK.Box) GTK.refdoc.GTK.Box()->set_homogeneous(int homogeneousp)
- Description
If true, all widgets in the box will get exactly the same amount of space
-
Method set_spacing
object(GTK.Box) GTK.refdoc.GTK.Box()->set_spacing(int spacing)
- Description
This is the amount of spacing (in pixels) inserted beween all widgets
|
| CLASS GTK.refdoc.GTK.Statusbar |
Methods
create()
get_context_id()
get_has_resize_grip()
pop()
push()
remove()
set_has_resize_grip()
|
- 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 = GTK.Statusbar();int id = sb->get_context_id("test");sb->push(id,"A message");sb->push(id,"Another message");return sb;}()
../images/gtk_statusbar.png
lambda() {object sb = GTK.Statusbar();int id = sb->get_context_id("test");sb->push(id,"A message");sb->push(id,"Another message");sb->pop(id);return sb;}()
../images/gtk_statusbar_2.png
Properties:
int has-resize-grip
Style properties:
int shadow-type
Signals:
text_popped
text_pushed
-
Inherit Hbox
GTK.Hbox
-
Method create
object(GTK.Statusbar) GTK.refdoc.GTK.Statusbar()->create()
- Description
Create a new statusbar widget
-
Method get_context_id
int GTK.refdoc.GTK.Statusbar()->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 GTK.refdoc.GTK.Statusbar()->get_has_resize_grip()
- Description
Returns whether the statusbar has a resize grip.
-
Method pop
object(GTK.Statusbar) GTK.refdoc.GTK.Statusbar()->pop(int context)
- Description
Remove the topmost message.
-
Method push
int GTK.refdoc.GTK.Statusbar()->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
object(GTK.Statusbar) GTK.refdoc.GTK.Statusbar()->remove(int context, int id)
- Description
Remove the specified message (the message id is the second argument).
-
Method set_has_resize_grip
object(GTK.Statusbar) GTK.refdoc.GTK.Statusbar()->set_has_resize_grip(int setting)
- Description
Sets whether the statusbar has a resize grip. TRUE by default.
|
| CLASS GTK.refdoc.GTK.Vseparator |
Methods
create()
|
- Description
Simply creates a vertical separator. No bells or whistles.
GTK.Vseparator()->set_size_request(3,50)
../images/gtk_vseparator.png
-
Inherit Separator
GTK.Separator
-
Method create
object(GTK.Vseparator) GTK.refdoc.GTK.Vseparator()->create()
- Description
Used to create a new vseparator widget.
|
| CLASS GTK.refdoc.GTK.TextAttributes |
Methods
copy()
copy_values()
create()
destroy()
get_bg_full_height()
get_direction()
get_editable()
get_font_scale()
get_indent()
get_invisible()
get_justification()
get_left_margin()
get_pixels_above_lines()
get_pixels_below_lines()
get_pixels_inside_wrap()
get_realized()
get_right_margin()
get_tabs()
get_wrap_mode()
|
- Description
Holds text attributes.
-
Method copy
object(GTK.TextAttributes) GTK.refdoc.GTK.TextAttributes()->copy()
- Description
Copies src and returns it.
-
Method copy_values
object(GTK.TextAttributes) GTK.refdoc.GTK.TextAttributes()->copy_values(object(GTK.TextAttributes) dest)
- Description
Copies src onto dest
-
Method create
object(GTK.TextAttributes) GTK.refdoc.GTK.TextAttributes()->create()
- Description
Create a W(TextAttributes) widget.
-
Method destroy
object(GTK.TextAttributes) GTK.refdoc.GTK.TextAttributes()->destroy()
- Description
Destructor.
-
Method get_bg_full_height
int GTK.refdoc.GTK.TextAttributes()->get_bg_full_height()
- Description
Get bg_full_height.
-
Method get_direction
int GTK.refdoc.GTK.TextAttributes()->get_direction()
- Description
Get direction.
-
Method get_editable
int GTK.refdoc.GTK.TextAttributes()->get_editable()
- Description
Get editable.
-
Method get_font_scale
float GTK.refdoc.GTK.TextAttributes()->get_font_scale()
- Description
Get font scale.
-
Method get_indent
int GTK.refdoc.GTK.TextAttributes()->get_indent()
- Description
Get indent.
-
Method get_invisible
int GTK.refdoc.GTK.TextAttributes()->get_invisible()
- Description
Get invisible.
-
Method get_justification
int GTK.refdoc.GTK.TextAttributes()->get_justification()
- Description
Get justification.
-
Method get_left_margin
int GTK.refdoc.GTK.TextAttributes()->get_left_margin()
- Description
Get left margin.
-
Method get_pixels_above_lines
int GTK.refdoc.GTK.TextAttributes()->get_pixels_above_lines()
- Description
Get pixels above lines.
-
Method get_pixels_below_lines
int GTK.refdoc.GTK.TextAttributes()->get_pixels_below_lines()
- Description
Get pixels below lines.
-
Method get_pixels_inside_wrap
int GTK.refdoc.GTK.TextAttributes()->get_pixels_inside_wrap()
- Description
Get pixels inside wrap.
-
Method get_realized
int GTK.refdoc.GTK.TextAttributes()->get_realized()
- Description
Get realized.
-
Method get_right_margin
int GTK.refdoc.GTK.TextAttributes()->get_right_margin()
- Description
Get right margin.
-
Method get_tabs
object(Pango.TabArray) GTK.refdoc.GTK.TextAttributes()->get_tabs()
- Description
Get tabs.
-
Method get_wrap_mode
int GTK.refdoc.GTK.TextAttributes()->get_wrap_mode()
- Description
Get wrap mode.
|
| CLASS GTK.refdoc.GTK.Window |
Methods
activate_default()
activate_focus()
add_accel_group()
add_mnemonic()
create()
deiconify()
get_decorated()
get_default_size()
get_destroy_with_parent()
get_focus()
get_gravity()
get_icon()
get_icon_list()
get_mnemonic_modifier()
get_modal()
get_position()
get_resizable()
get_size()
get_title()
get_transient_for()
get_type_hint()
iconify()
lower()
maximize()
mnemonic_activate()
move()
parse_geometry()
present()
raise()
remove_accel_group()
remove_mnemonic()
reshow_with_initial_size()
resize()
set_decorated()
set_default()
set_default_size()
set_destroy_with_parent()
set_focus()
set_geometry_hints()
set_gravity()
set_icon()
set_mnemonic_modifier()
set_modal()
set_position()
set_resizable()
set_title()
set_transient_for()
set_type_hint()
set_wmclass()
stick()
unmaximize()
unstick()
|
- 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 destroy-with-parent
int focus-on-map
int has-toplevel-focus
GDK.Pixbuf icon
int is-active
int modal
int resizable
string role
GDK.Screen screen
int skip-pager-hint
int skip-taskbar-hint
string title
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 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
GTK.Bin
-
Method activate_default
int GTK.refdoc.GTK.Window()->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 GTK.refdoc.GTK.Window()->activate_focus()
- Description
Activates the current focused widget.
-
Method add_accel_group
object(GTK.Window) GTK.refdoc.GTK.Window()->add_accel_group(object(GTK.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
object(GTK.Window) GTK.refdoc.GTK.Window()->add_mnemonic(int keyval, object(GTK.Widget) target)
- Description
Adds a mnemonic to this window.
-
Method create
object(GTK.Window) GTK.refdoc.GTK.Window()->create(int window_type)
- Description
Argument is one of WINDOW_POPUP and WINDOW_TOPLEVEL
-
Method deiconify
object(GTK.Window) GTK.refdoc.GTK.Window()->deiconify()
- Description
Opposite of iconify().
-
Method get_decorated
int GTK.refdoc.GTK.Window()->get_decorated()
- Description
Returns whether the window has been set to have decorations such as a title
bar.
-
Method get_default_size
mapping GTK.refdoc.GTK.Window()->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_destroy_with_parent
int GTK.refdoc.GTK.Window()->get_destroy_with_parent()
- Description
Returns whether the window will be destroyed with its transient parent.
-
Method get_focus
object(GTK.Widget) GTK.refdoc.GTK.Window()->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_gravity
object(GTK.Window) GTK.refdoc.GTK.Window()->get_gravity()
- Description
Gets the value set by set_gravity().
-
Method get_icon
object(GDK.Pixbuf) GTK.refdoc.GTK.Window()->get_icon()
- Description
Gets the value set by set_icon().
-
Method get_icon_list
array GTK.refdoc.GTK.Window()->get_icon_list()
- Description
Retrieves the list of icons set by set_icon_list().
-
Method get_mnemonic_modifier
int GTK.refdoc.GTK.Window()->get_mnemonic_modifier()
- Description
Returns the mnemonic modifier for this window.
-
Method get_modal
int GTK.refdoc.GTK.Window()->get_modal()
- Description
Returns whether the window is modal.
-
Method get_position
mapping GTK.refdoc.GTK.Window()->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
GDK.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 GDK.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
object(GTK.Window) GTK.refdoc.GTK.Window()->get_resizable()
- Description
Gets the whether this window is resizable.
-
Method get_size
mapping GTK.refdoc.GTK.Window()->get_size()
- Description
Obtains the current size of window.
-
Method get_title
string GTK.refdoc.GTK.Window()->get_title()
- Description
Retrieves the title of the window.
-
Method get_transient_for
object(GTK.Window) GTK.refdoc.GTK.Window()->get_transient_for()
- Description
Fetches the transient parent for this window.
-
Method get_type_hint
int GTK.refdoc.GTK.Window()->get_type_hint()
- Description
Gets the type hint.
-
Method iconify
object(GTK.Window) GTK.refdoc.GTK.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 lower
object(GTK.Window) GTK.refdoc.GTK.Window()->lower()
- Description
Lower this window if the window manager allows that.
-
Method maximize
object(GTK.Window) GTK.refdoc.GTK.Window()->maximize()
- Description
Maximize a window. Same caveats as iconify().
-
Method mnemonic_activate
int GTK.refdoc.GTK.Window()->mnemonic_activate(int keyval, int modifier)
- Description
Activates the targets associated with the mnemonic. modifier is one of
GDK.SHIFT_MASK, GDK.LOCK_MASK, GDK.CONTROL_MASK, GDK.MOD1_MASK,
GDK.MOD2_MASK, GDK.MOD3_MASK, GDK.MOD4_MASK, GDK.MOD5_MASK,
GDK.BUTTON1_MASK, GDK.BUTTON2_MASK, GDK.BUTTON3_MASK, GDK.BUTTON4_MASK
GDK.BUTTON5_MASK, GDK.RELEASE_MASK, GDK.MODIFIER_MASK
-
Method move
object(GTK.Window) GTK.refdoc.GTK.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 GDK.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 GDK.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 GDK.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 GTK.refdoc.GTK.Window()->parse_geometry(string geometry)
- Description
Parses a standard X geometry string.
-
Method present
object(GTK.Window) GTK.refdoc.GTK.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 raise
object(GTK.Window) GTK.refdoc.GTK.Window()->raise()
- Description
Raise this window if the window manager allows that.
-
Method remove_accel_group
object(GTK.Window) GTK.refdoc.GTK.Window()->remove_accel_group(object(GTK.AccelGroup) group)
- Description
Reverses the effects of add_accel_group().
-
Method remove_mnemonic
object(GTK.Window) GTK.refdoc.GTK.Window()->remove_mnemonic(int keyval, object(GTK.Widget) target)
- Description
Removes a mnemonic from this window.
-
Method reshow_with_initial_size
object(GTK.Window) GTK.refdoc.GTK.Window()->reshow_with_initial_size()
- Description
Hides the window, then reshows it, resetting the default size and position
of the window.
-
Method resize
object(GTK.Window) GTK.refdoc.GTK.Window()->resize(int width, int height)
- Description
Resizes the window as if the user had done so, obeying geometry
constraints.
-
Method set_decorated
object(GTK.Window) GTK.refdoc.GTK.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
object(GTK.Window) GTK.refdoc.GTK.Window()->set_default(object(GTK.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 GTK.Widget->grab_focus() on the widget.
-
Method set_default_size
object(GTK.Window) GTK.refdoc.GTK.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_destroy_with_parent
object(GTK.Window) GTK.refdoc.GTK.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
object(GTK.Window) GTK.refdoc.GTK.Window()->set_focus(object(GTK.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 GTK.Widget->grab_focus() instead of this
function.
-
Method set_geometry_hints
object(GTK.Window) GTK.refdoc.GTK.Window()->set_geometry_hints(object(GTK.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
object(GTK.Window) GTK.refdoc.GTK.Window()->set_gravity(int gravity)
- Description
Window gravity defines the meaning of coordinates passed to move().
The default window gravity is GDK.GRAVITY_NORTH_WEST, which will typically
"do what you mean."
-
Method set_icon
object(GTK.Window) GTK.refdoc.GTK.Window()->set_icon(object(GDK.Pixbuf) 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_mnemonic_modifier
object(GTK.Window) GTK.refdoc.GTK.Window()->set_mnemonic_modifier(int modifier)
- Description
Sets the mnemonic modifer for this window.
-
Method set_modal
object(GTK.Window) GTK.refdoc.GTK.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_position
object(GTK.Window) GTK.refdoc.GTK.Window()->set_position(int pos)
- Description
Sets a position contraint for this window. If the old or new constraint
is GTK.WIN_POS_CENTER_ALWAYS, this will also cause the window to be
repositioned to satisfy the new constraint.
-
Method set_resizable
object(GTK.Window) GTK.refdoc.GTK.Window()->set_resizable(int setting)
- Description
Sets whether the user can resize a window. Windows are user resizable by
default.
-
Method set_title
object(GTK.Window) GTK.refdoc.GTK.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
object(GTK.Window) GTK.refdoc.GTK.Window()->set_transient_for(object(GTK.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
object(GTK.Window) GTK.refdoc.GTK.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_wmclass
object(GTK.Window) GTK.refdoc.GTK.Window()->set_wmclass(string name, string class)
- Description
Set the window manager application name and class.
-
Method stick
object(GTK.Window) GTK.refdoc.GTK.Window()->stick()
- Description
Makes this window sticky. Same caveats as iconify().
-
Method unmaximize
object(GTK.Window) GTK.refdoc.GTK.Window()->unmaximize()
- Description
Opposite of maximize().
-
Method unstick
object(GTK.Window) GTK.refdoc.GTK.Window()->unstick()
- Description
Opposite of stick().
|
| CLASS GTK.refdoc.GTK.FileSelection |
Methods
complete()
create()
get_action_area()
get_button_area()
get_cancel_button()
get_filename()
get_fileop_c_dir()
get_fileop_del_file()
get_fileop_dialog()
get_fileop_ren_file()
get_help_button()
get_main_vbox()
get_ok_button()
get_select_multiple()
get_selection()
hide_fileop_buttons()
set_filename()
set_select_multiple()
show_fileop_buttons()
|
- Description
GtkFileSelection should be used to retrieve file or directory names
from the user. It will create a new dialog window containing a
directory list, and a file list corresponding to the current
working directory. The filesystem can be navigated using the
directory list, the drop-down history menu, or the TAB key can be
used to navigate using filename completion common in text based
editors such as emacs and jed.
The default filename can be set using set_filename() and the
selected filename retrieved using get_filename().
Use complete() to display files that match a given pattern. This
can be used for example, to show only *.txt files, or only files
beginning with gtk*.
Simple file operations; create directory, delete file, and rename
file, are available from buttons at the top of the dialog. These
can be hidden using hide_fileop_buttons() and shown again using
show_fileop_buttons().
GTK.FileSelection("File selector")
../images/gtk_fileselection.png
Properties:
string filename
int select-multiple
int show-fileops
-
Inherit Dialog
GTK.Dialog
-
Method complete
object(GTK.FileSelection) GTK.refdoc.GTK.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
object(GTK.FileSelection) GTK.refdoc.GTK.FileSelection()->create(string window_title)
- 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
object(GTK.Vbox) GTK.refdoc.GTK.FileSelection()->get_action_area()
- Description
The action area
-
Method get_button_area
object(GTK.HbuttonBox) GTK.refdoc.GTK.FileSelection()->get_button_area()
- Description
The button area
-
Method get_cancel_button
object(GTK.Button) GTK.refdoc.GTK.FileSelection()->get_cancel_button()
- Description
The cancel button
-
Method get_filename
string GTK.refdoc.GTK.FileSelection()->get_filename()
- Description
Return the filename.
-
Method get_fileop_c_dir
object(GTK.Button) GTK.refdoc.GTK.FileSelection()->get_fileop_c_dir()
- Description
The create directory button in the file operation button group
-
Method get_fileop_del_file
object(GTK.Button) GTK.refdoc.GTK.FileSelection()->get_fileop_del_file()
- Description
The delete file button in the file operation button group
-
Method get_fileop_dialog
object(GTK.Dialog) GTK.refdoc.GTK.FileSelection()->get_fileop_dialog()
- Description
Dialog box for GTK.FileSelection
-
Method get_fileop_ren_file
object(GTK.Button) GTK.refdoc.GTK.FileSelection()->get_fileop_ren_file()
- Description
The rename file button in the file operation button group
-
Method get_help_button
object(GTK.Button) GTK.refdoc.GTK.FileSelection()->get_help_button()
- Description
The help button
-
Method get_main_vbox
object(GTK.Vbox) GTK.refdoc.GTK.FileSelection()->get_main_vbox()
- Description
The main vbox
-
Method get_ok_button
object(GTK.Button) GTK.refdoc.GTK.FileSelection()->get_ok_button()
- Description
The ok button
-
Method get_select_multiple
int GTK.refdoc.GTK.FileSelection()->get_select_multiple()
- Description
Gets whether the user is allowed to select multiple files.
-
Method get_selection
array GTK.refdoc.GTK.FileSelection()->get_selection()
- Description
Retrieves the list of selections the user has made.
-
Method hide_fileop_buttons
object(GTK.FileSelection) GTK.refdoc.GTK.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 GTK.FileSelection.
-
Method set_filename
object(GTK.FileSelection) GTK.refdoc.GTK.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
object(GTK.FileSelection) GTK.refdoc.GTK.FileSelection()->set_select_multiple(int select_multiple)
- Description
Sets whether the user is allowed to select multiple files.
-
Method show_fileop_buttons
object(GTK.FileSelection) GTK.refdoc.GTK.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 GTK.refdoc.GTK.Hscrollbar |
Methods
create()
|
- Description
A horizontal scrollbar.
General documentation: See W(Scrollbar)
GTK.Hscrollbar(GTK.Adjustment())->set_size_request(300,15)
../images/gtk_hscrollbar.png
-
Inherit Scrollbar
GTK.Scrollbar
-
Method create
object(GTK.Hscrollbar) GTK.refdoc.GTK.Hscrollbar()->create(object(GTK.Adjustment) adjustment)
- Description
Used to create a new vscale widget.
|
| CLASS GTK.refdoc.GTK.SeparatorMenuItem |
Methods
create()
|
- Description
A separator menu item.
-
Inherit MenuItem
GTK.MenuItem
-
Method create
object(GTK.SeparatorMenuItem) GTK.refdoc.GTK.SeparatorMenuItem()->create()
- Description
Create a new GTK.SeparatorMenuItem.
|
| CLASS GTK.refdoc.GTK.Invisible |
Methods
create()
|
- Description
An invisible container, useful, eh? :)
Properties:
GDK.Screen screen
-
Inherit Widget
GTK.Widget
-
Method create
object(GTK.Invisible) GTK.refdoc.GTK.Invisible()->create()
- Description
Create a new invisible widget
|
| CLASS GTK.refdoc.GTK.Entry |
Methods
copy_clipboard()
create()
cut_clipboard()
delete_selection()
delete_text()
editing_done()
get_activates_default()
get_alignment()
get_chars()
get_editable()
get_has_frame()
get_invisible_char()
get_max_length()
get_position()
get_selection_bounds()
get_text()
get_visibility()
get_width_chars()
insert_text()
paste_clipboard()
remove_widget()
select_region()
set_activates_default()
set_alignment()
set_editable()
set_has_frame()
set_invisible_char()
set_max_length()
set_position()
set_text()
set_visibility()
set_width_chars()
start_editing()
|
- Description
Use this widget when you want the user to input a single line of text.
GTK.Entry()->set_text("Hello world")->set_editable(1)
../images/gtk_entry.png
Properties:
int activates-default
int cursor-position
int editable
int has-frame
int invisible-char
int max-length
int scroll-offset
int selection-bound
string text
int visibility
int width-chars
float xalign
Signals:
activate
backspace
changed
copy_clipboard
cut_clipboard
delete_from_cursor
delete_text
editing_done
insert_at_cursor
insert_text
move_cursor
paste_clipboard
populate_popup
remove_widget
toggle_overwrite
-
Inherit Widget
GTK.Widget
-
Method copy_clipboard
object(GTK.Entry) GTK.refdoc.GTK.Entry()->copy_clipboard()
- Description
Causes the characters in the current selection to be copied to the
clipboard.
-
Method create
object(GTK.Entry) GTK.refdoc.GTK.Entry()->create()
- Description
Create a new W(Entry) widget.
-
Method cut_clipboard
object(GTK.Entry) GTK.refdoc.GTK.Entry()->cut_clipboard()
- Description
Causes the characters in the current selection to be copied to the
clipboard and then deleted.
-
Method delete_selection
object(GTK.Entry) GTK.refdoc.GTK.Entry()->delete_selection()
- Description
Deletes the current contents of the selection.
-
Method delete_text
object(GTK.Entry) GTK.refdoc.GTK.Entry()->delete_text(int start, int end)
- Description
Deletes a sequence of characters.
-
Method editing_done
object(GTK.Entry) GTK.refdoc.GTK.Entry()->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 get_activates_default
int GTK.refdoc.GTK.Entry()->get_activates_default()
- Description
Retrieves the value set by set_activates_default().
-
Method get_alignment
float GTK.refdoc.GTK.Entry()->get_alignment()
- Description
Gets the value set by set_alignment().
-
Method get_chars
string GTK.refdoc.GTK.Entry()->get_chars(int start, int end)
- Description
Retrieves a sequence of characters.
-
Method get_editable
int GTK.refdoc.GTK.Entry()->get_editable()
- Description
Retrieves whether this widget is editable.
-
Method get_has_frame
int GTK.refdoc.GTK.Entry()->get_has_frame()
- Description
Gets the value set by set_has_frame().
-
Method get_invisible_char
int GTK.refdoc.GTK.Entry()->get_invisible_char()
- Description
Retrieves the character displayed in place of the real characters for
entries with visibility set to false.
-
Method get_max_length
int GTK.refdoc.GTK.Entry()->get_max_length()
- Description
Retrieves the maximum allowed length of the text.
-
Method get_position
int GTK.refdoc.GTK.Entry()->get_position()
- Description
Retrieves the current cursor position.
-
Method get_selection_bounds
array GTK.refdoc.GTK.Entry()->get_selection_bounds()
- Description
Returns the selection bounds.
-
Method get_text
string GTK.refdoc.GTK.Entry()->get_text()
- Description
Returns the contents of the entry widget.
-
Method get_visibility
int GTK.refdoc.GTK.Entry()->get_visibility()
- Description
Retrieves whether the text is visible.
-
Method get_width_chars
int GTK.refdoc.GTK.Entry()->get_width_chars()
- Description
Gets the value set by set_width_chars().
-
Method insert_text
int GTK.refdoc.GTK.Entry()->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
object(GTK.Entry) GTK.refdoc.GTK.Entry()->paste_clipboard()
- Description
Causes the contents of the clipboard to be pasted into the given widget at
the current cursor position.
-
Method remove_widget
object(GTK.Entry) GTK.refdoc.GTK.Entry()->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 select_region
object(GTK.Entry) GTK.refdoc.GTK.Entry()->select_region(int start, int end)
- Description
Selects a region of text.
-
Method set_activates_default
object(GTK.Entry) GTK.refdoc.GTK.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
object(GTK.Entry) GTK.refdoc.GTK.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_editable
object(GTK.Entry) GTK.refdoc.GTK.Entry()->set_editable(int setting)
- Description
Determines if the user can edit the text or not.
-
Method set_has_frame
object(GTK.Entry) GTK.refdoc.GTK.Entry()->set_has_frame(int setting)
- Description
Sets whether the entry has a beveled frame around it.
-
Method set_invisible_char
object(GTK.Entry) GTK.refdoc.GTK.Entry()->set_invisible_char(int ch)
- Description
Sets the character to use in place of the actual text when
set_invisibility() 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
object(GTK.Entry) GTK.refdoc.GTK.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_position
object(GTK.Entry) GTK.refdoc.GTK.Entry()->set_position(int pos)
- Description
Sets the cursor position.
-
Method set_text
object(GTK.Entry) GTK.refdoc.GTK.Entry()->set_text(string text)
- Description
Set the text to the specified string, replacing the current contents.
-
Method set_visibility
object(GTK.Entry) GTK.refdoc.GTK.Entry()->set_visibility(int visiblep)
- Description
0 indicates invisible text (password boxes, as an example)
-
Method set_width_chars
object(GTK.Entry) GTK.refdoc.GTK.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 start_editing
object(GTK.Entry) GTK.refdoc.GTK.Entry()->start_editing(object(GDK.Event) event)
- Description
Begins editing. event is the GDK.Event that began the editing process.
It may be empty, in the instance that editing was initiated through
programmatic means.
|
| CLASS GTK.refdoc.GTK.IconSize |
Methods
from_name()
get_name()
register()
register_alias()
|
- Description
Iconsize.
-
Method from_name
int GTK.refdoc.GTK.IconSize()->from_name(string name)
- Description
Looks up the icon size associated with name.
-
Method get_name
string GTK.refdoc.GTK.IconSize()->get_name(int size)
- Description
Gets the canonical name of the given icon size.
-
Method register
int GTK.refdoc.GTK.IconSize()->register(string name, int width, int height)
- Description
Registers a new icon size, along the same lines as GTK.ICON_SIZE_MENU, etc.
Returns the integer value for the size.
-
Method register_alias
object(GTK.IconSize) GTK.refdoc.GTK.IconSize()->register_alias(string alias, int target)
- Description
Registers alias as another name for target. So calling
GTK.IconSize->from_name() with alias will return target.
|
| CLASS GTK.refdoc.GTK.MenuItem |
Methods
activate()
create()
deselect()
get_right_justified()
get_submenu()
remove_submenu()
select()
set_accel_path()
set_right_justified()
set_submenu()
toggle_size_allocate()
toggle_size_request()
|
- Description
Menu items, to be added to menues.
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 Item
GTK.Item
-
Method activate
object(GTK.MenuItem) GTK.refdoc.GTK.MenuItem()->activate()
- Description
Emulate an activate signal
-
Method create
object(GTK.MenuItem) GTK.refdoc.GTK.MenuItem()->create(string|void label)
- 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
object(GTK.MenuItem) GTK.refdoc.GTK.MenuItem()->deselect()
- Description
Emulate a deselect signal
-
Method get_right_justified
int GTK.refdoc.GTK.MenuItem()->get_right_justified()
- Description
Gets whether the menu item appears justified at the right side of the menu
bar.
-
Method get_submenu
object(GTK.Widget) GTK.refdoc.GTK.MenuItem()->get_submenu()
- Description
Gets the submenu underneath this menu item.
-
Method remove_submenu
object(GTK.MenuItem) GTK.refdoc.GTK.MenuItem()->remove_submenu()
- Description
Remove the submenu for this menu button.
-
Method select
object(GTK.MenuItem) GTK.refdoc.GTK.MenuItem()->select()
- Description
Emulate a select signal
-
Method set_accel_path
object(GTK.MenuItem) GTK.refdoc.GTK.MenuItem()->set_accel_path(string path)
- Description
Sets the accelerator path.
-
Method set_right_justified
object(GTK.MenuItem) GTK.refdoc.GTK.MenuItem()->set_right_justified(int setting)
- Description
Make the menu item stick to the right edge of it's container.
-
Method set_submenu
object(GTK.MenuItem) GTK.refdoc.GTK.MenuItem()->set_submenu(object(GTK.Widget) menu)
- Description
Set the submenu for this menu button.
-
Method toggle_size_allocate
object(GTK.MenuItem) GTK.refdoc.GTK.MenuItem()->toggle_size_allocate(int allocation)
- Description
Emits the "toggle_size_allocate" signal on the given item.
-
Method toggle_size_request
int GTK.refdoc.GTK.MenuItem()->toggle_size_request(int requisition)
- Description
Emits the "toggle-size-request" signal on the given item.
|
| CLASS GTK.refdoc.GTK.DrawingArea |
Methods
clear()
copy_area()
create()
draw_arc()
draw_bitmap()
draw_image()
draw_line()
draw_pixmap()
draw_point()
draw_rectangle()
draw_text()
|
- 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.
GTK.DrawingArea()->set_usize(100,100)
../images/gtk_drawingarea.png
-
Inherit Widget
GTK.Widget
-
Method clear
object(GTK.DrawingArea) GTK.refdoc.GTK.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
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->copy_area(object(GDK.GC) gc, int xdest, int ydest, object(GTK.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
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->create()
- Description
Create a new drawing area.
-
Method draw_arc
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->draw_arc(object(GDK.GC) 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
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->draw_bitmap(object(GDK.GC) gc, object(GDK.Bitmap) bitmap, int xsrc, int ysrc, int xdest, int ydest, int width, int height)
- Description
Draw a GDK(Bitmap) in this drawable.
NOTE: This drawable must be a bitmap as well. This will be
fixed in GTK 1.3
-
Method draw_image
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->draw_image(object(GDK.GC) gc, object(GDK.Image) 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
GDK(Image) at xdest,ydest in the destination drawable
-
Method draw_line
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->draw_line(object(GDK.GC) gc, int x1, int y1, int x2, int y2)
- Description
img_begin
w = GTK.DrawingArea()->set_usize(100,100);
delay: g = GDK.GC(w)->set_foreground( GDK.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_pixmap
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->draw_pixmap(object(GDK.GC) gc, object(GDK.Pixmap) 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
GDK(Pixmap) at xdest,ydest in the destination drawable
-
Method draw_point
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->draw_point(object(GDK.GC) gc, int x, int y)
- Description
img_begin
w = GTK.DrawingArea()->set_usize(10,10);
delay: g = GDK.GC(w)->set_foreground( GDK.Color(255,0,0) );
delay: for(int x = 0; x<10; x++) w->draw_point(g, x, x);
img_end
-
Method draw_rectangle
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->draw_rectangle(object(GDK.GC) gc, int filledp, int x1, int y1, int x2, int y2)
- Description
img_begin
w = GTK.DrawingArea()->set_usize(100,100);
delay: g = GDK.GC(w)->set_foreground( GDK.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 = GTK.DrawingArea()->set_usize(100,100);
delay: g = GDK.GC(w);
delay: for(int x = 0; x<30; x++) {
delay: g->set_foreground(GDK.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
object(GTK.DrawingArea) GTK.refdoc.GTK.DrawingArea()->draw_text(object(GDK.GC) gc, int x, int y, string text)
- Description
y is used as the baseline for the text.
|
| CLASS GTK.refdoc.GTK.RadioMenuItem |
Methods
create()
get_group()
set_group()
|
- Description
Exactly like W(RadioButton), but it is an menu item.
GTK.RadioMenuItem("Menu item")
../images/gtk_radiomenuitem.png
Signals:
group_changed
-
Inherit CheckMenuItem
GTK.CheckMenuItem
-
Method create
object(GTK.RadioMenuItem) GTK.refdoc.GTK.RadioMenuItem()->create(string|void title, object(GTK.RadioMenuItem) groupmember)
- Description
object GTK.RadioMenuItem(string title) - First button (with label)
object GTK.RadioMenuItem()->add(widget) - First button (with widget)
object GTK.RadioMenuItem(title, another_radio_button) - Second to n:th button (with title)
object GTK.RadioMenuItem(0,another_radio_button)->add(widget) - Second to n:th button (with widget)
-
Method get_group
array GTK.refdoc.GTK.RadioMenuItem()->get_group()
- Description
Returns the group to which the radio menu item belongs.
-
Method set_group
object(GTK.RadioMenuItem) GTK.refdoc.GTK.RadioMenuItem()->set_group(object(GTK.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 GTK.refdoc.GTK.SizeGroup |
Methods
add_widget()
create()
get_mode()
remove_widget()
set_mode()
|
- 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 GTK.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
GTK.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
GTK.FILL flag.
GTK.SizeGroup objects are referenced by each widget in the size group, so
one you have added all widgets to a GTK.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
allow idgets 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
GTK.SIZE_GROUP_HORIZONTAL or GTK.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 GTK.SIZE_GROUP_VERTICAL or
GTK.SIZE_GROUP_BOTH.
Properties:
int mode
The directions in which the size group effects the requested sizes of
its componenent widgets.
-
Inherit Object
G.Object
-
Method add_widget
object(GTK.SizeGroup) GTK.refdoc.GTK.SizeGroup()->add_widget(object(GTK.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
object(GTK.SizeGroup) GTK.refdoc.GTK.SizeGroup()->create(int mode)
- Description
Create a new group.
-
Method get_mode
int GTK.refdoc.GTK.SizeGroup()->get_mode()
- Description
Gets the current mode.
-
Method remove_widget
object(GTK.SizeGroup) GTK.refdoc.GTK.SizeGroup()->remove_widget(object(GTK.Widget) widget)
- Description
Removes a widget.
-
Method set_mode
object(GTK.SizeGroup) GTK.refdoc.GTK.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 GTK.refdoc.GTK.Hpaned |
Methods
create()
|
- 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.
GTK.Hpaned()->add1(GTK.Label("Left\nSide\nOf\nPane"))->add2(GTK.Label("Right\nSide\nOf\nPane"))->set_size_request(100,100)
../images/gtk_hpaned.png
-
Inherit Paned
GTK.Paned
-
Method create
object(GTK.Hpaned) GTK.refdoc.GTK.Hpaned()->create()
- Description
Create a new W(Hpaned) widget.
|
| CLASS GTK.refdoc.GTK.IconFactory |
Methods
add()
add_default()
create()
lookup()
lookup_default()
remove_default()
|
- Description
Icon factory, for holding icon sets.
-
Inherit Object
G.Object
-
Method add
object(GTK.IconFactory) GTK.refdoc.GTK.IconFactory()->add(string stock_id, object(GTK.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 GTK.IconFactory,
then add it to the list of default factories with add_default(). Then they
pass the stock_id to widgets such as GTK.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
object(GTK.IconFactory) GTK.refdoc.GTK.IconFactory()->add_default()
- Description
Adds an icon factory to the list of icon factories search by
GTK.Style->lookup_icon_set(). This means that, for example,
GTK.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
object(GTK.IconFactory) GTK.refdoc.GTK.IconFactory()->create()
- Description
Creates a new GTK.IconFactory. An icon factory manages a collection of
GTK.IconSets; a GTK.IconSet manages a set of variants of a particular icon
(i.e. a GTK.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 GTK.Style has a list of
GTK.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, GTK+ 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
object(GTK.IconSet) GTK.refdoc.GTK.IconFactory()->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
GTK.Style->lookup_icon_set() on the GTK.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
object(GTK.IconSet) GTK.refdoc.GTK.IconFactory()->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 GTK.Style->lookup_icon_set() on the GTK.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
object(GTK.IconFactory) GTK.refdoc.GTK.IconFactory()->remove_default()
- Description
Removes an icon factory from the list of default icon factories.
|
| CLASS GTK.refdoc.GTK.Separator |
|
- Description
A generic separator. Basicaly a line, like <hr> in HTML.
-
Inherit Widget
GTK.Widget
|
| CLASS GTK.refdoc.GTK.ColorSelectionDialog |
Methods
create()
get_cancel_button()
get_colorsel()
get_help_button()
get_ok_button()
|
- Description
Color Selection Dialog
-
Inherit Dialog
GTK.Dialog
-
Method create
object(GTK.ColorSelectionDialog) GTK.refdoc.GTK.ColorSelectionDialog()->create(string title)
- Description
Create a new Color Selection Dialog
-
Method get_cancel_button
object(GTK.Widget) GTK.refdoc.GTK.ColorSelectionDialog()->get_cancel_button()
- Description
The Cancel button.
-
Method get_colorsel
object(GTK.Widget) GTK.refdoc.GTK.ColorSelectionDialog()->get_colorsel()
- Description
The Color Selection widget contained within the dialog
-
Method get_help_button
object(GTK.Widget) GTK.refdoc.GTK.ColorSelectionDialog()->get_help_button()
- Description
The Help button.
-
Method get_ok_button
object(GTK.Widget) GTK.refdoc.GTK.ColorSelectionDialog()->get_ok_button()
- Description
The OK button.
|
| CLASS GTK.refdoc.GTK.Frame |
Methods
create()
get_label()
get_label_align()
get_label_widget()
get_shadow_type()
set_label()
set_label_align()
set_label_widget()
set_shadow_type()
|
- 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.
GTK.Frame("Title")->add(GTK.Label("Contents"))
../images/gtk_frame.png
GTK.Frame()->add(GTK.Label("Contents"))
../images/gtk_frame_2.png
GTK.Frame()->add(GTK.Label("Contents"))->set_shadow_type(GTK.SHADOW_IN)
../images/gtk_frame_3.png
Properties:
string label
GTK.Widget label-widget
float label-xalign
float label-yalign
int shadow
int shadow-type
-
Inherit Bin
GTK.Bin
-
Method create
object(GTK.Frame) GTK.refdoc.GTK.Frame()->create(string|void label_text)
- Description
Create a new W(Frame) widget.
-
Method get_label
string GTK.refdoc.GTK.Frame()->get_label()
- Description
Return the text in the label widget.
-
Method get_label_align
mapping GTK.refdoc.GTK.Frame()->get_label_align()
- Description
Retrieves the x and y alignment of the label.
-
Method get_label_widget
object(GTK.Widget) GTK.refdoc.GTK.Frame()->get_label_widget()
- Description
Retrieves the label widget.
-
Method get_shadow_type
int GTK.refdoc.GTK.Frame()->get_shadow_type()
- Description
Return the shadow type.
-
Method set_label
object(GTK.Frame) GTK.refdoc.GTK.Frame()->set_label(string|void label_text)
- Description
Set the text of the label.
-
Method set_label_align
object(GTK.Frame) GTK.refdoc.GTK.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
object(GTK.Frame) GTK.refdoc.GTK.Frame()->set_label_widget(object(GTK.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
object(GTK.Frame) GTK.refdoc.GTK.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 GTK.refdoc.GTK.CellRendererToggle |
Methods
create()
get_active()
get_radio()
set_active()
set_radio()
|
- 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 radio
Draw the toggle butotn as a radio button.
Signals:
toggled
-
Inherit CellRenderer
GTK.CellRenderer
-
Method create
object(GTK.CellRendererToggle) GTK.refdoc.GTK.CellRendererToggle()->create()
- Description
Creates a new W(CellRendererToggle). Adjust rendering parameters using
object properties. Object properties can be set globally with
set().
-
Method get_active
int GTK.refdoc.GTK.CellRendererToggle()->get_active()
- Description
Returns whether the cell renderer is active.
-
Method get_radio
int GTK.refdoc.GTK.CellRendererToggle()->get_radio()
- Description
Returns whether we're rendering radio toggles rather than checkboxes.
-
Method set_active
object(GTK.CellRendererToggle) GTK.refdoc.GTK.CellRendererToggle()->set_active(int setting)
- Description
Activates or deactivates a cell renderer.
-
Method set_radio
object(GTK.CellRendererToggle) GTK.refdoc.GTK.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 GTK.refdoc.GTK.TreeView |
Methods
append_column()
collapse_all()
collapse_row()
columns_autosize()
create()
expand_all()
expand_row()
get_column()
get_columns()
get_cursor()
get_enable_search()
get_expander_column()
get_hadjustment()
get_headers_visible()
get_model()
get_reorderable()
get_rules_hint()
get_search_column()
get_selection()
get_vadjustment()
insert_column()
move_column_after()
remove_column()
row_activated()
row_expanded()
scroll_to_cell()
scroll_to_point()
set_cursor()
set_enable_search()
set_expander_column()
set_hadjustment()
set_headers_clickable()
set_headers_visible()
set_model()
set_reorderable()
set_rules_hint()
set_search_column()
set_vadjustment()
|
- Description
Properties:
int enable-search
GTK.TreeViewColumn expander-column
GTK.Adjustment hadjustment
int headers-clickable
int headers-visible
GTK.TreeModel model
int reorderable
int rules-hint
int search-column
GTK.Adjustment vadjustment
Style properties:
int allow-rules
GDK.Color even-row-color
int expander-size
int horizontal-separator
int indent-expanders
GDK.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
GTK.Container
-
Method append_column
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->append_column(object(GTK.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 GTK.TREE_VIEW_COLUMN_FIXED.
-
Method collapse_all
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->collapse_all()
- Description
Recursively collapses all visible, expanded nodes.
-
Method collapse_row
int GTK.refdoc.GTK.TreeView()->collapse_row(object(GTK.TreePath) path)
- Description
Collapses a row (hides its child rows, if they exist).
-
Method columns_autosize
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->columns_autosize()
- Description
Resizes all columns to their optimal width. Only works after the treeview
has been realized.
-
Method create
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->create(object(GTK.TreeModel) model)
- Description
Create a new W(TreeView), with or without a default model.
-
Method expand_all
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->expand_all()
- Description
Recursively expands all nodes.
-
Method expand_row
int GTK.refdoc.GTK.TreeView()->expand_row(object(GTK.TreePath) path, int open_all)
- Description
Opens the row so its children are visible.
-
Method get_column
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeView()->get_column(int n)
- Description
Gets the W(TreeViewColumn) at the given position.
-
Method get_columns
array GTK.refdoc.GTK.TreeView()->get_columns()
- Description
Returns an array of all the W(TreeViewColumn)'s current in the view.
-
Method get_cursor
mapping GTK.refdoc.GTK.TreeView()->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": GTK.TreePath, "column": GTK.TreeViewColumn ]);
-
Method get_enable_search
int GTK.refdoc.GTK.TreeView()->get_enable_search()
- Description
Returns whether or not the tree allows to start interactive searching by
typing in text.
-
Method get_expander_column
object(GTK.TreeViewColumn) GTK.refdoc.GTK.TreeView()->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_hadjustment
object(GTK.Adjustment) GTK.refdoc.GTK.TreeView()->get_hadjustment()
- Description
Gets the W(Adjustment) currently being used for the horizontal aspect.
-
Method get_headers_visible
int GTK.refdoc.GTK.TreeView()->get_headers_visible()
- Description
Returns true if the headers are visible.
-
Method get_model
object(GTK.TreeModel) GTK.refdoc.GTK.TreeView()->get_model()
- Description
Returns the model this TreeView is based on.
-
Method get_reorderable
int GTK.refdoc.GTK.TreeView()->get_reorderable()
- Description
Retrieves whether the user can reorder the tree via drag-and-drop.
-
Method get_rules_hint
int GTK.refdoc.GTK.TreeView()->get_rules_hint()
- Description
Gets the setting set by set_rules_hint().
-
Method get_search_column
int GTK.refdoc.GTK.TreeView()->get_search_column()
- Description
Gets the column searched on by the interactive search code.
-
Method get_selection
object(GTK.TreeSelection) GTK.refdoc.GTK.TreeView()->get_selection()
- Description
Gets the W(TreeSelection) associated with this TreeView.
-
Method get_vadjustment
object(GTK.Adjustment) GTK.refdoc.GTK.TreeView()->get_vadjustment()
- Description
Gets the W(Adjustment) currently being used for the vertical aspect.
-
Method insert_column
int GTK.refdoc.GTK.TreeView()->insert_column(object(GTK.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
GTK.TREE_VIEW_COLUMN_FIXED.
-
Method move_column_after
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->move_column_after(object(GTK.TreeViewColumn) column, object(GTK.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 GTK.refdoc.GTK.TreeView()->remove_column(object(GTK.TreeViewColumn) column)
- Description
Removes column.
-
Method row_activated
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->row_activated(object(GTK.TreePath) path, object(GTK.TreeViewColumn) column)
- Description
Activates the cell determined by path and column.
-
Method row_expanded
int GTK.refdoc.GTK.TreeView()->row_expanded(object(GTK.TreePath) path)
- Description
Returns true if the node pointed to by path is expanded.
-
Method scroll_to_cell
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->scroll_to_cell(object(GTK.TreePath) path, object(GTK.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
object(GTK.TreeView) GTK.refdoc.GTK.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
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->set_cursor(object(GTK.TreePath) path, object(GTK.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_enable_search
object(GTK.TreeView) GTK.refdoc.GTK.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_expander_column
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->set_expander_column(object(GTK.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_hadjustment
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->set_hadjustment(object(GTK.Adjustment) hadj)
- Description
Sets the W(Adjustment) for the current horizontal aspect.
-
Method set_headers_clickable
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->set_headers_clickable(int setting)
- Description
Allow the column title buttons to be clicked.
-
Method set_headers_visible
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->set_headers_visible(int headers_visible)
- Description
Sets the visibility state of the headers.
-
Method set_model
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->set_model(object(GTK.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
object(GTK.TreeView) GTK.refdoc.GTK.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_rules_hint
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->set_rules_hint(int setting)
- Description
This function tells GTK+ that the user interface for your application
requires users to read across tree rows and associate cells with one
another. By default, GTK+ 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
object(GTK.TreeView) GTK.refdoc.GTK.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_vadjustment
object(GTK.TreeView) GTK.refdoc.GTK.TreeView()->set_vadjustment(object(GTK.Adjustment) vadj)
- Description
Sets the W(Adjustment) for the current vertical aspect.
|
| CLASS GTK.refdoc.GTK.Dialog |
Methods
add_action_widget()
add_button()
create()
get_action_area()
get_has_separator()
get_vbox()
response()
run()
set_default_response()
set_has_separator()
set_response_sensitive()
|
- 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
GTK.Window
-
Method add_action_widget
object(GTK.Dialog) GTK.refdoc.GTK.Dialog()->add_action_widget(object(GTK.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
object(GTK.Widget) GTK.refdoc.GTK.Dialog()->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
object(GTK.Dialog) GTK.refdoc.GTK.Dialog()->create()
- Description
Create a new dialog widget.
-
Method get_action_area
object(GTK.HbuttonBox) GTK.refdoc.GTK.Dialog()->get_action_area()
- Description
The action area, this is where the buttons (ok, cancel etc) go
-
Method get_has_separator
int GTK.refdoc.GTK.Dialog()->get_has_separator()
- Description
Accessor for whether the dialog has a separator.
-
Method get_vbox
object(GTK.Vbox) GTK.refdoc.GTK.Dialog()->get_vbox()
- Description
The vertical box that should contain the contents of the dialog
-
Method response
object(GTK.Dialog) GTK.refdoc.GTK.Dialog()->response(int response_id)
- Description
Emits the "response" signal with the given response ID.
-
Method run
int GTK.refdoc.GTK.Dialog()->run()
- Description
Run the selected dialog.
-
Method set_default_response
object(GTK.Dialog) GTK.refdoc.GTK.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
object(GTK.Dialog) GTK.refdoc.GTK.Dialog()->set_has_separator(int setting)
- Description
Sets whether this dialog has a separator above the buttons. True by
default.
-
Method set_response_sensitive
object(GTK.Dialog) GTK.refdoc.GTK.Dialog()->set_response_sensitive(int response_id, int setting)
- Description
Calls GTK.Widget->set_sensitive() for each widget in the dialog's action
area with the given response_id.
|
| CLASS GTK.refdoc.GTK.Bin |
Methods
get_child()
|
- Description
A container that can only contain one child.
-
Inherit Container
GTK.Container
-
Method get_child
object(GTK.Widget) GTK.refdoc.GTK.Bin()->get_child()
- Description
Return the child.
|
| CLASS GTK.refdoc.GTK.Vpaned |
Methods
create()
|
- Description
The paned window widgets are useful when you want to divide an area
into two parts, with the relative size of the two parts controlled
by the user. A groove is drawn between the two portions with a
handle that the user can drag to change the ratio. This widgets
makes a vertical division
GTK.Vpaned()->add1(GTK.Label("Top Side Of Pane"))->add2(GTK.Label("Bottom"))->set_size_request(100,100)
../images/gtk_vpaned.png
-
Inherit Paned
GTK.Paned
-
Method create
object(GTK.Vpaned) GTK.refdoc.GTK.Vpaned()->create()
- Description
Create a new W(Vpaned) widget.
|
| CLASS GTK.refdoc.GTK.TextView |
Methods
add_child_at_anchor()
add_child_in_window()
backward_display_line()
backward_display_line_start()
buffer_to_window_coords()
create()
forward_display_line()
forward_display_line_end()
get_border_window_size()
get_buffer()
get_cursor_visible()
get_default_attributes()
get_editable()
get_indent()
get_iter_at_location()
get_iter_location()
get_justification()
get_left_margin()
get_line_at_y()
get_line_yrange()
get_pixels_above_lines()
get_pixels_below_lines()
get_pixels_inside_wrap()
get_right_margin()
get_tabs()
get_visible_rect()
get_window()
get_window_type()
get_wrap_mode()
move_child()
move_mark_onscreen()
move_visually()
place_cursor_onscreen()
scroll_mark_onscreen()
scroll_to_iter()
scroll_to_mark()
set_border_window_size()
set_buffer()
set_cursor_visible()
set_editable()
set_indent()
set_justification()
set_left_margin()
set_pixels_above_lines()
set_pixels_below_lines()
set_pixels_inside_wrap()
set_right_margin()
set_tabs()
set_wrap_mode()
starts_display_line()
window_to_buffer_coords()
|
- Description
Properties:
int accepts-tab
GTK.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:
GDK.Color error-underline-color
Signals:
backspace
copy_clipboard
cut_clipboard
delete_from_cursor
insert_at_cursor
move_cursor
move_focus
move_viewpoert
page_horizontally
paste_clipboard
populate_popup
select_all
set_anchor
set_scroll_adjustments
toggle_overwrite
-
Inherit Container
GTK.Container
-
Method add_child_at_anchor
object(GTK.TextView) GTK.refdoc.GTK.TextView()->add_child_at_anchor(object(GTK.Widget) child, object(GTK.TextChildAnchor) anchor)
- Description
Adds a child widget in the text buffer, at the given anchor.
-
Method add_child_in_window
object(GTK.TextView) GTK.refdoc.GTK.TextView()->add_child_in_window(object(GTK.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 //! GTK.TextView->set_border_window_size()). Note that the child coordinates
are given relative to the GDK.Window in question, and that these
coordinates have no sane relationship to scrolling. When placing a child
in GTK.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 GTK.TextView->move_child() to update the
child's position. Unfortunately there's no good way to detect that
scrolling has occured, 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 GTK.refdoc.GTK.TextView()->backward_display_line(object(GTK.TextIter) iter)
- Description
See forward_display_line().
-
Method backward_display_line_start
int GTK.refdoc.GTK.TextView()->backward_display_line_start(object(GTK.TextIter) iter)
- Description
Moves the iter backward to the next display line start.
-
Method buffer_to_window_coords
array GTK.refdoc.GTK.TextView()->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
object(GTK.TextView) GTK.refdoc.GTK.TextView()->create(object(GTK.TextBuffer) buffer)
- Description
Create a new W(TextView).
-
Method forward_display_line
int GTK.refdoc.GTK.TextView()->forward_display_line(object(GTK.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 GTK.refdoc.GTK.TextView()->forward_display_line_end(object(GTK.TextIter) iter)
- Description
Moves the iter forward to the next display line end.
-
Method get_border_window_size
int GTK.refdoc.GTK.TextView()->get_border_window_size(int wintype)
- Description
Gets the width of the specified border window.
-
Method get_buffer
object(GTK.TextBuffer) GTK.refdoc.GTK.TextView()->get_buffer()
- Description
Returns the buffer displayed by this view.
-
Method get_cursor_visible
int GTK.refdoc.GTK.TextView()->get_cursor_visible()
- Description
Find out whether the cursor is being displayed.
-
Method get_default_attributes
object(GTK.TextAttributes) GTK.refdoc.GTK.TextView()->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 GTK.refdoc.GTK.TextView()->get_editable()
- Description
Gets the default editability.
-
Method get_indent
int GTK.refdoc.GTK.TextView()->get_indent()
- Description
Gets the default indentation for paragraphs.
-
Method get_iter_at_location
object(GTK.TextIter) GTK.refdoc.GTK.TextView()->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_location
object(GDK.Rectangle) GTK.refdoc.GTK.TextView()->get_iter_location(object(GTK.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 GTK.refdoc.GTK.TextView()->get_justification()
- Description
Gets the default justification.
-
Method get_left_margin
int GTK.refdoc.GTK.TextView()->get_left_margin()
- Description
Gets the default left margin size of paragraphs.
-
Method get_line_at_y
object(GTK.TextIter) GTK.refdoc.GTK.TextView()->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 GTK.refdoc.GTK.TextView()->get_line_yrange(object(GTK.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_pixels_above_lines
int GTK.refdoc.GTK.TextView()->get_pixels_above_lines()
- Description
Gets the default number of pixels to put above paragraphs.
-
Method get_pixels_below_lines
int GTK.refdoc.GTK.TextView()->get_pixels_below_lines()
- Description
Gets the value set by set_pixels_below_lines().
-
Method get_pixels_inside_wrap
int GTK.refdoc.GTK.TextView()->get_pixels_inside_wrap()
- Description
Gets the value set by set_pixels_inside_wrap().
-
Method get_right_margin
int GTK.refdoc.GTK.TextView()->get_right_margin()
- Description
Gets the default right margin size of paragraphs.
-
Method get_tabs
object(Pango.TabArray) GTK.refdoc.GTK.TextView()->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
object(GDK.Rectangle) GTK.refdoc.GTK.TextView()->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
object(GDK.Window) GTK.refdoc.GTK.TextView()->get_window(int wintype)
- Description
Retrieves the GDK.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 GTK.refdoc.GTK.TextView()->get_window_type(object(GDK.Window) 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 GTK.refdoc.GTK.TextView()->get_wrap_mode()
- Description
Gets the line wrapping mode.
-
Method move_child
object(GTK.TextView) GTK.refdoc.GTK.TextView()->move_child(object(GTK.Widget) child, int x, int y)
- Description
Updates the position of a child.
-
Method move_mark_onscreen
int GTK.refdoc.GTK.TextView()->move_mark_onscreen(object(GTK.TextMark) mark)
- Description
Moves a mark within the buffer so that it's located within the currently
visible text-area.
-
Method move_visually
int GTK.refdoc.GTK.TextView()->move_visually(object(GTK.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 GTK.refdoc.GTK.TextView()->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
object(GTK.TextView) GTK.refdoc.GTK.TextView()->scroll_mark_onscreen(object(GTK.TextMark) mark)
- Description
Scrolls the view the minimum distance such that mark is contained
within the visible area.
-
Method scroll_to_iter
object(GTK.TextView) GTK.refdoc.GTK.TextView()->scroll_to_iter(object(GTK.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
object(GTK.TextView) GTK.refdoc.GTK.TextView()->scroll_to_mark(object(GTK.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_border_window_size
object(GTK.TextView) GTK.refdoc.GTK.TextView()->set_border_window_size(int wintype, int size)
- Description
Sets the width of GTK.TEXT_WINDOW_LEFT or GTK.TEXT_WINDOW_RIGHT, or the
height of GTK.TEXT_WINDOW_TOP or GTK.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 GTK.TEXT_WINDOW_WIDGET,
GTK.TEXT_WINDOW_TEXT, or GTK.TEXT_WINDOW_PRIVATE.
-
Method set_buffer
object(GTK.TextView) GTK.refdoc.GTK.TextView()->set_buffer(object(GTK.TextBuffer) buffer)
- Description
Sets buffer as the buffer being displayed.
-
Method set_cursor_visible
object(GTK.TextView) GTK.refdoc.GTK.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
object(GTK.TextView) GTK.refdoc.GTK.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
object(GTK.TextView) GTK.refdoc.GTK.TextView()->set_indent(int indent)
- Description
Sets the default indentation for paragraphs. May be overridden by tags.
-
Method set_justification
object(GTK.TextView) GTK.refdoc.GTK.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
object(GTK.TextView) GTK.refdoc.GTK.TextView()->set_left_margin(int margin)
- Description
Sets the default left margin. May be overridden by tags.
-
Method set_pixels_above_lines
object(GTK.TextView) GTK.refdoc.GTK.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
object(GTK.TextView) GTK.refdoc.GTK.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
object(GTK.TextView) GTK.refdoc.GTK.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
object(GTK.TextView) GTK.refdoc.GTK.TextView()->set_right_margin(int margin)
- Description
Sets the default right margin. May be overridden by tags.
-
Method set_tabs
object(GTK.TextView) GTK.refdoc.GTK.TextView()->set_tabs(object(Pango.TabArray) tabs)
- Description
Sets the default tab stops for paragraphs. Tags in the buffer may
override the default.
-
Method set_wrap_mode
object(GTK.TextView) GTK.refdoc.GTK.TextView()->set_wrap_mode(int wrap_mode)
- Description
Sets the line wrapping. One of WRAP_CHAR, WRAP_NONE and WRAP_WORD.
-
Method starts_display_line
int GTK.refdoc.GTK.TextView()->starts_display_line(object(GTK.TextIter) iter)
- Description
Determines whether iter is at the start of a display line.
-
Method window_to_buffer_coords
array GTK.refdoc.GTK.TextView()->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 GTK.refdoc.GTK.Alignment |
Methods
create()
set()
|
- 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
GTK.Bin
-
Method create
object(GTK.Alignment) GTK.refdoc.GTK.Alignment()->create(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 GTK.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
object(GTK.Alignment) GTK.refdoc.GTK.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 GTK.Alignment.
yscale :
the amount that the child widget expands vertically to fill up unused space, from 0 to 1. The values are similar to xscale.
|
| CLASS GTK.refdoc.GTK.TextMark |
Methods
destroy()
get_buffer()
get_deleted()
get_left_gravity()
get_name()
get_visible()
set_visible()
|
- Description
Marks for the text.
-
Inherit Object
G.Object
-
Method destroy
object(GTK.TextMark) GTK.refdoc.GTK.TextMark()->destroy()
- Description
Destructor.
-
Method get_buffer
object(GTK.TextBuffer) GTK.refdoc.GTK.TextMark()->get_buffer()
- Description
Gets the buffer this mark is located inside, or empty if the mark
is deleted.
-
Method get_deleted
int GTK.refdoc.GTK.TextMark()->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 GTK.refdoc.GTK.TextMark()->get_left_gravity()
- Description
Determines whether the mark has left gravity.
-
Method get_name
string GTK.refdoc.GTK.TextMark()->get_name()
- Description
Returns the mark name; returns empty for anonymous marks.
-
Method get_visible
int GTK.refdoc.GTK.TextMark()->get_visible()
- Description
Returns true if the mark is visible.
-
Method set_visible
object(GTK.TextMark) GTK.refdoc.GTK.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 GTK.refdoc.GTK.Object |
Methods
destroy()
|
- 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 Object
G.Object
-
Method destroy
object(GTK.Object) GTK.refdoc.GTK.Object()->destroy()
- Description
Destructor.
|
| CLASS GTK.refdoc.GTK.HbuttonBox |
Methods
create()
|
- 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.
GTK.HbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_size_request(400,30)
../images/gtk_hbuttonbox.png
GTK.HbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_layout(GTK.BUTTONBOX_SPREAD)->set_size_request(400,30)
../images/gtk_hbuttonbox_2.png
GTK.HbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_layout(GTK.BUTTONBOX_EDGE)->set_size_request(400,30)
../images/gtk_hbuttonbox_3.png
GTK.HbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_layout(GTK.BUTTONBOX_START)->set_size_request(400,30)
../images/gtk_hbuttonbox_4.png
GTK.HbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_layout(GTK.BUTTONBOX_END)->set_size_request(400,30)
../images/gtk_hbuttonbox_5.png
-
Inherit ButtonBox
GTK.ButtonBox
-
Method create
object(GTK.HbuttonBox) GTK.refdoc.GTK.HbuttonBox()->create()
- Description
Create a new horizontal button box
|
| CLASS GTK.refdoc.GTK.TextBuffer |
Methods
add_selection_clipboard()
apply_tag()
apply_tag_by_name()
begin_user_action()
copy_clipboard()
create()
create_child_anchor()
create_mark()
create_tag()
cut_clipboard()
delete()
delete_interactive()
delete_mark()
delete_mark_by_name()
delete_selection()
end_user_action()
get_bounds()
get_char_count()
get_end_iter()
get_insert()
get_iter_at_child_anchor()
get_iter_at_line()
get_iter_at_line_index()
get_iter_at_line_offset()
get_iter_at_mark()
get_iter_at_offset()
get_line_count()
get_mark()
get_modified()
get_selection_bound()
get_selection_bounds()
get_slice()
get_start_iter()
get_tag_table()
get_text()
insert()
insert_at_cursor()
insert_child_anchor()
insert_interactive()
insert_interactive_at_cursor()
insert_pixbuf()
insert_range()
insert_range_interactive()
insert_with_tags()
insert_with_tags_by_name()
move_mark()
move_mark_by_name()
paste_clipboard()
place_cursor()
remove_all_tags()
remove_selection_clipboard()
remove_tag()
remove_tag_by_name()
set_modified()
set_text()
|
- Description
Properties:
GTK.TextTagTable tag_table
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
G.Object
-
Method add_selection_clipboard
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->add_selection_clipboard(object(GTK.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
GTK.Clipboard of GDK.SELECTION_PRIMARY for a view of this buffer.
-
Method apply_tag
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->apply_tag(object(GTK.TextTag) tag, object(GTK.TextIter) start, object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->apply_tag_by_name(string name, object(GTK.TextIter) start, object(GTK.TextIter) end)
- Description
Calls GTK.TextTagTable->lookup() on the buffers tag table to get a
GTK.TextTag, then calls apply_tag().
-
Method begin_user_action
object(GTK.TextBuffer) GTK.refdoc.GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->copy_clipboard(object(GTK.Clipboard) clipboard)
- Description
Copies the currently-selected text to a clipboard.
-
Method create
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->create(object(GTK.TextTagTable) table)
- Description
Creates a new text buffer.
-
Method create_child_anchor
object(GTK.TextChildAnchor) GTK.refdoc.GTK.TextBuffer()->create_child_anchor(object(GTK.TextIter) iter)
- Description
This is a convenience function which simply creates a child anchor with
GTK.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
object(GTK.TextMark) GTK.refdoc.GTK.TextBuffer()->create_mark(object(GTK.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
object(GTK.TextTag) GTK.refdoc.GTK.TextBuffer()->create_tag(string tag_name, mapping props)
- Description
Creates a tag and adds it to the tag table. Equivalent to calling
GTK.TextTag->create() and then adding the tag to the tag table. The
returned tag is owned by the tag table.
-
Method cut_clipboard
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->cut_clipboard(object(GTK.Clipboard) clipboard, int default_editable)
- Description
Copies the currently-selected text to a clipboard, then deletes said
text if it's editable.
-
Method delete
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->delete(object(GTK.TextIter) start, object(GTK.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 GTK.refdoc.GTK.TextBuffer()->delete_interactive(object(GTK.TextIter) start, object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->delete_mark(object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->delete_mark_by_name(string name)
- Description
Deletes the mark named name; the mark must exist.
-
Method delete_selection
int GTK.refdoc.GTK.TextBuffer()->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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->end_user_action()
- Description
Should be paired with begin_user_action();
-
Method get_bounds
array GTK.refdoc.GTK.TextBuffer()->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 GTK.refdoc.GTK.TextBuffer()->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
object(GTK.TextIter) GTK.refdoc.GTK.TextBuffer()->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_insert
object(GTK.TextMark) GTK.refdoc.GTK.TextBuffer()->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
object(GTK.TextIter) GTK.refdoc.GTK.TextBuffer()->get_iter_at_child_anchor(object(GTK.TextChildAnchor) anchor)
- Description
Returns the location of anchor.
-
Method get_iter_at_line
object(GTK.TextIter) GTK.refdoc.GTK.TextBuffer()->get_iter_at_line(int line)
- Description
Returns a W(TextIter) to the start of the given line.
-
Method get_iter_at_line_index
object(GTK.TextIter) GTK.refdoc.GTK.TextBuffer()->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
object(GTK.TextIter) GTK.refdoc.GTK.TextBuffer()->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
object(GTK.TextIter) GTK.refdoc.GTK.TextBuffer()->get_iter_at_mark(object(GTK.TextMark) mark)
- Description
Returns an iterator with the current position of mark.
-
Method get_iter_at_offset
object(GTK.TextIter) GTK.refdoc.GTK.TextBuffer()->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 GTK.refdoc.GTK.TextBuffer()->get_line_count()
- Description
Obtains the number of lines in the buffer.
-
Method get_mark
object(GTK.TextMark) GTK.refdoc.GTK.TextBuffer()->get_mark(string name)
- Description
Returns the mark named name.
-
Method get_modified
int GTK.refdoc.GTK.TextBuffer()->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
object(GTK.TextMark) GTK.refdoc.GTK.TextBuffer()->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 GTK.refdoc.GTK.TextBuffer()->get_selection_bounds()
- Description
Returns either a start and end W(TextIter) if some text is selected, or
2 0's.
-
Method get_slice
string GTK.refdoc.GTK.TextBuffer()->get_slice(object(GTK.TextIter) start, object(GTK.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
object(GTK.TextIter) GTK.refdoc.GTK.TextBuffer()->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
object(GTK.TextTagTable) GTK.refdoc.GTK.TextBuffer()->get_tag_table()
- Description
Get the W(TextTagTable) associated with this buffer.
-
Method get_text
string GTK.refdoc.GTK.TextBuffer()->get_text(object(GTK.TextIter) start, object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->insert(object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->insert_child_anchor(object(GTK.TextIter) iter, object(GTK.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 GTK.refdoc.GTK.TextBuffer()->insert_interactive(object(GTK.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 GTK.refdoc.GTK.TextBuffer()->insert_interactive_at_cursor(string text, int len, int default_editable)
- Description
Calls insert_interactive() at the cursor position.
-
Method insert_pixbuf
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->insert_pixbuf(object(GTK.TextIter) iter, object(GDK.Pixbuf) 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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->insert_range(object(GTK.TextIter) iter, object(GTK.TextIter) start, object(GTK.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 GTK.refdoc.GTK.TextBuffer()->insert_range_interactive(object(GTK.TextIter) iter, object(GTK.TextIter) start, object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->insert_with_tags(object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->insert_with_tags_by_name(object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->move_mark(object(GTK.TextMark) mark, object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->move_mark_by_name(string name, object(GTK.TextIter) where)
- Description
Moves the mark named name (which must exist) to location where.
-
Method paste_clipboard
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->paste_clipboard(object(GTK.Clipboard) clipboard, int|void default_editable, object(GTK.TextIter) location)
- Description
Pastes the contents of a clipboard at the insertion point, or at
override_location.
-
Method place_cursor
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->place_cursor(object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->remove_all_tags(object(GTK.TextIter) start, object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->remove_selection_clipboard(object(GTK.Clipboard) clipboard)
- Description
Removes a clipboard that was added with add_selection_clipboard().
-
Method remove_tag
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->remove_tag(object(GTK.TextTag) tag, object(GTK.TextIter) start, object(GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->remove_tag_by_name(string name, object(GTK.TextIter) start, object(GTK.TextIter) end)
- Description
Removes a tag. See apply_tag_by_name().
-
Method set_modified
object(GTK.TextBuffer) GTK.refdoc.GTK.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
object(GTK.TextBuffer) GTK.refdoc.GTK.TextBuffer()->set_text(string text, int len)
- Description
Deletes current contents of this buffer, and inserts text instead. If
len is -1, text must be nul-terminated. text must be valid UTF-8.
|
| CLASS GTK.refdoc.GTK.RcStyle |
Methods
copy()
create()
set_base()
set_bg()
set_bg_pixmap_name()
set_color_flags()
set_fg()
set_name()
set_text()
set_xthickness()
set_ythickness()
|
- Description
RC settings.
-
Inherit Object
G.Object
-
Method copy
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->copy()
- Description
Makes a copy.
-
Method create
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->create()
- Description
Creates a new W(Rc).
-
Method set_base
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->set_base(array colors)
- Description
Set base.
-
Method set_bg
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->set_bg(array colors)
- Description
Set bg.
-
Method set_bg_pixmap_name
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->set_bg_pixmap_name(array names)
- Description
Set bg_pixmap_name.
-
Method set_color_flags
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->set_color_flags(array flags)
- Description
Set color_flags.
-
Method set_fg
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->set_fg(array colors)
- Description
Set fg.
-
Method set_name
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->set_name(string name)
- Description
Set the name.
-
Method set_text
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->set_text(array colors)
- Description
Set text.
-
Method set_xthickness
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->set_xthickness(int value)
- Description
Set xthickness.
-
Method set_ythickness
object(GTK.RcStyle) GTK.refdoc.GTK.RcStyle()->set_ythickness(int value)
- Description
Set ythickness.
|
| CLASS GTK.refdoc.GTK.SpinButton |
Methods
configure()
create()
get_digits()
get_increments()
get_numeric()
get_range()
get_snap_to_ticks()
get_update_policy()
get_value()
get_value_as_int()
get_wrap()
set_adjustment()
set_digits()
set_increments()
set_numeric()
set_range()
set_snap_to_ticks()
set_update_policy()
set_value()
set_wrap()
spin()
update()
|
- 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
GTK.SpinButton( GTK.Adjustment(),0.1, 1 )->set_usize(60,20)
../images/gtk_spinbutton.png
Properties:
GDK.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 Entry
GTK.Entry
-
Method configure
object(GTK.SpinButton) GTK.refdoc.GTK.SpinButton()->configure(object(GTK.Adjustment) range, float climb_rate, int precision)
- Description
Adjustment (with the lower/upper/increse values), climb_rate and digits
-
Method create
object(GTK.SpinButton) GTK.refdoc.GTK.SpinButton()->create(object(GTK.Adjustment) range_or_min, 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_digits
int GTK.refdoc.GTK.SpinButton()->get_digits()
- Description
Fetches the precision.
-
Method get_increments
mapping GTK.refdoc.GTK.SpinButton()->get_increments()
- Description
Gets the current step and page increments.
-
Method get_numeric
int GTK.refdoc.GTK.SpinButton()->get_numeric()
- Description
Returns whether non-numeric text can be typed in.
-
Method get_range
mapping GTK.refdoc.GTK.SpinButton()->get_range()
- Description
Gets the range allowed.
-
Method get_snap_to_ticks
int GTK.refdoc.GTK.SpinButton()->get_snap_to_ticks()
- Description
Returns whether the value are corrected to the nearest step.
-
Method get_update_policy
int GTK.refdoc.GTK.SpinButton()->get_update_policy()
- Description
Gets the update behavior.
-
Method get_value
float GTK.refdoc.GTK.SpinButton()->get_value()
- Description
Get the value.
-
Method get_value_as_int
int GTK.refdoc.GTK.SpinButton()->get_value_as_int()
- Description
The current value of a Spin Button can be retrieved as a int.
-
Method get_wrap
int GTK.refdoc.GTK.SpinButton()->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
object(GTK.SpinButton) GTK.refdoc.GTK.SpinButton()->set_adjustment(object(GTK.Adjustment) range)
- Description
Set a new adjustment.
-
Method set_digits
object(GTK.SpinButton) GTK.refdoc.GTK.SpinButton()->set_digits(int precision)
- Description
Set the number of digits to show to the user.
-
Method set_increments
object(GTK.SpinButton) GTK.refdoc.GTK.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
object(GTK.SpinButton) GTK.refdoc.GTK.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
object(GTK.SpinButton) GTK.refdoc.GTK.SpinButton()->set_range(float min, float max)
- Description
Sets the minimum and maximum allowable values.
-
Method set_snap_to_ticks
object(GTK.SpinButton) GTK.refdoc.GTK.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
object(GTK.SpinButton) GTK.refdoc.GTK.SpinButton()->set_update_policy(int policy)
- Description
The possible values of policy are either GTK.UpdateAlways or
GTK.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 GTK.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 GTK.UpdateAlways errors are ignored while converting text
into a numeric value.
-
Method set_value
object(GTK.SpinButton) GTK.refdoc.GTK.SpinButton()->set_value(float to)
- Description
Set the value.
-
Method set_wrap
object(GTK.SpinButton) GTK.refdoc.GTK.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
object(GTK.SpinButton) GTK.refdoc.GTK.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
GTK.SpinStepForward and GTK.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.
GTK.SpinPageForward and GTK.SpinPageBackward simply alter the
value of the Spin Button by increment.
GTK.SpinHome sets the value of the Spin Button to the bottom of the
Adjustments range.
GTK.SpinEnd sets the value of the Spin Button to the top of the
Adjustments range.
GTK.SpinUserDefined simply alters the value of the Spin Button by
the specified amount.
-
Method update
object(GTK.SpinButton) GTK.refdoc.GTK.SpinButton()->update()
- Description
Explicitly request that the Spin Button updates itself
|
| CLASS GTK.refdoc.GTK.MenuShell |
Methods
activate_item()
append()
deactivate()
deselect()
get_children()
insert()
prepend()
select_item()
|
- Description
A GTK.MenuShell is the abstract base class used to derive the
W(Menu) and W(MenuBar) subclasses.
A GTK.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.
selection_done
This signal is emitted when a selection has been completed within a
menu shell.
-
Inherit Container
GTK.Container
-
Method activate_item
object(GTK.MenuShell) GTK.refdoc.GTK.MenuShell()->activate_item(object(GTK.Widget) menu_item, int force_deactivate)
- Description
Activates the menu item within the menu shell.
-
Method append
object(GTK.MenuShell) GTK.refdoc.GTK.MenuShell()->append(object(GTK.Widget) what)
- Description
Adds a new W(MenuItem) to the end of the menu shell's item
list. Same as 'add'.
-
Method deactivate
object(GTK.MenuShell) GTK.refdoc.GTK.MenuShell()->deactivate()
- Description
Deactivates the menu shell. Typically this results in the menu
shell being erased from the screen.
-
Method deselect
object(GTK.MenuShell) GTK.refdoc.GTK.MenuShell()->deselect()
- Description
Deselects the currently selected item from the menu shell, if any.
-
Method get_children
array GTK.refdoc.GTK.MenuShell()->get_children()
- Description
This function returns all children of the menushell as an array.
-
Method insert
object(GTK.MenuShell) GTK.refdoc.GTK.MenuShell()->insert(object(GTK.Widget) what, int where)
- Description
Add a widget after the specified location
-
Method prepend
object(GTK.MenuShell) GTK.refdoc.GTK.MenuShell()->prepend(object(GTK.Widget) what)
- Description
Add a menu item to the start of the widget (for a menu: top, for a
bar: left)
-
Method select_item
object(GTK.MenuShell) GTK.refdoc.GTK.MenuShell()->select_item(object(GTK.Widget) menuitem)
- Description
Selects the menu item from the menu shell.
|
| CLASS GTK.refdoc.GTK.Notebook |
Methods
append_page()
append_page_menu()
create()
get_current_page()
get_menu_label()
get_menu_label_text()
get_nth_page()
get_scrollable()
get_show_border()
get_show_tabs()
get_tab_label()
get_tab_label_text()
get_tab_pos()
insert_page()
insert_page_menu()
next_page()
page_num()
popup_disable()
popup_enable()
prepend_page()
prepend_page_menu()
prev_page()
query_tab_label_packing()
remove_page()
reorder_child()
set_current_page()
set_menu_label()
set_menu_label_text()
set_scrollable()
set_show_border()
set_show_tabs()
set_tab_label()
set_tab_label_packing()
set_tab_label_text()
set_tab_pos()
|
- 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.
GTK.Notebook( )->set_tab_pos( GTK.POS_LEFT )->append_page( GTK.Label("Page 1\nContents"), GTK.Label("Page 1"))->append_page( GTK.Label(""), GTK.Label("Page 2"))->append_page(GTK.Label("Page 3 contents\nare here!"), GTK.Label("Page 3"))
../images/gtk_notebook.png
GTK.Notebook( )->set_tab_pos( GTK.POS_TOP )->append_page( GTK.Label("Page 1\nContents"), GTK.Label("Page 1"))->append_page( GTK.Label(""), GTK.Label("Page 2"))->append_page(GTK.Label("Page 3 contents\nare here!"), GTK.Label("Page 3"))
../images/gtk_notebook_2.png
GTK.Notebook( )->set_tab_pos( GTK.POS_RIGHT )->append_page( GTK.Label("Page 1\nContents"), GTK.Label("Page 1"))->append_page( GTK.Label(""), GTK.Label("Page 2"))->append_page(GTK.Label("Page 3 contents\nare here!"), GTK.Label("Page 3"))->next_page()->next_page()
../images/gtk_notebook_3.png
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
Signals:
change_current_page
focus_tab
move_focus_out
select_page
switch_page
Called when a different page is selected
-
Inherit Container
GTK.Container
-
Method append_page
int GTK.refdoc.GTK.Notebook()->append_page(object(GTK.Widget) contents, object(GTK.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
int GTK.refdoc.GTK.Notebook()->append_page_menu(object(GTK.Widget) contents, object(GTK.Widget) label, object(GTK.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
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->create()
- Description
Create a W(Notebook) widget with no pages.
-
Method get_current_page
int GTK.refdoc.GTK.Notebook()->get_current_page()
- Description
Returns the index of the currently selected page
-
Method get_menu_label
object(GTK.Widget) GTK.refdoc.GTK.Notebook()->get_menu_label(object(GTK.Widget) page)
- Description
Return the menu label widget.
-
Method get_menu_label_text
string GTK.refdoc.GTK.Notebook()->get_menu_label_text(object(GTK.Widget) child)
- Description
Retrieves the text of the menu label for the page containing child.
-
Method get_nth_page
object(GTK.Widget) GTK.refdoc.GTK.Notebook()->get_nth_page(int index)
- Description
Returns the page for the specified index
-
Method get_scrollable
int GTK.refdoc.GTK.Notebook()->get_scrollable()
- Description
Returns whether the tab label area has arrows for scrolling.
-
Method get_show_border
int GTK.refdoc.GTK.Notebook()->get_show_border()
- Description
Returns whether a bevel will be drawn around the pages.
-
Method get_show_tabs
int GTK.refdoc.GTK.Notebook()->get_show_tabs()
- Description
Returns whether the tabs of the notebook are shown.
-
Method get_tab_label
object(GTK.Widget) GTK.refdoc.GTK.Notebook()->get_tab_label(object(GTK.Widget) page)
- Description
Returns the tab label widget.
-
Method get_tab_label_text
string GTK.refdoc.GTK.Notebook()->get_tab_label_text(object(GTK.Widget) child)
- Description
Retrieves the text of the tab label for the page containing child.
-
Method get_tab_pos
int GTK.refdoc.GTK.Notebook()->get_tab_pos()
- Description
Gets the edge at which the tabs are located.
-
Method insert_page
int GTK.refdoc.GTK.Notebook()->insert_page(object(GTK.Widget) contents, object(GTK.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
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->insert_page_menu(object(GTK.Widget) contents, object(GTK.Widget) label, object(GTK.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
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->next_page()
- Description
Go to the next page
-
Method page_num
int GTK.refdoc.GTK.Notebook()->page_num(object(GTK.Widget) widget)
- Description
Returns the index for the specified page.
-
Method popup_disable
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->popup_disable()
- Description
Disable the popup menu (set with insert_page_menu).
-
Method popup_enable
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->popup_enable()
- Description
Enable the popup menu (set with insert_page_menu).
-
Method prepend_page
int GTK.refdoc.GTK.Notebook()->prepend_page(object(GTK.Widget) contents, object(GTK.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
int GTK.refdoc.GTK.Notebook()->prepend_page_menu(object(GTK.Widget) contents, object(GTK.Widget) label, object(GTK.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
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->prev_page()
- Description
Go to the previous page
-
Method query_tab_label_packing
mapping GTK.refdoc.GTK.Notebook()->query_tab_label_packing(object(GTK.Widget) page)
- Description
Returns ([ "expand":expandp, "fill":fillp, "pack_type":type ])
-
Method remove_page
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->remove_page(int pos)
- Description
Remove a page.
-
Method reorder_child
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->reorder_child(object(GTK.Widget) child, int position)
- Description
Reorders the page containing child, so that it appears at
position.
-
Method set_current_page
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->set_current_page(int pos)
- Description
Go to the specified page
-
Method set_menu_label
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->set_menu_label(object(GTK.Widget) child, object(GTK.Widget) label)
- Description
Changes the menu label for the page containing child.
-
Method set_menu_label_text
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->set_menu_label_text(object(GTK.Widget) child, string label_text)
- Description
Creates a new label with label_text sets it as the menu label.
-
Method set_scrollable
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->set_scrollable(int scrollablep)
- Description
If true, add scrollbars if necessary.
-
Method set_show_border
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->set_show_border(int showborderp)
- Description
If true, show the borders around the contents and tabs.
-
Method set_show_tabs
object(GTK.Notebook) GTK.refdoc.GTK.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
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->set_tab_label(object(GTK.Widget) child, object(GTK.Widget) label)
- Description
Changes the tab label for child.
-
Method set_tab_label_packing
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->set_tab_label_packing(object(GTK.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
object(GTK.Notebook) GTK.refdoc.GTK.Notebook()->set_tab_label_text(object(GTK.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
object(GTK.Notebook) GTK.refdoc.GTK.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 GTK.refdoc.GTK.Menu |
Methods
create()
detach()
get_accel_group()
get_active()
get_attach_widget()
get_tearoff_state()
get_title()
popdown()
popup()
reorder_child()
reposition()
set_accel_group()
set_accel_path()
set_active()
set_tearoff_state()
set_title()
|
- Description
A GTK.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 GTK.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
GTK.Menu.
A GTK.Menu can also be popped up by activating a
W(OptionMenu). Other composite widgets such as the W(Notebook) can
pop up a GTK.Menu as well.
Applications can display a GTK.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.
GTK.Menu menu = create_menu();
GTK.Window window = create_window();
window->signal_connect( "button_press_event", lambda(GTK.Menu m,
GTK.Window w,
mapping e ) {
if( e->button == 3 )
menu->popup();
}, menu );
Properties:
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
GTK.MenuShell
-
Method create
object(GTK.Menu) GTK.refdoc.GTK.Menu()->create()
- Description
Creates a new GTK.Menu widget.
-
Method detach
object(GTK.Menu) GTK.refdoc.GTK.Menu()->detach()
- Description
Detaches the menu from the widget to which it had been attached.
-
Method get_accel_group
object(GTK.AccelGroup) GTK.refdoc.GTK.Menu()->get_accel_group()
- Description
Gets the W(AccelGroup) which holds global accelerators for the menu.
-
Method get_active
object(GTK.Widget) GTK.refdoc.GTK.Menu()->get_active()
- Description
Returns the selected menu item from the menu. This is used by
the W(OptionMenu).
-
Method get_attach_widget
object(GTK.Widget) GTK.refdoc.GTK.Menu()->get_attach_widget()
- Description
Returns the W(Widget) that the menu is attached to.
-
Method get_tearoff_state
int GTK.refdoc.GTK.Menu()->get_tearoff_state()
- Description
Returns whether the menu is torn off.
-
Method get_title
string GTK.refdoc.GTK.Menu()->get_title()
- Description
Returns the title of the menu.
-
Method popdown
object(GTK.Menu) GTK.refdoc.GTK.Menu()->popdown()
- Description
Removes the menu from the screen.
-
Method popup
object(GTK.Menu) GTK.refdoc.GTK.Menu()->popup(int|void button_pressed_to_show_menu)
- Description
The default button is 3.
-
Method reorder_child
object(GTK.Menu) GTK.refdoc.GTK.Menu()->reorder_child(object(GTK.Widget) child, int position)
- Description
Moves a W(MenuItem) to a new position within the GTK.Menu.
-
Method reposition
object(GTK.Menu) GTK.refdoc.GTK.Menu()->reposition()
- Description
Repositions the menu according to its position function.
-
Method set_accel_group
object(GTK.Menu) GTK.refdoc.GTK.Menu()->set_accel_group(object(GTK.AccelGroup) accelerators)
- Description
Set the W(AccelGroup) which holds global accelerators for the menu.
-
Method set_accel_path
object(GTK.Menu) GTK.refdoc.GTK.Menu()->set_accel_path(string accel_path)
- Description
Sets an accelerator path for this menu.
-
Method set_active
object(GTK.Menu) GTK.refdoc.GTK.Menu()->set_active(int activep)
- Description
Selects the specified menu item within the menu. This is used by
the W(OptionMenu).
-
Method set_tearoff_state
object(GTK.Menu) GTK.refdoc.GTK.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
object(GTK.Menu) GTK.refdoc.GTK.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 GTK.refdoc.GTK.Paned |
Methods
add1()
add2()
get_position()
pack1()
pack2()
set_position()
|
- Description
GTK.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 GTK.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 GTK.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 position
int position-set
Style properties:
int handle-size
Signals:
accept_position
cancel_position
cycle_child_focus
cycle_handle_focus
move_handle
toggle_handle_focus
-
Inherit Container
GTK.Container
-
Method add1
object(GTK.Paned) GTK.refdoc.GTK.Paned()->add1(object(GTK.Widget) left_or_top)
- Description
Set the left or topmost item.
This is equivalent to pack1(left_or_top,0,1)
-
Method add2
object(GTK.Paned) GTK.refdoc.GTK.Paned()->add2(object(GTK.Widget) right_or_bottom)
- Description
Set the right or bottommost item
This is equivalent to pack2(left_or_top,0,1)
-
Method get_position
int GTK.refdoc.GTK.Paned()->get_position()
- Description
Obtains the position of the divider between the two panes.
-
Method pack1
object(GTK.Paned) GTK.refdoc.GTK.Paned()->pack1(object(GTK.Widget) widget, int resize, int shrink)
- Description
Add a child to the top or left pane.
-
Method pack2
object(GTK.Paned) GTK.refdoc.GTK.Paned()->pack2(object(GTK.Widget) widget, int resize, int shrink)
- Description
Add a child to the bottom or right pane.
-
Method set_position
object(GTK.Paned) GTK.refdoc.GTK.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 GTK.refdoc.GTK.Vbox |
Methods
create()
|
- 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.
GTK.Vbox(0,0)->add(GTK.Button("Hello"))->add(GTK.Button("World"))->pack_end_defaults(GTK.Button("From right"))->pack_start_defaults(GTK.Button("From left"))
../images/gtk_vbox.png
GTK.Vbox(1,0)->add(GTK.Button("Hello"))->add(GTK.Button("World"))->pack_end_defaults(GTK.Button("From right"))->pack_start_defaults(GTK.Button("From left"))
../images/gtk_vbox_2.png
GTK.Vbox(1,40)->add(GTK.Button("Hello"))->add(GTK.Button("World"))->pack_end_defaults(GTK.Button("From right"))->pack_start_defaults(GTK.Button("From left"))
../images/gtk_vbox_3.png
-
Inherit Box
GTK.Box
-
Method create
object(GTK.Vbox) GTK.refdoc.GTK.Vbox()->create(int uniformp, int 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 GTK.refdoc.GTK.Misc |
Methods
get_alignment()
get_padding()
set_alignment()
set_padding()
|
- Description
The GTK.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.
GTK.Vbox(0,0)->add(GTK.Label("Label"))->set_size_request(100,20)
../images/gtk_misc.png
GTK.Vbox(0,0)->add(GTK.Label("Label")->set_alignment(1.0,0.0))->set_size_request(100,20)
../images/gtk_misc_2.png
GTK.Vbox(0,0)->add(GTK.Label("Label")->set_alignment(0.0,0.0))->set_size_request(100,20)
../images/gtk_misc_3.png
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
GTK.Widget
-
Method get_alignment
mapping GTK.refdoc.GTK.Misc()->get_alignment()
- Description
Gets the x and y alignment.
-
Method get_padding
mapping GTK.refdoc.GTK.Misc()->get_padding()
- Description
Gets the x and y padding.
-
Method set_alignment
object(GTK.Misc) GTK.refdoc.GTK.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
object(GTK.Misc) GTK.refdoc.GTK.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 GTK.refdoc.GTK.AspectFrame |
Methods
create()
set()
|
- Description
A W(Frame) widget that always maintain a specified ratio
between width and height. width/height == ratio
GTK.Aspect_frame("Title",0.5,0.5,0.4,0)->add( GTK.Label("Wrong aspect"))->set_size_request(200,200)
../images/gtk_aspectframe.png
Properties:
int obey-child
float ratio
float xalign
float yalign
-
Inherit Frame
GTK.Frame
-
Method create
object(GTK.AspectFrame) GTK.refdoc.GTK.AspectFrame()->create(string label, float xalign, float yalign, float ratio, int 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
object(GTK.AspectFrame) GTK.refdoc.GTK.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 GTK.refdoc.GTK.TextTagTable |
Methods
add()
create()
get_size()
lookup()
remove()
|
- Description
Table of text tags.
Signals:
tag_added
tag_changed
tag_removed
-
Inherit Object
G.Object
-
Method add
object(GTK.TextTagTable) GTK.refdoc.GTK.TextTagTable()->add(object(GTK.TextTag) tag)
- Description
Add a tag to the table. The tag is assigned the highest priority
in the table.
-
Method create
object(GTK.TextTagTable) GTK.refdoc.GTK.TextTagTable()->create()
- Description
Creates a new W(TextTagTable).
-
Method get_size
int GTK.refdoc.GTK.TextTagTable()->get_size()
- Description
Returns the size of the table (number of tags).
-
Method lookup
object(GTK.TextTag) GTK.refdoc.GTK.TextTagTable()->lookup(string name)
- Description
Look up a named tag.
-
Method remove
object(GTK.TextTagTable) GTK.refdoc.GTK.TextTagTable()->remove(object(GTK.TextTag) tag)
- Description
Remove a tag from the table.
|
| CLASS GTK.refdoc.GTK.Hseparator |
Methods
create()
|
- Description
Simply creates a horizontal separator. No bells or whistles.
GTK.Hseparator()->set_size_request(300,3)
../images/gtk_hseparator.png
-
Inherit Separator
GTK.Separator
-
Method create
object(GTK.Hseparator) GTK.refdoc.GTK.Hseparator()->create()
- Description
Used to create a new hseparator widget.
|
| CLASS GTK.refdoc.GTK.TreeStore |
Methods
append()
clear()
create()
drag_data_delete()
drag_data_get()
drag_data_received()
get_sort_column_id()
has_default_sort_func()
insert()
insert_after()
insert_before()
is_ancestor()
iter_depth()
prepend()
remove()
row_draggable()
row_drop_possible()
set_default_sort_func()
set_row()
set_sort_column_id()
set_sort_func()
set_value()
sort_column_changed()
|
- Description
A tree-like data structure that can be used with W(TreeView).
Signals:
sort_column_changed
-
Inherit TreeModel
GTK.TreeModel
-
Method append
object(GTK.TreeIter) GTK.refdoc.GTK.TreeStore()->append(object(GTK.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
object(GTK.TreeStore) GTK.refdoc.GTK.TreeStore()->clear()
- Description
Removes all rows.
-
Method create
object(GTK.TreeStore) GTK.refdoc.GTK.TreeStore()->create(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 drag_data_delete
int GTK.refdoc.GTK.TreeStore()->drag_data_delete(object(GTK.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
object(GTK.SelectionData) GTK.refdoc.GTK.TreeStore()->drag_data_get(object(GTK.TreePath) path)
- Description
Asks to return a representation of the row at path.
-
Method drag_data_received
int GTK.refdoc.GTK.TreeStore()->drag_data_received(object(GTK.TreePath) path, object(GTK.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 get_sort_column_id
mapping GTK.refdoc.GTK.TreeStore()->get_sort_column_id()
- Description
Returns ([ "column": int, "order": int ])
-
Method has_default_sort_func
int GTK.refdoc.GTK.TreeStore()->has_default_sort_func()
- Description
Returns true if the model has a default sort function.
-
Method insert
object(GTK.TreeIter) GTK.refdoc.GTK.TreeStore()->insert(object(GTK.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
object(GTK.TreeIter) GTK.refdoc.GTK.TreeStore()->insert_after(object(GTK.TreeIter) parent, object(GTK.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
object(GTK.TreeIter) GTK.refdoc.GTK.TreeStore()->insert_before(object(GTK.TreeIter) parent, object(GTK.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 GTK.refdoc.GTK.TreeStore()->is_ancestor(object(GTK.TreeIter) iter, object(GTK.TreeIter) descendant)
- Description
Returns true if iter is an ancestor of descendant.
-
Method iter_depth
int GTK.refdoc.GTK.TreeStore()->iter_depth(object(GTK.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 prepend
object(GTK.TreeIter) GTK.refdoc.GTK.TreeStore()->prepend(object(GTK.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
int GTK.refdoc.GTK.TreeStore()->remove(object(GTK.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 row_draggable
int GTK.refdoc.GTK.TreeStore()->row_draggable(object(GTK.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.
-
Method row_drop_possible
int GTK.refdoc.GTK.TreeStore()->row_drop_possible(object(GTK.TreePath) path, object(GTK.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.
-
Method set_default_sort_func
object(GTK.TreeStore) GTK.refdoc.GTK.TreeStore()->set_default_sort_func(function 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
GTK.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
GTK.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.
-
Method set_row
object(GTK.TreeStore) GTK.refdoc.GTK.TreeStore()->set_row(object(GTK.TreeIter) iter, array values)
- Description
Set the data in an entire row.
-
Method set_sort_column_id
object(GTK.TreeStore) GTK.refdoc.GTK.TreeStore()->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 GTK.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the default
sort function will be used, if it is set.
-
Method set_sort_func
object(GTK.TreeStore) GTK.refdoc.GTK.TreeStore()->set_sort_func(int column, function 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 set_value
object(GTK.TreeStore) GTK.refdoc.GTK.TreeStore()->set_value(object(GTK.TreeIter) iter, int column, mixed value)
- Description
Set the data in the cell specified by iter and column.
-
Method sort_column_changed
object(GTK.TreeStore) GTK.refdoc.GTK.TreeStore()->sort_column_changed()
- Description
Emits a "sort-column-changed" signal.
|
| CLASS GTK.refdoc.GTK.ImageMenuItem |
Methods
create()
get_image()
set_image()
|
- Description
Properties:
GTK.Widget image
-
Inherit MenuItem
GTK.MenuItem
-
Method create
object(GTK.ImageMenuItem) GTK.refdoc.GTK.ImageMenuItem()->create(string|void label)
- Description
Create a new ImageMenuItem.
-
Method get_image
object(GTK.Widget) GTK.refdoc.GTK.ImageMenuItem()->get_image()
- Description
Gets the widget that is currently set as the image.
-
Method set_image
object(GTK.ImageMenuItem) GTK.refdoc.GTK.ImageMenuItem()->set_image(object(GTK.Widget) image)
- Description
Sets the image of the image menu item.
|
| CLASS GTK.refdoc.GTK.ListStore |
Methods
append()
clear()
create()
drag_data_delete()
drag_data_get()
drag_data_received()
get_sort_column_id()
has_default_sort_func()
insert()
insert_after()
insert_before()
prepend()
remove()
row_draggable()
row_drop_possible()
set_default_sort_func()
set_row()
set_sort_column_id()
set_sort_func()
set_value()
sort_column_changed()
|
- Description
A list-like data structure that can be used with W(TreeView).
Signals:
sort_column_changed
-
Inherit TreeModel
GTK.TreeModel
-
Method append
object(GTK.TreeIter) GTK.refdoc.GTK.ListStore()->append()
- Description
Append a new row.
-
Method clear
object(GTK.ListStore) GTK.refdoc.GTK.ListStore()->clear()
- Description
Removes all rows.
-
Method create
object(GTK.ListStore) GTK.refdoc.GTK.ListStore()->create(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 drag_data_delete
int GTK.refdoc.GTK.ListStore()->drag_data_delete(object(GTK.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
object(GTK.SelectionData) GTK.refdoc.GTK.ListStore()->drag_data_get(object(GTK.TreePath) path)
- Description
Asks to return a representation of the row at path.
-
Method drag_data_received
int GTK.refdoc.GTK.ListStore()->drag_data_received(object(GTK.TreePath) path, object(GTK.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 get_sort_column_id
mapping GTK.refdoc.GTK.ListStore()->get_sort_column_id()
- Description
Returns ([ "column": int, "order": int ])
-
Method has_default_sort_func
int GTK.refdoc.GTK.ListStore()->has_default_sort_func()
- Description
Returns true if the model has a default sort function.
-
Method insert
object(GTK.TreeIter) GTK.refdoc.GTK.ListStore()->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
object(GTK.TreeIter) GTK.refdoc.GTK.ListStore()->insert_after(object(GTK.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
object(GTK.TreeIter) GTK.refdoc.GTK.ListStore()->insert_before(object(GTK.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 prepend
object(GTK.TreeIter) GTK.refdoc.GTK.ListStore()->prepend()
- Description
Prepend a new row.
-
Method remove
int GTK.refdoc.GTK.ListStore()->remove(object(GTK.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 row_draggable
int GTK.refdoc.GTK.ListStore()->row_draggable(object(GTK.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.
-
Method row_drop_possible
int GTK.refdoc.GTK.ListStore()->row_drop_possible(object(GTK.TreePath) path, object(GTK.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.
-
Method set_default_sort_func
object(GTK.ListStore) GTK.refdoc.GTK.ListStore()->set_default_sort_func(function 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
GTK.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
GTK.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.
-
Method set_row
object(GTK.ListStore) GTK.refdoc.GTK.ListStore()->set_row(object(GTK.TreeIter) iter, array values)
- Description
Set the data in an entire row.
-
Method set_sort_column_id
object(GTK.ListStore) GTK.refdoc.GTK.ListStore()->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 GTK.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the default
sort function will be used, if it is set.
-
Method set_sort_func
object(GTK.ListStore) GTK.refdoc.GTK.ListStore()->set_sort_func(int column, function 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 set_value
object(GTK.ListStore) GTK.refdoc.GTK.ListStore()->set_value(object(GTK.TreeIter) iter, int column, mixed value)
- Description
Set the data in the cell specified by iter and column.
-
Method sort_column_changed
object(GTK.ListStore) GTK.refdoc.GTK.ListStore()->sort_column_changed()
- Description
Emits a "sort-column-changed" signal.
|
| CLASS GTK.refdoc.GTK.FontSelectionDialog |
Methods
create()
get_apply_button()
get_cancel_button()
get_font_name()
get_ok_button()
get_preview_text()
set_font_name()
set_preview_text()
|
- 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().
GTK.FontSelectionDialog("Select a font")
../images/gtk_fontselectiondialog.png
-
Inherit Dialog
GTK.Dialog
-
Method create
object(GTK.FontSelectionDialog) GTK.refdoc.GTK.FontSelectionDialog()->create(string title)
- Description
Create a new font selection dialog with the specified window title
-
Method get_apply_button
object(GTK.Button) GTK.refdoc.GTK.FontSelectionDialog()->get_apply_button()
- Description
The apply button
-
Method get_cancel_button
object(GTK.Button) GTK.refdoc.GTK.FontSelectionDialog()->get_cancel_button()
- Description
The cancel button
-
Method get_font_name
string GTK.refdoc.GTK.FontSelectionDialog()->get_font_name()
- Description
Gets the currently-selected font name.
-
Method get_ok_button
object(GTK.Button) GTK.refdoc.GTK.FontSelectionDialog()->get_ok_button()
- Description
The ok button
-
Method get_preview_text
string GTK.refdoc.GTK.FontSelectionDialog()->get_preview_text()
- Description
Gets the text displayed in the preview area.
-
Method set_font_name
int GTK.refdoc.GTK.FontSelectionDialog()->set_font_name(string font)
- Description
Sets the currently-selected font.
-
Method set_preview_text
object(GTK.FontSelectionDialog) GTK.refdoc.GTK.FontSelectionDialog()->set_preview_text(string text)
- Description
Sets the text displayed in the preview area.
|
| CLASS GTK.refdoc.GTK.Widget |
Methods
activate()
add_accelerator()
child_notify()
class_path()
freeze_child_notify()
get_composite_name()
get_direction()
get_modifier_style()
get_name()
get_parent()
get_parent_window()
grab_default()
grab_focus()
hide()
hide_all()
hide_on_delete()
is_focus()
modify_base()
modify_bg()
modify_fg()
modify_style()
modify_text()
path()
queue_draw()
queue_draw_area()
remove_accelerator()
render_icon()
set_accel_path()
set_direction()
set_name()
set_scroll_adjustments()
set_sensitive()
set_size_request()
shape_combine_mask()
show()
show_all()
style_get_property()
thaw_child_notify()
|
- Description
The basic widget, inherited (directly or indirectly) by all
widgets. Thus, all functions and signals defined in this widget
works on all widgets.
One of the most important functions in this class is 'show',
it lets GTK 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 show using the show() function.
Properties:
int app-paintable
int can-default
int can-focus
int composite-child
int events (GdkEventMask)
int extension-events GDK_EXTENSION_EVENTS_ALL, GDK_EXTENSION_EVENTS_CURSOR and GDK_EXTENSION_EVENTS_NONE
int has-default
int has-focus
int height-request
int is-focus
string name
int no-show-all
GTK.Container parent
int receives-default
int sensitive
GTK.Style style
int visible
int width-request
Style Properties:
float cursor-aspect-ratio
GDK.Color cursor-color
string focus-line-pattern
int focus-line-width
int focus-padding
int interior-focus
GDK.Color secondary-cursor-color
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
configure_event
The size, position or stacking order of the widget has changed
delete_event
Called when the user has request 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_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
Called 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_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
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
realize
Called when the widget is realize. 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
NYI
selection_get
NYI
selection_notify_event
NYI
selection_received
NYI
selection_request_event
NYI
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
GTK.Object
-
Method activate
int GTK.refdoc.GTK.Widget()->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
object(GTK.Widget) GTK.refdoc.GTK.Widget()->add_accelerator(string accel_signal, object(GTK.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 child_notify
object(GTK.Widget) GTK.refdoc.GTK.Widget()->child_notify(string prop)
- Description
Emits a "child-notify" signal for the child property prop.
-
Method class_path
string GTK.refdoc.GTK.Widget()->class_path()
- Description
Same as path() but uses type rather than name.
-
Method freeze_child_notify
object(GTK.Widget) GTK.refdoc.GTK.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_composite_name
string GTK.refdoc.GTK.Widget()->get_composite_name()
- Description
Get the composite name.
-
Method get_direction
int GTK.refdoc.GTK.Widget()->get_direction()
- Description
Gets the reading direction.
-
Method get_modifier_style
object(GTK.RcStyle) GTK.refdoc.GTK.Widget()->get_modifier_style()
- Description
Returns the current modifier style.
-
Method get_name
string GTK.refdoc.GTK.Widget()->get_name()
- Description
Retrieves the name.
-
Method get_parent
object(GTK.Widget) GTK.refdoc.GTK.Widget()->get_parent()
- Description
Returns the parent container.
-
Method get_parent_window
object(GDK.Window) GTK.refdoc.GTK.Widget()->get_parent_window()
- Description
Get the parent window.
-
Method grab_default
object(GTK.Widget) GTK.refdoc.GTK.Widget()->grab_default()
- Description
Causes this widget to become the default widget.
-
Method grab_focus
object(GTK.Widget) GTK.refdoc.GTK.Widget()->grab_focus()
- Description
Causes this widget to have the keyboard focus. This widget must be a
focusable widget, such as a GTK.Entry; something like GTK.Frame won't
work.
-
Method hide
object(GTK.Widget) GTK.refdoc.GTK.Widget()->hide()
- Description
Hide the widget.
-
Method hide_all
object(GTK.Widget) GTK.refdoc.GTK.Widget()->hide_all()
- Description
Hide this widget, and all child widgets.
-
Method hide_on_delete
int GTK.refdoc.GTK.Widget()->hide_on_delete()
- Description
Utility function
-
Method is_focus
int GTK.refdoc.GTK.Widget()->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 modify_base
object(GTK.Widget) GTK.refdoc.GTK.Widget()->modify_base(int state, object(GDK.Color) color)
- Description
Sets the base color of the widget in a particular state.
See modify_fg().
-
Method modify_bg
object(GTK.Widget) GTK.refdoc.GTK.Widget()->modify_bg(int state, object(GDK.Color) color)
- Description
Sets the background color of the widget in a particular state.
See modify_fg().
-
Method modify_fg
object(GTK.Widget) GTK.refdoc.GTK.Widget()->modify_fg(int state, object(GDK.Color) 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_style
object(GTK.Widget) GTK.refdoc.GTK.Widget()->modify_style(object(GTK.RcStyle) style)
- Description
Modifies style values.
-
Method modify_text
object(GTK.Widget) GTK.refdoc.GTK.Widget()->modify_text(int state, object(GDK.Color) color)
- Description
Sets the text color of the widget in a particular state.
See modify_fg().
-
Method path
string GTK.refdoc.GTK.Widget()->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
object(GTK.Widget) GTK.refdoc.GTK.Widget()->queue_draw()
- Description
Equivalent to calling queue_draw_area() for the entire area of the widget.
-
Method queue_draw_area
object(GTK.Widget) GTK.refdoc.GTK.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
GDK.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 remove_accelerator
int GTK.refdoc.GTK.Widget()->remove_accelerator(object(GTK.AccelGroup) accel_group, int accel_key, int accel_mods)
- Description
Removes an accelerator.
-
Method render_icon
object(GDK.Pixbuf) GTK.refdoc.GTK.Widget()->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 GTK.STOCK_OPEN or GTK.STOCK_OK. size should be a
size such as GTK.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 GDK.Pixbuf are shared with the rest of the
application and should not be modified.
-
Method set_accel_path
object(GTK.Widget) GTK.refdoc.GTK.Widget()->set_accel_path(string accel_path, object(GTK.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_direction
object(GTK.Widget) GTK.refdoc.GTK.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_name
object(GTK.Widget) GTK.refdoc.GTK.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_scroll_adjustments
object(GTK.Widget) GTK.refdoc.GTK.Widget()->set_scroll_adjustments(object(GTK.Adjustment) hadj, object(GTK.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
object(GTK.Widget) GTK.refdoc.GTK.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
object(GTK.Widget) GTK.refdoc.GTK.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 shape_combine_mask
object(GTK.Widget) GTK.refdoc.GTK.Widget()->shape_combine_mask(object(GDK.Bitmap) shape_mask, int offset_x, int offset_y)
- Description
Sets a shape for a widget's GDK.Window. This allows for transparent
window, etc.
-
Method show
object(GTK.Widget) GTK.refdoc.GTK.Widget()->show()
- Description
Show the widget. Most (almost all) widgets must be shown to be
visible on the screen.
-
Method show_all
object(GTK.Widget) GTK.refdoc.GTK.Widget()->show_all()
- Description
Show this widget, and all child widgets.
-
Method style_get_property
mixed GTK.refdoc.GTK.Widget()->style_get_property(string name)
- Description
Gets the value of the style property called name.
-
Method thaw_child_notify
object(GTK.Widget) GTK.refdoc.GTK.Widget()->thaw_child_notify()
- Description
Reverts the effect of a previous call to freeze_child_notify().
|
| CLASS GTK.refdoc.GTK.ScrolledWindow |
Methods
add()
create()
get_hadjustment()
get_placement()
get_policy()
get_shadow_type()
get_vadjustment()
set_hadjustment()
set_placement()
set_policy()
set_shadow_type()
set_vadjustment()
|
- Description
Scrolled windows are used to create a scrollable area with another
widget insite it. You may insert any type of widget into a scrolled
window, and it will be accessible regardless of the size by using
the scrollbars.
GTK.ScrolledWindow(GTK.Adjustment(),GTK.Adjustment())->add(GTK.Label("A small label"))->set_policy(GTK.POLICY_AUTOMATIC,GTK.POLICY_AUTOMATIC)
../images/gtk_scrolledwindow.png
GTK.ScrolledWindow(GTK.Adjustment(),GTK.Adjustment())->add(GTK.Label("A small label"))->set_policy(GTK.POLICY_AUTOMATIC,GTK.POLICY_AUTOMATIC)
../images/gtk_scrolledwindow_2.png
GTK.ScrolledWindow(GTK.Adjustment(),GTK.Adjustment())->add(GTK.Label("A small label"))
../images/gtk_scrolledwindow_3.png
GTK.ScrolledWindow(GTK.Adjustment(),GTK.Adjustment())->add(GTK.Label("a ver huge label"))
../images/gtk_scrolledwindow_4.png
Properties:
GTK.Adjustment hadjustment
int hscrollbar-policy
int shadow-type
GTK.Adjustment vadjustment
int vscrollbar-policy
int window-placement
Style properties:
int scrollbar-spacing
Signals:
move_focus_out
scroll_child
-
Inherit Bin
GTK.Bin
-
Method add
object(GTK.ScrolledWindow) GTK.refdoc.GTK.ScrolledWindow()->add(object(GTK.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
object(GTK.ScrolledWindow) GTK.refdoc.GTK.ScrolledWindow()->create(object(GTK.Adjustment) hadjustment, object(GTK.Adjustment) vadjustments)
- Description
The two adjustments are most commonly set to 0.
-
Method get_hadjustment
object(GTK.Adjustment) GTK.refdoc.GTK.ScrolledWindow()->get_hadjustment()
- Description
Get the horizontal adjustment.
-
Method get_placement
int GTK.refdoc.GTK.ScrolledWindow()->get_placement()
- Description
Gets the placement of the scrollbars.
-
Method get_policy
mapping GTK.refdoc.GTK.ScrolledWindow()->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 GTK.refdoc.GTK.ScrolledWindow()->get_shadow_type()
- Description
Gets the shadow type.
-
Method get_vadjustment
object(GTK.Adjustment) GTK.refdoc.GTK.ScrolledWindow()->get_vadjustment()
- Description
Get the vertical adjustment.
-
Method set_hadjustment
object(GTK.ScrolledWindow) GTK.refdoc.GTK.ScrolledWindow()->set_hadjustment(object(GTK.Adjustment) hadjustment)
- Description
Set the horizontal adjustment object.
-
Method set_placement
object(GTK.ScrolledWindow) GTK.refdoc.GTK.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
object(GTK.ScrolledWindow) GTK.refdoc.GTK.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
object(GTK.ScrolledWindow) GTK.refdoc.GTK.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
object(GTK.ScrolledWindow) GTK.refdoc.GTK.ScrolledWindow()->set_vadjustment(object(GTK.Adjustment) vadjustment)
- Description
Set the vertical adjustment object.
|
| CLASS GTK.refdoc.GTK.RadioButton |
Methods
create()
get_group()
set_group()
|
- 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 GTK.RadioButton().
GTK.Radio_button("Button");
../images/gtk_radiobutton.png
Properties:
GTK.RadioButton group
Signals:
group_changed
-
Inherit CheckButton
GTK.CheckButton
-
Method create
object(GTK.RadioButton) GTK.refdoc.GTK.RadioButton()->create(string|void title, object(GTK.RadioButton) groupmember)
- Description
Normal creation:
object GTK.RadioButton(string title) - First button (with label)
object GTK.RadioButton()->add(widget) - First button (with widget)
object GTK.RadioButton(title, another_radio_button) - Second to n:th button (with title)
object GTK.RadioButton(0,another_radio_button)->add(widget) - Second to n:th button (with widget)
-
Method get_group
array GTK.refdoc.GTK.RadioButton()->get_group()
- Description
Returns an array of members in this group.
-
Method set_group
object(GTK.RadioButton) GTK.refdoc.GTK.RadioButton()->set_group(object(GTK.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 GTK.refdoc.GTK.Viewport |
Methods
create()
get_hadjustment()
get_shadow_type()
get_vadjustment()
set_hadjustment()
set_shadow_type()
set_vadjustment()
|
- 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.
GTK.Viewport(GTK.Adjustment(),GTK.Adjustment())->set_size_request(100,100)
../images/gtk_viewport.png
GTK.Viewport(GTK.Adjustment(),GTK.Adjustment())->set_size_request(100,100)->set_shadow_type(GTK.SHADOW_ETCHED_IN)
../images/gtk_viewport_2.png
GTK.Viewport(GTK.Adjustment(),GTK.Adjustment())->set_size_request(100,100)->add(GTK.Label("A label with a very long text on it, it will not fit"))->set_shadow_type(GTK.SHADOW_ETCHED_IN)
../images/gtk_viewport_3.png
lambda(){ object a1;object v = GTK.Viewport(a1=GTK.Adjustment(),GTK.Adjustment())->set_size_request(100,100)->add(GTK.Label("A label with a very long text on it, it will not fit"))->set_shadow_type(GTK.SHADOW_ETCHED_IN);call_out(a1->set_value,0,100.0);return v;}()
../images/gtk_viewport_4.png
Properties:
GTK.Adjustment hadjustment
int shadow-type
GTK.Adjustment vadjustment
Signals:
set_scroll_adjustments
-
Inherit Bin
GTK.Bin
-
Method create
object(GTK.Viewport) GTK.refdoc.GTK.Viewport()->create(object(GTK.Adjustment) xscroll, object(GTK.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
object(GTK.Adjustment) GTK.refdoc.GTK.Viewport()->get_hadjustment()
- Description
Return the current horizontal adjustment object
-
Method get_shadow_type
int GTK.refdoc.GTK.Viewport()->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
object(GTK.Adjustment) GTK.refdoc.GTK.Viewport()->get_vadjustment()
- Description
Return the current vertical adjustment object
-
Method set_hadjustment
object(GTK.Viewport) GTK.refdoc.GTK.Viewport()->set_hadjustment(object(GTK.Adjustment) xscroll)
- Description
Set a new horizontal adjustment object.
-
Method set_shadow_type
object(GTK.Viewport) GTK.refdoc.GTK.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
object(GTK.Viewport) GTK.refdoc.GTK.Viewport()->set_vadjustment(object(GTK.Adjustment) yscroll)
- Description
Set a new vertical adjustment object.
|
| CLASS GTK.refdoc.GTK.Style |
Methods
attach()
copy()
create()
detach()
lookup_icon_set()
paint_arrow()
paint_box()
paint_box_gap()
paint_check()
paint_diamond()
paint_expander()
paint_extension()
paint_flat_box()
paint_focus()
paint_handle()
paint_hline()
paint_layout()
paint_option()
paint_resize_grip()
paint_shadow()
paint_shadow_gap()
paint_slider()
paint_tab()
paint_vline()
render_icon()
set_background()
|
- Description
Style settings.
Signals:
realize
unrealize
-
Inherit Object
G.Object
-
Method attach
object(GTK.Style) GTK.refdoc.GTK.Style()->attach(object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->copy()
- Description
Copy a style.
-
Method create
object(GTK.Style) GTK.refdoc.GTK.Style()->create()
- Description
Creates a new style.
-
Method detach
object(GTK.Style) GTK.refdoc.GTK.Style()->detach()
- Description
Detach a style.
-
Method lookup_icon_set
object(GTK.IconSet) GTK.refdoc.GTK.Style()->lookup_icon_set(string stock_id)
- Description
Lookup the icon set.
-
Method paint_arrow
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_arrow(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_box(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_box_gap(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_check(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_diamond(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_expander(object(GTK.Widget) window, int state, object(GDK.Rectangle) rect, object(GTK.Widget) widget, string detail, int x, int y, int style)
- Description
Draws an expander as used in GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_extension(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_flat_box(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.Widget) widget, string detail, int x, int y, int width, int height)
- Description
Draws a flat box on window.
-
Method paint_focus
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_focus(object(GTK.Widget) window, int state, object(GDK.Rectangle) rect, object(GTK.Widget) widget, string detail, int x, int y, int width, int height)
- Description
Draws a focus indicator around the given rectangle.
-
Method paint_handle
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_handle(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.Widget) widget, string detail, int x, int y, int width, int height, int orientation)
- Description
Draws a handle as used in GTK.HandleBox and GTK.Paned.
-
Method paint_hline
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_hline(object(GTK.Widget) window, int state, object(GDK.Rectangle) rect, object(GTK.Widget) widget, string detail, int x1, int x2, int y)
- Description
Draws a horizontal line from (x1,y) to (x2,y).
-
Method paint_layout
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_layout(object(GTK.Widget) window, int state, int use_text, object(GDK.Rectangle) rect, object(GTK.Widget) widget, string detail, int x, int y, object(Pango.Layout) layout)
- Description
Draw a pango layout. Use widget->create_pango_layout() to get a
Pango.Layout.
-
Method paint_option
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_option(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_resize_grip(object(GTK.Widget) window, int state, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_shadow(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.Widget) widget, string detail, int x, int y, int width, int height)
- Description
Draws a shadow around the given rectangle.
-
Method paint_shadow_gap
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_shadow_gap(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_slider(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.Widget) widget, string detail, int x, int y, int width, int height, int orientation)
- Description
Paint a slider.
-
Method paint_tab
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_tab(object(GTK.Widget) window, int state, int shadow, object(GDK.Rectangle) rect, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->paint_vline(object(GTK.Widget) window, int state, object(GDK.Rectangle) rect, object(GTK.Widget) widget, string detail, int y1, int y2, int x)
- Description
Draws a vertical line from (x,y1) to (x,y2).
-
Method render_icon
object(GDK.Pixbuf) GTK.refdoc.GTK.Style()->render_icon(object(GTK.IconSource) source, int direction, int state, int size, object(GTK.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
object(GTK.Style) GTK.refdoc.GTK.Style()->set_background(object(GTK.Widget) window, int state)
- Description
Sets the background of window to the background color or pixmap specified
by style for the given state.
|
| CLASS GTK.refdoc.GTK.Button |
Methods
clicked()
create()
enter()
get_label()
get_relief()
get_use_stock()
get_use_underline()
leave()
pressed()
released()
set_label()
set_relief()
set_use_stock()
set_use_underline()
|
- Description
A container that can only contain one child, and accepts events.
draws a bevelbox around itself.
GTK.Button("A button")
../images/gtk_button.png
GTK.Button("A button\nwith multiple lines\nof text")
../images/gtk_button_2.png
GTK.Button()->add(GTK.Image(GDK.Image(0)->set(Image.image(100,40)->test())))
../images/gtk_button_3.png
Properties:
int focus-on-click
GTK.Widget image
string label
int relief
int use-stock
int use-underline
Style properties:
int child-displacement-x
int child-displacement-y
GTK.Border default-border
GTK.Border default-outside-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 Bin
GTK.Bin
-
Method clicked
object(GTK.Button) GTK.refdoc.GTK.Button()->clicked()
- Description
Emulate a 'clicked' event (press followed by release).
-
Method create
object(GTK.Button) GTK.refdoc.GTK.Button()->create(string|void label_text)
- Description
If a string is supplied, a W(Label) is created and added to the button.
-
Method enter
object(GTK.Button) GTK.refdoc.GTK.Button()->enter()
- Description
Emulate a 'enter' event.
-
Method get_label
string GTK.refdoc.GTK.Button()->get_label()
- Description
Get the text from the label of the button.
-
Method get_relief
int GTK.refdoc.GTK.Button()->get_relief()
- Description
One of RELIEF_HALF, RELIEF_NONE and RELIEF_NORMAL, set with set_relief()
-
Method get_use_stock
int GTK.refdoc.GTK.Button()->get_use_stock()
- Description
Returns whether the button label is a stock item.
-
Method get_use_underline
int GTK.refdoc.GTK.Button()->get_use_underline()
- Description
Returns whether an embedded underline in the button indicates
a mnemonic.
-
Method leave
object(GTK.Button) GTK.refdoc.GTK.Button()->leave()
- Description
Emulate a 'leave' event.
-
Method pressed
object(GTK.Button) GTK.refdoc.GTK.Button()->pressed()
- Description
Emulate a 'press' event.
-
Method released
object(GTK.Button) GTK.refdoc.GTK.Button()->released()
- Description
Emulate a 'release' event.
-
Method set_label
object(GTK.Button) GTK.refdoc.GTK.Button()->set_label(string label)
- Description
Set the text of the label.
-
Method set_relief
object(GTK.Button) GTK.refdoc.GTK.Button()->set_relief(int newstyle)
- Description
One of RELIEF_HALF, RELIEF_NONE and RELIEF_NORMAL
-
Method set_use_stock
object(GTK.Button) GTK.refdoc.GTK.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
object(GTK.Button) GTK.refdoc.GTK.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 GTK.refdoc.GTK.Fixed |
Methods
create()
get_children()
get_has_window()
move()
put()
set_has_window()
|
- 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:
GTK.Fixed()->put(GTK.Label("100,100"), 100, 100)->put(GTK.Label("0,0"), 0, 0)->set_size_request(150,115)
../images/gtk_fixed.png
Child properties:
int x
int y
-
Inherit Container
GTK.Container
-
Method create
object(GTK.Fixed) GTK.refdoc.GTK.Fixed()->create()
- Description
Create a new fixed widget
-
Method get_children
array GTK.refdoc.GTK.Fixed()->get_children()
- Description
Get a list of the children and their x,y positions.
-
Method get_has_window
int GTK.refdoc.GTK.Fixed()->get_has_window()
- Description
Gets whether GTK.Fixed has its own GDK.Window.
-
Method move
object(GTK.Fixed) GTK.refdoc.GTK.Fixed()->move(object(GTK.Widget) widget, int new_xpos, int new_ypos)
- Description
Move the widget to new_xpos,new_ypos from it's old location.
-
Method put
object(GTK.Fixed) GTK.refdoc.GTK.Fixed()->put(object(GTK.Widget) widget, int x, int y)
- Description
Place the widget at xpos,ypos.
-
Method set_has_window
object(GTK.Fixed) GTK.refdoc.GTK.Fixed()->set_has_window(int has_window)
- Description
Sets wither a GTK.Fixed widget is created with a separate
GDK.Window for the window or now.
|
| CLASS GTK.refdoc.GTK.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
GTK.Range
|
| CLASS GTK.refdoc.GTK.Settings |
Methods
create()
|
- Description
Properties:
int gtk-alternative-button-order
int gtk-button-images
int gtk-can-change-accels
string gtk-color-palette
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-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-xft-antialias
int gtk-xft-dpi
int gtk-xft-hinting
string gtk-xft-hintstyle
string gtk-xft-rgba
-
Inherit Object
G.Object
-
Method create
object(GTK.Settings) GTK.refdoc.GTK.Settings()->create()
- Description
Get the default GTK.Settings object
|
| CLASS GTK.refdoc.GTK.Container |
Methods
add()
check_resize()
child_set_property()
get_border_width()
get_children()
get_focus_hadjustment()
get_focus_vadjustment()
get_resize_mode()
remove()
resize_children()
set_border_width()
set_focus_child()
set_focus_hadjustment()
set_focus_vadjustment()
set_reallocate_redraws()
set_resize_mode()
|
- Description
The basic container class.
Properties:
int border-width
GTK.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
GTK.Widget
-
Method add
object(GTK.Container) GTK.refdoc.GTK.Container()->add(object(GTK.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
object(GTK.Container) GTK.refdoc.GTK.Container()->check_resize()
- Description
Undocumented
-
Method child_set_property
object(GTK.Container) GTK.refdoc.GTK.Container()->child_set_property(object(GTK.Widget) child, string property, mixed value)
- Description
Set child property.
-
Method get_border_width
int GTK.refdoc.GTK.Container()->get_border_width()
- Description
Retrieves the border width.
-
Method get_children
array GTK.refdoc.GTK.Container()->get_children()
- Description
This function returns all children of the container
as an array.
-
Method get_focus_hadjustment
object(GTK.Adjustment) GTK.refdoc.GTK.Container()->get_focus_hadjustment()
- Description
Retrieves the horizontal focus adjustment.
-
Method get_focus_vadjustment
object(GTK.Adjustment) GTK.refdoc.GTK.Container()->get_focus_vadjustment()
- Description
Retrieves the vertical focus adjustment.
-
Method get_resize_mode
int GTK.refdoc.GTK.Container()->get_resize_mode()
- Description
Returns the resize mode.
-
Method remove
object(GTK.Container) GTK.refdoc.GTK.Container()->remove(object(GTK.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
object(GTK.Container) GTK.refdoc.GTK.Container()->resize_children()
- Description
Undocumented.
-
Method set_border_width
object(GTK.Container) GTK.refdoc.GTK.Container()->set_border_width(int width)
- Description
Sets the border width.
-
Method set_focus_child
object(GTK.Container) GTK.refdoc.GTK.Container()->set_focus_child(object(GTK.Widget) child)
- Description
Emulate a set_focus_child signal. Focus on the specified child.
-
Method set_focus_hadjustment
object(GTK.Container) GTK.refdoc.GTK.Container()->set_focus_hadjustment(object(GTK.Adjustment) adj)
- Description
Set the hadjustment used to focus children.
-
Method set_focus_vadjustment
object(GTK.Container) GTK.refdoc.GTK.Container()->set_focus_vadjustment(object(GTK.Adjustment) adj)
- Description
Set the vadjustment used to focus children.
-
Method set_reallocate_redraws
object(GTK.Container) GTK.refdoc.GTK.Container()->set_reallocate_redraws(int setting)
- Description
Sets the reallocate_redraws flag.
-
Method set_resize_mode
object(GTK.Container) GTK.refdoc.GTK.Container()->set_resize_mode(int mode)
- Description
One of RESIZE_IMMEDIATE, RESIZE_PARENT and RESIZE_QUEUE
|
| CLASS GTK.refdoc.GTK.ColorSelection |
Methods
create()
get_current_alpha()
get_current_color()
get_has_opacity_control()
get_has_palette()
get_previous_alpha()
get_previous_color()
is_adjusting()
set_current_alpha()
set_current_color()
set_has_opacity_control()
set_has_palette()
set_previous_alpha()
set_previous_color()
|
- 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().
GTK.ColorSelection()
../images/gtk_colorselection.png
Properties:
int current-alpha
GDK.Color current-color
int has-opacity-control
int has-palette
Signals:
color_changed
-
Inherit Vbox
GTK.Vbox
-
Method create
object(GTK.ColorSelection) GTK.refdoc.GTK.ColorSelection()->create()
- Description
Create a new color selection.
-
Method get_current_alpha
int GTK.refdoc.GTK.ColorSelection()->get_current_alpha()
- Description
Returns the current alpha value.
-
Method get_current_color
mapping GTK.refdoc.GTK.ColorSelection()->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 GTK.refdoc.GTK.ColorSelection()->get_has_opacity_control()
- Description
Determines whether the colorsel has an opacity control.
-
Method get_has_palette
int GTK.refdoc.GTK.ColorSelection()->get_has_palette()
- Description
Determines whether the color selector has a color palette.
-
Method get_previous_alpha
int GTK.refdoc.GTK.ColorSelection()->get_previous_alpha()
- Description
Returns the previous alpha value.
-
Method get_previous_color
mapping GTK.refdoc.GTK.ColorSelection()->get_previous_color()
- Description
Returns the original color value.
-
Method is_adjusting
int GTK.refdoc.GTK.ColorSelection()->is_adjusting()
- Description
Gets the current state of the colorsel.
-
Method set_current_alpha
object(GTK.ColorSelection) GTK.refdoc.GTK.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
object(GTK.ColorSelection) GTK.refdoc.GTK.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
object(GTK.ColorSelection) GTK.refdoc.GTK.ColorSelection()->set_has_opacity_control(int setting)
- Description
Sets whether or not to use opacity.
-
Method set_has_palette
object(GTK.ColorSelection) GTK.refdoc.GTK.ColorSelection()->set_has_palette(int has_palette)
- Description
Shows and hides the palette based upon the value of has_palette
-
Method set_previous_alpha
object(GTK.ColorSelection) GTK.refdoc.GTK.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
object(GTK.ColorSelection) GTK.refdoc.GTK.ColorSelection()->set_previous_color(mapping colors)
- Description
Sets the 'previous' color to be color.
|
| CLASS GTK.refdoc.GTK.AccelLabel |
Methods
create()
get_accel_widget()
get_accel_width()
refetch()
set_accel_widget()
|
- Description
A label for accelerators.
Properties:
GTK.Widget accel-widget
-
Inherit Label
GTK.Label
-
Method create
object(GTK.AccelLabel) GTK.refdoc.GTK.AccelLabel()->create(string text)
- Description
Creates a new W(AccelLabel).
-
Method get_accel_widget
object(GTK.Widget) GTK.refdoc.GTK.AccelLabel()->get_accel_widget()
- Description
Fetches the widget monitored by this accelerator label.
-
Method get_accel_width
int GTK.refdoc.GTK.AccelLabel()->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 GTK.refdoc.GTK.AccelLabel()->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
object(GTK.AccelLabel) GTK.refdoc.GTK.AccelLabel()->set_accel_widget(object(GTK.Widget) accel_widget)
- Description
Sets the widget to be monitored.
|
| CLASS GTK.refdoc.GTK.Hbox |
Methods
create()
|
- 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.
GTK.Hbox(0,0)->add(GTK.Button("Hello"))->add(GTK.Button("World"))->pack_end_defaults(GTK.Button("From right"))->pack_start_defaults(GTK.Button("From left"))
../images/gtk_hbox.png
GTK.Hbox(1,0)->add(GTK.Button("Hello"))->add(GTK.Button("World"))->pack_end_defaults(GTK.Button("From right"))->pack_start_defaults(GTK.Button("From left"))
../images/gtk_hbox_2.png
GTK.Hbox(1,40)->add(GTK.Button("Hello"))->add(GTK.Button("World"))->pack_end_defaults(GTK.Button("From right"))->pack_start_defaults(GTK.Button("From left"))
../images/gtk_hbox_3.png
-
Inherit Box
GTK.Box
-
Method create
object(GTK.Hbox) GTK.refdoc.GTK.Hbox()->create(int all_same_size, int 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 GTK.refdoc.GTK.Hscale |
Methods
create()
|
- Description
The GTK.HScale widget is used to allow the user to select a value
using a horizontal slider. A GTK.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.
GTK.Hscale(GTK.Adjustment())->set_usize(300,30)
../images/gtk_hscale.png
-
Inherit Scale
GTK.Scale
-
Method create
object(GTK.Hscale) GTK.refdoc.GTK.Hscale()->create(object(GTK.Adjustment) settings_or_min, 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 GTK.refdoc.GTK.EventBox |
Methods
create()
|
- 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 GTK 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.
GTK.EventBox()->set_size_request(100,100)
../images/gtk_eventbox.png
Properties:
int above-child
int visible-window
-
Inherit Bin
GTK.Bin
-
Method create
object(GTK.EventBox) GTK.refdoc.GTK.EventBox()->create()
- Description
Create a new event box widget
|
| CLASS GTK.refdoc.GTK.Scale |
Methods
get_digits()
get_draw_value()
get_value_pos()
set_digits()
set_draw_value()
set_value_pos()
|
- Description
The GTK.Scale widget is an abstract class, used only for deriving
the subclasses GTK.Hscale and GTK.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
GTK.Range
-
Method get_digits
int GTK.refdoc.GTK.Scale()->get_digits()
- Description
Gets the number of decimal places that are displayed.
-
Method get_draw_value
int GTK.refdoc.GTK.Scale()->get_draw_value()
- Description
Returns whether the current value is displayed as a string next to the
slider.
-
Method get_value_pos
int GTK.refdoc.GTK.Scale()->get_value_pos()
- Description
Gets the position in which the current value is displayed.
-
Method set_digits
object(GTK.Scale) GTK.refdoc.GTK.Scale()->set_digits(int precision)
- Description
Sets the number of decimal places that are displayed in the value.
-
Method set_draw_value
object(GTK.Scale) GTK.refdoc.GTK.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
object(GTK.Scale) GTK.refdoc.GTK.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 GTK.refdoc.GTK.TreeModel |
Methods
get_column_type()
get_flags()
get_iter()
get_iter_first()
get_iter_from_string()
get_n_columns()
get_path()
get_value()
iter_children()
iter_has_child()
iter_n_children()
iter_next()
iter_nth_child()
iter_parent()
row_changed()
row_deleted()
row_has_child_toggled()
row_inserted()
|
- Description
Class used for the TreeModel funtions.
Signals:
row_changed
row_deleted
row_has_child_toggled
row_inserted
rows_reordered
-
Inherit Object
G.Object
-
Method get_column_type
int GTK.refdoc.GTK.TreeModel()->get_column_type(int index)
- Description
Returns the type of the column.
-
Method get_flags
int GTK.refdoc.GTK.TreeModel()->get_flags()
- Description
Returns a set of flags supported by this interface.
-
Method get_iter
object(GTK.TreeIter) GTK.refdoc.GTK.TreeModel()->get_iter(object(GTK.TreePath) path)
- Description
Returns a valid iterator pointer to path
-
Method get_iter_first
object(GTK.TreeIter) GTK.refdoc.GTK.TreeModel()->get_iter_first()
- Description
Get GTK.TreeIter with the first iterator in the tree ("0").
-
Method get_iter_from_string
object(GTK.TreeIter) GTK.refdoc.GTK.TreeModel()->get_iter_from_string(string path)
- Description
Returns a valid iterator from a path string.
-
Method get_n_columns
int GTK.refdoc.GTK.TreeModel()->get_n_columns()
- Description
Returns the number of columns suppported by this model.
-
Method get_path
object(GTK.TreePath) GTK.refdoc.GTK.TreeModel()->get_path(object(GTK.TreeIter) iter)
- Description
Returns a GTK.TreePath from iter.
-
Method get_value
mixed GTK.refdoc.GTK.TreeModel()->get_value(object(GTK.TreeIter) iter, int column)
- Description
Get value at column of iter.
-
Method iter_children
object(GTK.TreeIter) GTK.refdoc.GTK.TreeModel()->iter_children(object(GTK.TreeIter) parent)
- Description
Get first child of parent.
-
Method iter_has_child
int GTK.refdoc.GTK.TreeModel()->iter_has_child(object(GTK.TreeIter) iter)
- Description
Check if iter has children.
-
Method iter_n_children
int GTK.refdoc.GTK.TreeModel()->iter_n_children(object(GTK.TreeIter) iter)
- Description
Returns the number of children this iter has.
-
Method iter_next
object(GTK.TreeIter) GTK.refdoc.GTK.TreeModel()->iter_next(object(GTK.TreeIter) iter)
- Description
Go to next node.
-
Method iter_nth_child
object(GTK.TreeIter) GTK.refdoc.GTK.TreeModel()->iter_nth_child(object(GTK.TreeIter) parent, int index)
- Description
Get the child of parent using the given index.
Returns valid GTK.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
object(GTK.TreeIter) GTK.refdoc.GTK.TreeModel()->iter_parent(object(GTK.TreeIter) child)
- Description
Get parent of child, or 0 if none.
-
Method row_changed
object(GTK.TreeModel) GTK.refdoc.GTK.TreeModel()->row_changed(object(GTK.TreePath) path, object(GTK.TreeIter) iter)
- Description
Emit "row-changed" signal.
-
Method row_deleted
object(GTK.TreeModel) GTK.refdoc.GTK.TreeModel()->row_deleted(object(GTK.TreePath) path)
- Description
Emit "row-deleted" signal.
-
Method row_has_child_toggled
object(GTK.TreeModel) GTK.refdoc.GTK.TreeModel()->row_has_child_toggled(object(GTK.TreePath) path, object(GTK.TreeIter) iter)
- Description
Emit "row-has-child-toggled" signal.
-
Method row_inserted
object(GTK.TreeModel) GTK.refdoc.GTK.TreeModel()->row_inserted(object(GTK.TreePath) path, object(GTK.TreeIter) iter)
- Description
Emit "row-inserted" signal.
|
| CLASS GTK.refdoc.GTK.Adjustment |
Methods
changed()
clamp_page()
create()
get_value()
set_value()
value_changed()
|
- Description
The GTK.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 GTK+ 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
GTK.Data
-
Method changed
object(GTK.Adjustment) GTK.refdoc.GTK.Adjustment()->changed()
- Description
Emites a "changed" signal.
-
Method clamp_page
object(GTK.Adjustment) GTK.refdoc.GTK.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
object(GTK.Adjustment) GTK.refdoc.GTK.Adjustment()->create(float|void value, float|void lower, float|void upper, float|void step_increment, float|void page_increment, float|void page_size)
- Description
The value argument is the initial value you want to give to the
adjustment, usually corresponding to the topmost or leftmost
position of an adjustable widget. The lower argument specifies the
lowest value which the adjustment can hold. The step_increment
argument specifies the "smaller" of the two increments by which
the user can change the value, while the page_increment is the
"larger" one. The page_size argument usually corresponds somehow
to the visible area of a panning widget. The upper argument is
used to represent the bottom most or right most coordinate in a
panning widget's child. Therefore it is not always the largest
number that value can take, since the page_size of such widgets is
usually non-zero.
All values are optional, they default to 0.0.
For most widgets the unit is pixels.
-
Method get_value
float GTK.refdoc.GTK.Adjustment()->get_value()
- Description
Gets the current value.
-
Method set_value
object(GTK.Adjustment) GTK.refdoc.GTK.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
object(GTK.Adjustment) GTK.refdoc.GTK.Adjustment()->value_changed()
- Description
Emits a "value-changed" signal.
|
| CLASS GTK.refdoc.GTK.CheckMenuItem |
Methods
create()
get_active()
get_inconsistent()
set_active()
set_inconsistent()
toggled()
|
- Description
A check menu item is more or less identical to a check button, but it
should be used in menus.
GTK.CheckMenuItem("Hi there")
../images/gtk_checkmenuitem.png
GTK.CheckMenuItem("Hi there")->set_active(1)
../images/gtk_checkmenuitem_2.png
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
GTK.MenuItem
-
Method create
object(GTK.CheckMenuItem) GTK.refdoc.GTK.CheckMenuItem()->create(string|void label)
- 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 GTK.refdoc.GTK.CheckMenuItem()->get_active()
- Description
Get whether item is active.
-
Method get_inconsistent
int GTK.refdoc.GTK.CheckMenuItem()->get_inconsistent()
- Description
Retrieves the value set by set_inconsistent().
-
Method set_active
object(GTK.CheckMenuItem) GTK.refdoc.GTK.CheckMenuItem()->set_active(int new_state)
- Description
State is either 1 or 0. If 1, the button will be 'pressed'.
-
Method set_inconsistent
object(GTK.CheckMenuItem) GTK.refdoc.GTK.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
object(GTK.CheckMenuItem) GTK.refdoc.GTK.CheckMenuItem()->toggled()
- Description
Emulate a toggled event
|
| CLASS GTK.refdoc.GTK.Calendar |
Methods
clear_marks()
create()
freeze()
get_date()
get_display_options()
get_marked_dates()
mark_day()
select_day()
select_month()
set_display_options()
thaw()
unmark_day()
|
- Description
A calendar widget.
GTK.Calendar();
../images/gtk_calendar.png
GTK.Calendar()->select_day( 16 );
../images/gtk_calendar_2.png
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
GTK.Widget
-
Method clear_marks
object(GTK.Calendar) GTK.refdoc.GTK.Calendar()->clear_marks()
- Description
Remove all day markers
-
Method create
object(GTK.Calendar) GTK.refdoc.GTK.Calendar()->create()
- Description
Create a new calendar widget
-
Method freeze
object(GTK.Calendar) GTK.refdoc.GTK.Calendar()->freeze()
- Description
Suspend all dynamic updating of the widget
-
Method get_date
mapping GTK.refdoc.GTK.Calendar()->get_date()
- Description
returns a mapping:
([ "year":year, "month":month, "day":day ])
-
Method get_display_options
int GTK.refdoc.GTK.Calendar()->get_display_options()
- Description
Returns the current display options.
-
Method get_marked_dates
array GTK.refdoc.GTK.Calendar()->get_marked_dates()
- Description
Returns an array (with 31 elements) with 1es and 0es.
-
Method mark_day
object(GTK.Calendar) GTK.refdoc.GTK.Calendar()->mark_day(int day_of_month)
- Description
Mark a day
-
Method select_day
object(GTK.Calendar) GTK.refdoc.GTK.Calendar()->select_day(int day_of_month)
- Description
Select a certain day of the currently selected month
-
Method select_month
int GTK.refdoc.GTK.Calendar()->select_month(int month, int year)
- Description
Select the month to be viewed.
-
Method set_display_options
object(GTK.Calendar) GTK.refdoc.GTK.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
object(GTK.Calendar) GTK.refdoc.GTK.Calendar()->thaw()
- Description
Resume dynamic updating of the widget
-
Method unmark_day
object(GTK.Calendar) GTK.refdoc.GTK.Calendar()->unmark_day(int day_of_month)
- Description
Unmark a day
|
| CLASS GTK.refdoc.GTK.Toolbar |
Methods
create()
get_icon_size()
get_orientation()
get_style()
get_tooltips()
set_orientation()
set_style()
set_tooltips()
unset_style()
|
- 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:
lambda(){object t=GTK.Toolbar( GTK.ORIENTATION_HORIZONTAL, GTK.TOOLBAR_TEXT );t->append_item( "Button 1", "Tooltip 1", "", GTK.Frame(), lambda(){},0);t->append_space();t->append_item( "Button 2", "Tooltip 2", "", GTK.Frame(), lambda(){},0);t->append_item( "Button 3", "Tooltip 3", "", GTK.Frame(), lambda(){},0);t->append_space();t->append_item( "Button 4", "Tooltip 4", "", GTK.Frame(), lambda(){},0);t->append_item( "Button 5", "Tooltip 5", "", GTK.Frame(), lambda(){},0);return t;}()
../images/gtk_toolbar.png
lambda(){object t=GTK.Toolbar( GTK.ORIENTATION_VERTICAL, GTK.TOOLBAR_TEXT );t->append_item( "Button 1", "Tooltip 1", "", GTK.Frame(), lambda(){},0);t->append_space();t->append_item( "Button 2", "Tooltip 2", "", GTK.Frame(), lambda(){},0);t->append_item( "Button 3", "Tooltip 3", "", GTK.Frame(), lambda(){},0);t->append_space();t->append_item( "Button 4", "Tooltip 4", "", GTK.Frame(), lambda(){},0);t->append_item( "Button 5", "Tooltip 5", "", GTK.Frame(), lambda(){},0);return t;}()
../images/gtk_toolbar_2.png
lambda(){object i=GDK.Image()->set(Image.image(20,20)->test());object t=GTK.Toolbar( GTK.ORIENTATION_HORIZONTAL, GTK.TOOLBAR_BOTH );t->append_item( "Button 1", "Tooltip 1", "", GTK.Image(i), lambda(){},0);t->append_space();t->append_item( "Button 2", "Tooltip 2", "", GTK.Image(i), lambda(){},0);t->append_item( "Button 3", "Tooltip 3", "", GTK.Image(i), lambda(){},0);t->append_space();t->append_item( "Button 4", "Tooltip 4", "", GTK.Image(i), lambda(){},0);t->append_item( "Button 5", "Tooltip 5", "", GTK.Image(i), lambda(){},0);return t;}()
../images/gtk_toolbar_3.png
Properties:
int orientation
int show-arrow
int toolbar-style
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
GTK.Container
-
Method create
object(GTK.Toolbar) GTK.refdoc.GTK.Toolbar()->create()
- Description
Creates a new toolbar.
-
Method get_icon_size
int GTK.refdoc.GTK.Toolbar()->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_orientation
int GTK.refdoc.GTK.Toolbar()->get_orientation()
- Description
Retrieves the current orientation of the toolbar.
-
Method get_style
int GTK.refdoc.GTK.Toolbar()->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 GTK.refdoc.GTK.Toolbar()->get_tooltips()
- Description
Retrieves whether tooltips are enabled.
-
Method set_orientation
object(GTK.Toolbar) GTK.refdoc.GTK.Toolbar()->set_orientation(int orientation)
- Description
Sets whether a toolbar should appear horizontally or vertically.
One of ORIENTATION_HORIZONTAL and ORIENTATION_VERTICAL.
-
Method set_style
object(GTK.Toolbar) GTK.refdoc.GTK.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
object(GTK.Toolbar) GTK.refdoc.GTK.Toolbar()->set_tooltips(int enable)
- Description
Sets if the tooltips should be active or not.
-
Method unset_style
object(GTK.Toolbar) GTK.refdoc.GTK.Toolbar()->unset_style()
- Description
Unsets a toolbar style, so that user preferences will be used to
determine the toolbar style.
|
| CLASS GTK.refdoc.GTK.Layout |
Methods
create()
get_hadjustment()
get_vadjustment()
move()
put()
set_hadjustment()
set_size()
set_vadjustment()
|
- Description
Properties:
GTK.Adjustment hadjustment
int height
GTK.Adjustment vadjustment
int width
Child properties:
int x
int y
Signals:
set_scroll_adjustments
-
Inherit Container
GTK.Container
-
Method create
object(GTK.Layout) GTK.refdoc.GTK.Layout()->create(object(GTK.Adjustment) hadjustment, object(GTK.Adjustment) vadjustment)
- Description
Creates a new GTK.Layout.
-
Method get_hadjustment
object(GTK.Adjustment) GTK.refdoc.GTK.Layout()->get_hadjustment()
- Description
Gets the GTK.Adjustment used for communicaiton between
the horizontal scrollbar and this layout. This should
only be called after the layout has been placed in a
GTK.ScrolledWindow or otherwise configured for scrolling.
-
Method get_vadjustment
object(GTK.Adjustment) GTK.refdoc.GTK.Layout()->get_vadjustment()
- Description
Gets the vertical GTK.Adjustment.
-
Method move
object(GTK.Layout) GTK.refdoc.GTK.Layout()->move(object(GTK.Widget) widget, int x, int y)
- Description
Moves a current child to a new position.
-
Method put
object(GTK.Layout) GTK.refdoc.GTK.Layout()->put(object(GTK.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
object(GTK.Layout) GTK.refdoc.GTK.Layout()->set_hadjustment(object(GTK.Adjustment) adj)
- Description
Sets the horizontal scroll adjustment for the layout.
-
Method set_size
object(GTK.Layout) GTK.refdoc.GTK.Layout()->set_size(int xsize, int ysize)
- Description
Sets the size of the scrollable area of the layout.
-
Method set_vadjustment
object(GTK.Layout) GTK.refdoc.GTK.Layout()->set_vadjustment(object(GTK.Adjustment) adj)
- Description
Sets the vertical scroll adjustment for the layout.
|
| CLASS GTK.refdoc.GTK.CellRendererPixbuf |
Methods
create()
|
- Description
Properties:
GDK.Pixbuf pixbuf
GDK.Pixbuf pixbuf-expander-closed
GDK.Pixbuf pixbuf-expander-open
string stock-detail
string stock-id
int stock-size
-
Inherit CellRenderer
GTK.CellRenderer
-
Method create
object(GTK.CellRendererPixbuf) GTK.refdoc.GTK.CellRendererPixbuf()->create()
- 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 GTK.refdoc.GTK.SelectionData |
|
- Description
Placeholder class for GtkSelectionData.
|
| CLASS GTK.refdoc.GTK.Vscrollbar |
Methods
create()
|
- Description
General documentation: See W(Scrollbar)
GTK.Vscrollbar(GTK.Adjustment())->set_size_request(15,60)
../images/gtk_vscrollbar.png
-
Inherit Scrollbar
GTK.Scrollbar
-
Method create
object(GTK.Vscrollbar) GTK.refdoc.GTK.Vscrollbar()->create(object(GTK.Adjustment) pos)
- Description
Used to create a new vscrollbar widget.
|
| CLASS GTK.refdoc.GTK.Data |
|
- Description
A class inherited by all objects used to store data (they are not widgets)
Signals:
disconnect
-
Inherit Object
GTK.Object
|
| CLASS GTK.refdoc.GTK.Plug |
Methods
create()
get_id()
|
- Description
Together with W(Socket), GTK.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 GTK.Plug window with that XID. Any widgets
contained in the GTK.Plug then will appear inside the first
applications window.
Signals:
embedded
-
Inherit Window
GTK.Window
-
Method create
object(GTK.Plug) GTK.refdoc.GTK.Plug()->create(int socket_id)
- Description
Create a new plug, the socket_id is the window into which this plug
will be plugged.
-
Method get_id
int GTK.refdoc.GTK.Plug()->get_id()
- Description
Gets the window id of this widget.
|
| CLASS GTK.refdoc.GTK.TextIter |
Methods
backward_char()
backward_chars()
backward_cursor_position()
backward_cursor_positions()
backward_line()
backward_lines()
backward_search()
backward_sentence_start()
backward_sentence_starts()
backward_to_tag_toggle()
backward_visible_cursor_position()
backward_visible_cursor_positions()
backward_visible_word_start()
backward_visible_word_starts()
backward_word_start()
backward_word_starts()
begins_tag()
can_insert()
compare()
destroy()
editable()
ends_line()
ends_sentence()
ends_tag()
ends_word()
equal()
forward_char()
forward_chars()
forward_cursor_position()
forward_cursor_positions()
forward_line()
forward_lines()
forward_search()
forward_sentence_end()
forward_sentence_ends()
forward_to_end()
forward_to_line_end()
forward_to_tag_toggle()
forward_visible_cursor_position()
forward_visible_cursor_positions()
forward_visible_word_end()
forward_visible_word_ends()
forward_word_end()
forward_word_ends()
free()
get_buffer()
get_bytes_in_line()
get_char()
get_chars_in_line()
get_line()
get_line_index()
get_line_offset()
get_marks()
get_offset()
get_pixbuf()
get_slice()
get_tags()
get_text()
get_toggle_tags()
get_visible_line_index()
get_visible_line_offset()
get_visible_slice()
get_visible_text()
has_tag()
in_range()
inside_sentence()
inside_word()
is_cursor_position()
is_end()
is_start()
order()
set_line()
set_line_index()
set_line_offset()
set_offset()
set_visible_line_offset()
starts_line()
starts_sentence()
starts_word()
toggles_tag()
|
- Description
A TextIter.
-
Method backward_char
int GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->backward_cursor_position()
- Description
Like forward_cursor_position(), but moves backward.
-
Method backward_cursor_positions
int GTK.refdoc.GTK.TextIter()->backward_cursor_positions(int count)
- Description
Moves up to count cursor positions.
-
Method backward_line
int GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->backward_lines(int count)
- Description
Moves count lines backward.
-
Method backward_search
array GTK.refdoc.GTK.TextIter()->backward_search(string str, int flags, object(GTK.TextIter) limit)
- Description
Same as forward_search(), but searches backward.
-
Method backward_sentence_start
int GTK.refdoc.GTK.TextIter()->backward_sentence_start()
- Description
Moves backward to the previous sentence start.
-
Method backward_sentence_starts
int GTK.refdoc.GTK.TextIter()->backward_sentence_starts(int count)
- Description
Call backward_sentence_start() count times.
-
Method backward_to_tag_toggle
int GTK.refdoc.GTK.TextIter()->backward_to_tag_toggle(object(GTK.TextTag) tag)
- Description
Moves backward to the next toggle. See forward_to_tag_toggle().
-
Method backward_visible_cursor_position
int GTK.refdoc.GTK.TextIter()->backward_visible_cursor_position()
- Description
Moves backward to the previous visible cursor position.
-
Method backward_visible_cursor_positions
int GTK.refdoc.GTK.TextIter()->backward_visible_cursor_positions(int count)
- Description
Moves up to count visible cursor positions.
-
Method backward_visible_word_start
int GTK.refdoc.GTK.TextIter()->backward_visible_word_start()
- Description
Moves backward to the previous visible word start.
-
Method backward_visible_word_starts
int GTK.refdoc.GTK.TextIter()->backward_visible_word_starts(int count)
- Description
Call backward_visible_word_start() count
-
Method backward_word_start
int GTK.refdoc.GTK.TextIter()->backward_word_start()
- Description
Moves backward to the previous word start.
-
Method backward_word_starts
int GTK.refdoc.GTK.TextIter()->backward_word_starts(int count)
- Description
Calls backward_word_start() up to count times.
-
Method begins_tag
int GTK.refdoc.GTK.TextIter()->begins_tag(object(GTK.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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->compare(object(GTK.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 destroy
object(GTK.TextIter) GTK.refdoc.GTK.TextIter()->destroy()
- Description
Destructor.
-
Method editable
int GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->ends_sentence()
- Description
Determines whether this iter ends a sentence.
-
Method ends_tag
int GTK.refdoc.GTK.TextIter()->ends_tag(object(GTK.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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->equal(object(GTK.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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->forward_cursor_positions(int count)
- Description
Moves up to count cursor positions.
-
Method forward_line
int GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->forward_search(string str, int flags, object(GTK.TextIter) limit)
- Description
Searches forward for str. Returns two GTK.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 GTK.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 GTK.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 GTK.refdoc.GTK.TextIter()->forward_sentence_end()
- Description
Moves forward to the next sentence end.
-
Method forward_sentence_ends
int GTK.refdoc.GTK.TextIter()->forward_sentence_ends(int count)
- Description
Call forward_sentence_ends() count times.
-
Method forward_to_end
object(GTK.TextIter) GTK.refdoc.GTK.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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->forward_to_tag_toggle(object(GTK.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 GTK.refdoc.GTK.TextIter()->forward_visible_cursor_position()
- Description
Moves forward to the next visible cursor position.
-
Method forward_visible_cursor_positions
int GTK.refdoc.GTK.TextIter()->forward_visible_cursor_positions(int count)
- Description
Moves up to count visible cursor positions.
-
Method forward_visible_word_end
int GTK.refdoc.GTK.TextIter()->forward_visible_word_end()
- Description
Moves forward to the next visible word end.
-
Method forward_visible_word_ends
int GTK.refdoc.GTK.TextIter()->forward_visible_word_ends(int count)
- Description
Call forward_visible_word_end() count times.
-
Method forward_word_end
int GTK.refdoc.GTK.TextIter()->forward_word_end()
- Description
Moves forward to the next word end.
-
Method forward_word_ends
int GTK.refdoc.GTK.TextIter()->forward_word_ends(int count)
- Description
Calls forward_word_end() up to count times.
-
Method free
object(GTK.TextIter) GTK.refdoc.GTK.TextIter()->free()
- Description
Free an iterator.
-
Method get_buffer
object(GTK.TextBuffer) GTK.refdoc.GTK.TextIter()->get_buffer()
- Description
Returns the W(TextBuffer) this iterator is associated with.
-
Method get_bytes_in_line
int GTK.refdoc.GTK.TextIter()->get_bytes_in_line()
- Description
Returns the number of bytes in the line, including the paragraph
delimiters.
-
Method get_char
int GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->get_chars_in_line()
- Description
Returns the number of characters in the line, including the paragraph
delimiters.
-
Method get_line
int GTK.refdoc.GTK.TextIter()->get_line()
- Description
Returns the line number containing this iterator.
-
Method get_line_index
int GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->get_line_offset()
- Description
Returns the character offset of the iterator, counting from the
start of a newline-terminated line.
-
Method get_marks
array GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->get_offset()
- Description
Returns the character offset of an iterator.
-
Method get_pixbuf
object(GDK.Pixbuf) GTK.refdoc.GTK.TextIter()->get_pixbuf()
- Description
If the element at iter is a pixbuf, it is returned.
-
Method get_slice
string GTK.refdoc.GTK.TextIter()->get_slice(object(GTK.TextIter) end)
- Description
Returns the text in the given range. A "slice" is an array of
characters encoded in UTF-8 foramt, 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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->get_text(object(GTK.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_toggle_tags
array GTK.refdoc.GTK.TextIter()->get_toggle_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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->get_visible_slice(object(GTK.TextIter) end)
- Description
Like get_slice(), but invisible text is not included.
-
Method get_visible_text
string GTK.refdoc.GTK.TextIter()->get_visible_text(object(GTK.TextIter) end)
- Description
Like get_text(), but invisible text is not include.
-
Method has_tag
int GTK.refdoc.GTK.TextIter()->has_tag(object(GTK.TextTag) tag)
- Description
Returns true if this iterator is within a range tagged with tag.
-
Method in_range
int GTK.refdoc.GTK.TextIter()->in_range(object(GTK.TextIter) start, object(GTK.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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->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
int GTK.refdoc.GTK.TextIter()->order(object(GTK.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
object(GTK.TextIter) GTK.refdoc.GTK.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
object(GTK.TextIter) GTK.refdoc.GTK.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
object(GTK.TextIter) GTK.refdoc.GTK.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
object(GTK.TextIter) GTK.refdoc.GTK.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_offset
object(GTK.TextIter) GTK.refdoc.GTK.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 GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->starts_sentence()
- Description
Determines whether this iter begins a sentence.
-
Method starts_word
int GTK.refdoc.GTK.TextIter()->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 GTK.refdoc.GTK.TextIter()->toggles_tag(object(GTK.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 GTK.refdoc.GTK.Range |
Methods
get_adjustment()
get_inverted()
get_update_policy()
get_value()
set_adjustment()
set_increments()
set_inverted()
set_range()
set_update_policy()
set_value()
|
- 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 GTK.CanFocus flag on the
scrollbar, like this:
scrollbar->unset_flag( GTK.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:
GTK.Adjustment adjustment
int inverted
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
Signals:
adjust_bounds
change_value
move_slider
value_changed
-
Inherit Widget
GTK.Widget
-
Method get_adjustment
object(GTK.Adjustment) GTK.refdoc.GTK.Range()->get_adjustment()
- Description
Gets the W(Adjustment) which is the "model" object for W(Range).
-
Method get_inverted
int GTK.refdoc.GTK.Range()->get_inverted()
- Description
Gets the value set by set_inverted().
-
Method get_update_policy
int GTK.refdoc.GTK.Range()->get_update_policy()
- Description
Gets the update policy.
-
Method get_value
float GTK.refdoc.GTK.Range()->get_value()
- Description
Gets the current value.
-
Method set_adjustment
object(GTK.Range) GTK.refdoc.GTK.Range()->set_adjustment(object(GTK.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_increments
object(GTK.Range) GTK.refdoc.GTK.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
object(GTK.Range) GTK.refdoc.GTK.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_range
object(GTK.Range) GTK.refdoc.GTK.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_update_policy
object(GTK.Range) GTK.refdoc.GTK.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:
- GTK.UpdatePolicyContinuous
-
This is the default. The "value_changed" signal is emitted
continuously, i.e., whenever the slider is moved by even the
tiniest amount.
- GTK.UpdatePolicyDiscontinuous
-
The "value_changed" signal is only emitted once the slider has
stopped moving and the user has released the mouse button.
- GTK.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_value
object(GTK.Range) GTK.refdoc.GTK.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 GTK.refdoc.GTK.VbuttonBox |
Methods
create()
|
- 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.
GTK.VbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_size_request(100,300)
../images/gtk_vbuttonbox.png
GTK.VbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_layout(GTK.BUTTONBOX_SPREAD)->set_size_request(100,300)
../images/gtk_vbuttonbox_2.png
GTK.VbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_layout(GTK.BUTTONBOX_EDGE)->set_size_request(100,300)
../images/gtk_vbuttonbox_3.png
GTK.VbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_layout(GTK.BUTTONBOX_START)->set_size_request(100,300)
../images/gtk_vbuttonbox_4.png
GTK.VbuttonBox()->add(GTK.Button("Hello"))->add(GTK.Button("World"))->set_layout(GTK.BUTTONBOX_END)->set_size_request(100,300)
../images/gtk_vbuttonbox_5.png
-
Inherit ButtonBox
GTK.ButtonBox
-
Method create
object(GTK.VbuttonBox) GTK.refdoc.GTK.VbuttonBox()->create()
- Description
Create a new vertical button box
|
| CLASS GTK.refdoc.GTK.Socket |
Methods
add_id()
create()
get_id()
id()
|
- Description
Together with W(Plug), GTK.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 GTK.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
GTK.Socket.
Signals:
plug_added
plug_removed
-
Inherit Container
GTK.Container
-
Method add_id
object(GTK.Socket) GTK.refdoc.GTK.Socket()->add_id(int wid)
- Description
Adds an XEMBED client, such as a W(Plug), to the W(Socket).
-
Method create
object(GTK.Socket) GTK.refdoc.GTK.Socket()->create()
- Description
Create a new GTK.Socket.
-
Method get_id
int GTK.refdoc.GTK.Socket()->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
GTK.Plug->create().
-
Method id
int GTK.refdoc.GTK.Socket()->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 GTK.refdoc.GTK.ToggleButton |
Methods
create()
get_active()
get_inconsistent()
get_mode()
set_active()
set_inconsistent()
set_mode()
toggled()
|
- 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.
GTK.ToggleButton("Toggle button")
../images/gtk_togglebutton.png
GTK.ToggleButton("Toggle button")->set_active( 1 )
../images/gtk_togglebutton_2.png
Properties:
int active
int draw-indicator
int inconsistent
Signals:
toggled
-
Inherit Button
GTK.Button
-
Method create
object(GTK.ToggleButton) GTK.refdoc.GTK.ToggleButton()->create(string|void label)
- 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 GTK.refdoc.GTK.ToggleButton()->get_active()
- Description
Returns true if button is pressed, and false if it is raised.
-
Method get_inconsistent
int GTK.refdoc.GTK.ToggleButton()->get_inconsistent()
- Description
Gets the value set by set_inconsistent().
-
Method get_mode
int GTK.refdoc.GTK.ToggleButton()->get_mode()
- Description
Retrieves whether the button is displayed as a separator indicator and
label.
-
Method set_active
object(GTK.ToggleButton) GTK.refdoc.GTK.ToggleButton()->set_active(int activep)
- Description
If activep is true, the toggle button will be activated.
-
Method set_inconsistent
object(GTK.ToggleButton) GTK.refdoc.GTK.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
object(GTK.ToggleButton) GTK.refdoc.GTK.ToggleButton()->set_mode(int mode)
- Description
If true, draw indicator
-
Method toggled
object(GTK.ToggleButton) GTK.refdoc.GTK.ToggleButton()->toggled()
- Description
emulate a 'toggle' of the button. This will emit a 'toggled' signal.
|
| CLASS GTK.refdoc.GTK.Clipboard |
Methods
clear()
destroy()
get()
get_display()
get_for_display()
set_text()
wait_for_text()
wait_is_text_available()
|
- Description
Clipboard implementation.
-
Method clear
object(GTK.Clipboard) GTK.refdoc.GTK.Clipboard()->clear()
- Description
Clears the contents of the clipboard.
-
Method destroy
object(GTK.Clipboard) GTK.refdoc.GTK.Clipboard()->destroy()
- Description
Destructor.
-
Method get
object(GTK.Clipboard) GTK.refdoc.GTK.Clipboard()->get(object(GDK.Atom) selection)
- Description
Returns the clipboard object for the given selection.
-
Method get_display
object(GDK.Display) GTK.refdoc.GTK.Clipboard()->get_display()
- Description
Gets the GDK.Display associated with this clipboard.
-
Method get_for_display
object(GTK.Clipboard) GTK.refdoc.GTK.Clipboard()->get_for_display(object(GDK.Display) display, object(GDK.Atom) selection)
- Description
Returns the clipboard object for the given selection.
-
Method set_text
object(GTK.Clipboard) GTK.refdoc.GTK.Clipboard()->set_text(string text, int len)
- Description
Sets the contents of the clipboard to the given UTF-8 string.
-
Method wait_for_text
string GTK.refdoc.GTK.Clipboard()->wait_for_text()
- Description
Requests the contents of the clipboard as text and converts the result
to UTF-8 if necessary.
-
Method wait_is_text_available
int GTK.refdoc.GTK.Clipboard()->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 GTK.refdoc.GTK.Vscale |
Methods
create()
|
- Description
The GTK.HScale widget is used to allow the user to select a value
using a horizontal slider. A GTK.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.
GTK.Vscale(GTK.Adjustment())->set_size_request(300,30)
../images/gtk_vscale.png
-
Inherit Scale
GTK.Scale
-
Method create
object(GTK.Vscale) GTK.refdoc.GTK.Vscale()->create(object(GTK.Adjustment) settings_or_min, 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 GTK.refdoc.GTK.MenuBar |
Methods
create()
|
- 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.
GTK.MenuBar()->add(GTK.Menu_item("Menu")->set_submenu(GTK.Menu()->add(GTK.Menu_item("Sub")))->select()->activate())->add(GTK.Menu_item("Bar"))
../images/gtk_menubar.png
Style properties:
int internal-padding
int shadow-type
-
Inherit MenuShell
GTK.MenuShell
-
Method create
object(GTK.MenuBar) GTK.refdoc.GTK.MenuBar()->create()
- Description
Create a new menu bar.
|
| CLASS GTK.refdoc.GTK.ButtonBox |
Methods
get_child_secondary()
get_layout()
set_child_secondary()
set_layout()
|
- 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
GTK.Box
-
Method get_child_secondary
int GTK.refdoc.GTK.ButtonBox()->get_child_secondary(object(GTK.Widget) child)
- Description
Returns whether child should appear in a secondary group of children.
-
Method get_layout
int GTK.refdoc.GTK.ButtonBox()->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
object(GTK.ButtonBox) GTK.refdoc.GTK.ButtonBox()->set_child_secondary(object(GTK.Widget) child, int is_secondary)
- Description
Sets whether child should appear in a secondary group of children.
-
Method set_layout
object(GTK.ButtonBox) GTK.refdoc.GTK.ButtonBox()->set_layout(int layout)
- Description
layout is one of BUTTONBOX_DEFAULT_STYLE, BUTTONBOX_EDGE, BUTTONBOX_END, BUTTONBOX_SPREAD and BUTTONBOX_START
|
| CLASS GTK.refdoc.GTK.TreeIter |
Methods
copy()
create()
destroy()
|
- Description
TreeIter.
-
Method copy
object(GTK.TreeIter) GTK.refdoc.GTK.TreeIter()->copy()
- Description
Creates a copy of this tree iter.
-
Method create
object(GTK.TreeIter) GTK.refdoc.GTK.TreeIter()->create()
- Description
Create a new TreeIter.
-
Method destroy
object(GTK.TreeIter) GTK.refdoc.GTK.TreeIter()->destroy()
- Description
Destructor.
|
| CLASS GTK.refdoc.GTK.Progress |
|
- Description
Properties:
int activity-mode
int show-text
float text-xalign
float text-yalign
-
Inherit Widget
GTK.Widget
|
| CLASS GTK.refdoc.GTK.TextChildAnchor |
Methods
create()
get_deleted()
get_widgets()
|
- Description
Anchors for embedding widgets in a TextBuffer.
-
Inherit Object
G.Object
-
Method create
object(GTK.TextChildAnchor) GTK.refdoc.GTK.TextChildAnchor()->create()
- 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 GTK.refdoc.GTK.TextChildAnchor()->get_deleted()
- Description
Determines whether a child anchor has been deleted from the buffer.
-
Method get_widgets
array GTK.refdoc.GTK.TextChildAnchor()->get_widgets()
- Description
Gets a list of all widgets anchored at this child anchor.
|
| CLASS GTK.refdoc.GTK.WindowGroup |
Methods
add_window()
create()
remove_window()
|
- Description
Limit the effect of grabs.
-
Inherit Object
G.Object
-
Method add_window
object(GTK.WindowGroup) GTK.refdoc.GTK.WindowGroup()->add_window(object(GTK.Window) window)
- Description
Add a window.
-
Method create
object(GTK.WindowGroup) GTK.refdoc.GTK.WindowGroup()->create()
- Description
Creates a new GTK.WindowGroup object. Grabs added with GTK.grab_add() only
affect windows with the same GTk.WindowGroup.
-
Method remove_window
object(GTK.WindowGroup) GTK.refdoc.GTK.WindowGroup()->remove_window(object(GTK.Window) window)
- Description
Remove a window.
|
| CLASS GTK.refdoc.Pango.LayoutLine |
Methods
get_extents()
get_pixel_extents()
index_to_x()
x_to_index()
|
- Description
PangoLayoutLine.
-
Method get_extents
array GTK.refdoc.Pango.LayoutLine()->get_extents()
- Description
Computes the logical and ink extents of a layout line.
-
Method get_pixel_extents
array GTK.refdoc.Pango.LayoutLine()->get_pixel_extents()
- Description
Computes the logical and ink extents of a layout line, in device units.
-
Method index_to_x
int GTK.refdoc.Pango.LayoutLine()->index_to_x(int index, int trailing)
- Description
Converts an index within a line to an x position.
-
Method x_to_index
mapping GTK.refdoc.Pango.LayoutLine()->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 GTK.refdoc.Pango.FontDescription |
Methods
better_match()
copy()
create()
destroy()
equal()
get_family()
get_size()
get_stretch()
get_style()
get_variant()
get_weight()
merge()
set_family()
set_size()
set_stretch()
set_style()
set_variant()
set_weight()
to_filename()
to_string()
|
- Description
Pango Font Description.
-
Method better_match
int GTK.refdoc.Pango.FontDescription()->better_match(object(Pango.FontDescription) new, object(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
object(Pango.FontDescription) GTK.refdoc.Pango.FontDescription()->copy()
- Description
Copy a font description.
-
Method create
object(Pango.FontDescription) GTK.refdoc.Pango.FontDescription()->create(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 destroy
object(Pango.FontDescription) GTK.refdoc.Pango.FontDescription()->destroy()
- Description
Destructor.
-
Method equal
int GTK.refdoc.Pango.FontDescription()->equal(object(Pango.FontDescription) desc)
- Description
Compares two font descriptions for equality.
-
Method get_family
string GTK.refdoc.Pango.FontDescription()->get_family()
- Description
Gets the family name.
-
Method get_size
int GTK.refdoc.Pango.FontDescription()->get_size()
- Description
Gets the size.
-
Method get_stretch
int GTK.refdoc.Pango.FontDescription()->get_stretch()
- Description
Get the stretch.
-
Method get_style
int GTK.refdoc.Pango.FontDescription()->get_style()
- Description
Gets the style.
-
Method get_variant
int GTK.refdoc.Pango.FontDescription()->get_variant()
- Description
Gets the variant.
-
Method get_weight
int GTK.refdoc.Pango.FontDescription()->get_weight()
- Description
Gets the weight.
-
Method merge
object(Pango.FontDescription) GTK.refdoc.Pango.FontDescription()->merge(object(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
object(Pango.FontDescription) GTK.refdoc.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
object(Pango.FontDescription) GTK.refdoc.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
object(Pango.FontDescription) GTK.refdoc.Pango.FontDescription()->set_stretch(int stretch)
- Description
Sets the stretch. This specifies how narrow or wide the font should be.
One of .
-
Method set_style
object(Pango.FontDescription) GTK.refdoc.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 . 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
object(Pango.FontDescription) GTK.refdoc.Pango.FontDescription()->set_variant(int variant)
- Description
Sets the variant. One of .
-
Method set_weight
object(Pango.FontDescription) GTK.refdoc.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 , other intermediate
numeric values are possible.
-
Method to_filename
string GTK.refdoc.Pango.FontDescription()->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 GTK.refdoc.Pango.FontDescription()->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 GTK.refdoc.Pango.LayoutIter |
Methods
at_last_line()
destroy()
get_baseline()
get_char_extents()
get_cluster_extents()
get_index()
get_layout_extents()
get_line()
get_line_extents()
get_line_yrange()
get_run_extents()
next_char()
next_cluster()
next_line()
next_run()
|
- Description
PangoLayoutIter.
-
Method at_last_line
int GTK.refdoc.Pango.LayoutIter()->at_last_line()
- Description
Determines whether this iter is on the last line of the layout.
-
Method destroy
object(Pango.LayoutIter) GTK.refdoc.Pango.LayoutIter()->destroy()
- Description
Destructor.
-
Method get_baseline
int GTK.refdoc.Pango.LayoutIter()->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 GTK.refdoc.Pango.LayoutIter()->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 GTK.refdoc.Pango.LayoutIter()->get_cluster_extents()
- Description
Gets the extents of the current cluster, in layout coordinates.
-
Method get_index
int GTK.refdoc.Pango.LayoutIter()->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 GTK.refdoc.Pango.LayoutIter()->get_layout_extents()
- Description
Obtains the extents of the layout.
-
Method get_line
object(Pango.LayoutLine) GTK.refdoc.Pango.LayoutIter()->get_line()
- Description
Gets the current line.
-
Method get_line_extents
array GTK.refdoc.Pango.LayoutIter()->get_line_extents()
- Description
Obtains the extents of the current line.
-
Method get_line_yrange
array GTK.refdoc.Pango.LayoutIter()->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 GTK.refdoc.Pango.LayoutIter()->get_run_extents()
- Description
Gets the extents of the current run in layout coordinates.
-
Method next_char
int GTK.refdoc.Pango.LayoutIter()->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 GTK.refdoc.Pango.LayoutIter()->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 GTK.refdoc.Pango.LayoutIter()->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 GTK.refdoc.Pango.LayoutIter()->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 GTK.refdoc.Pango.Context |
Methods
destroy()
|
- Description
PangoContext.
-
Inherit Object
G.Object
-
Method destroy
object(Pango.Context) GTK.refdoc.Pango.Context()->destroy()
- Description
Destructor.
|
| CLASS GTK.refdoc.Pango.Layout |
Methods
context_changed()
copy()
create()
get_alignment()
get_auto_dir()
get_context()
get_cursor_pos()
get_indent()
get_justify()
get_line()
get_line_count()
get_single_paragraph_mode()
get_size()
get_spacing()
get_tabs()
get_text()
get_width()
get_wrap()
index_to_pos()
move_cursor_visually()
set_alignment()
set_auto_dir()
set_font_description()
set_indent()
set_justify()
set_markup()
set_markup_with_accel()
set_single_paragraph_mode()
set_spacing()
set_tabs()
set_text()
set_width()
set_wrap()
xy_to_index()
|
- Description
Pango Layout.
-
Method context_changed
object(Pango.Layout) GTK.refdoc.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
object(Pango.Layout) GTK.refdoc.Pango.Layout()->copy(object(Pango.Layout) src)
- Description
Does a copy of the src.
-
Method create
object(Pango.Layout) GTK.refdoc.Pango.Layout()->create(object(Pango.Context) context)
- Description
Create a new layout with attributes initialized to default values for
a particular Pango.Context
-
Method get_alignment
int GTK.refdoc.Pango.Layout()->get_alignment()
- Description
Gets the alignment.
-
Method get_auto_dir
int GTK.refdoc.Pango.Layout()->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
object(Pango.Context) GTK.refdoc.Pango.Layout()->get_context()
- Description
Returns the Pango.Context.
-
Method get_cursor_pos
array GTK.refdoc.Pango.Layout()->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 GTK.refdoc.Pango.Layout()->get_indent()
- Description
Gets the paragraph indent in pango units. A negative value indicates a
hanging indent.
-
Method get_justify
int GTK.refdoc.Pango.Layout()->get_justify()
- Description
Gets whether or not each complete line should be stretched to fill the
entire width of the layout.
-
Method get_line
object(Pango.LayoutLine) GTK.refdoc.Pango.Layout()->get_line(int line)
- Description
Retrieves a specific line.
-
Method get_line_count
int GTK.refdoc.Pango.Layout()->get_line_count()
- Description
Retrieves the count of lines.
-
Method get_single_paragraph_mode
int GTK.refdoc.Pango.Layout()->get_single_paragraph_mode()
- Description
Gets the value set by set_single_paragraph_mode().
-
Method get_size
mapping GTK.refdoc.Pango.Layout()->get_size()
- Description
Determines the logical width and height in Pango units.
-
Method get_spacing
int GTK.refdoc.Pango.Layout()->get_spacing()
- Description
Gets the amount of spacing between the lines.
-
Method get_tabs
object(Pango.TabArray) GTK.refdoc.Pango.Layout()->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 GTK.refdoc.Pango.Layout()->get_text()
- Description
Gets the text.
-
Method get_width
int GTK.refdoc.Pango.Layout()->get_width()
- Description
Gets the line wrap width.
-
Method get_wrap
int GTK.refdoc.Pango.Layout()->get_wrap()
- Description
Gets the wrap mode for the layout.
-
Method index_to_pos
mapping GTK.refdoc.Pango.Layout()->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 GTK.refdoc.Pango.Layout()->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
object(Pango.Layout) GTK.refdoc.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 .
-
Method set_auto_dir
object(Pango.Layout) GTK.refdoc.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
object(Pango.Layout) GTK.refdoc.Pango.Layout()->set_font_description(object(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
object(Pango.Layout) GTK.refdoc.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
object(Pango.Layout) GTK.refdoc.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
object(Pango.Layout) GTK.refdoc.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
object(Pango.Layout) GTK.refdoc.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 GTK.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
object(Pango.Layout) GTK.refdoc.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
object(Pango.Layout) GTK.refdoc.Pango.Layout()->set_spacing(int spacing)
- Description
Sets the amount of spacing between the lines.
-
Method set_tabs
object(Pango.Layout) GTK.refdoc.Pango.Layout()->set_tabs(object(Pango.TabArray)|void 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
object(Pango.Layout) GTK.refdoc.Pango.Layout()->set_text(string text, int length)
- Description
Sets the text of the layout.
-
Method set_width
object(Pango.Layout) GTK.refdoc.Pango.Layout()->set_width(int width)
- Description
Sets the width to which the lines should be wrapped.
-
Method set_wrap
object(Pango.Layout) GTK.refdoc.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 .
-
Method xy_to_index
mapping GTK.refdoc.Pango.Layout()->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 GTK.refdoc.Pango.AttrList |
Methods
copy()
create()
|
- Description
A PangoAttrList.
-
Method copy
object(Pango.AttrList) GTK.refdoc.Pango.AttrList()->copy()
- Description
Copy the list.
-
Method create
object(Pango.AttrList) GTK.refdoc.Pango.AttrList()->create()
- Description
Create a new empty attribute list.
|
|
modules.gotpike.org