<<<<<<<<<<<<<<<<

xset_window_attributes(x) Xlib xset_window_attributes(x)

NAME

xset_window_attributes - X window attributes

DESCRIPTION

The xset_window_attributes class provides an interface to an X XSetWindowAttributes structure. X defaults will be used for all attributes that are not set. Please note that the default values of the instance variables in the class may not represent the X defaults. If you need a specific value, make sure to set it.

SUPERCLASS

object

INSTANCE VARIABLES

background_pixel is the pixel that is used for the background.

background_pixmap is the name of the xpixmap object that is used for the background.

backing_pixel is used along with backing planes. If you use private color cells, you may set this to an allocated value. When the workstation restores on-screen pixels from backing store, it only can restore the bits specified in backing planes. The rest of the bits are restored using the backing pixel.

backing_planes is a bit mask that allows you to request backing storage for some of the bits in each pixel. By default, this is set to all planes. If you are using privately allocated color cells you may save backing store by setting this attribute.

backing_store can be used on many workstations to restore the contents of a window after it has been unmapped or obscured by another window. This can reduce the number of expose events that you need to handle, but not all of them. This attribute can have three possible values: 0 (NotUseful) or 1 (WhenMapped) or 2 (Always).

bit_gravity specifies what happens to the bits in the window when the window is resized. Possible values are 0 (ForgetGravity), 1 (NorthWestGravity), 2 (NorthGravity), 3 (NorthEastGravity), 4 (WestGravity), 5 (CenterGravity), 6 (EastGravity), 7 (SouthWestGravity), 8 (SouthGravity), 9 (SouthEastGravity)and 10 (StaticGravity).

border_pixel is the pixel that is used for the border.

border_pixmap is the name of the xpixmap object that is used for the border.

colormap is the name of the xcolormap object that is used for the colormap.

cursor is the name of the xcursor object that is used for the cursor.

do_not_propagate_mask is a bit mask that specifies which events cannot propagate up the window hierarchy toward the root. The bits in this mask have the same meaning as the nits in the event mask.

event_mask is a bit mask that specifies which events are solicited by the window.

id is a pointer to an X Window structure.

override_redirect is a boolean value that indicates whether you want to allow the window manager to intervene when you map, configure or change the stacking order of the window.

save_under is a boolean value that tells the workstation whether to attempt to save areas of underlying windows that are covered by this window and restore them when this window goes away.

valuemask is a bit mask that specifies which attributes have been set. Only these values will be used when an xwindow object uses these attributes.

win_gravity tells the workstation how to reposition the window when its parent's size changes.

MESSAGES

background_pixel= value sets the background_pixel instance variable.

background_pixel? returns the value of the background_pixel instance variable on the argument stack.

background_pixmap= background_pixmap_object_name sets the background_pixmap instance variable.

background_pixmap? returns the value of the background_pixmap instance variable on the argument stack.

backing_pixel= value sets the backing_pixel instance variable.

backing_pixel? returns the value of the backing_pixel instance variable on the argument stack.

backing_planes= planes sets the backing_planes instance variable.

backing_planes? returns the value of the backing_planes instance variable on the argument stack.

backing_store= value sets the backing_store instance variable.

backing_store? returns the value of the backing_store instance variable on the argument stack.

bit_gravity= value sets the bit_gravity instance variable.

bit_gravity? returns the value of the bit_gravity instance variable on the argument stack.

border_pixel= value sets the border_pixel instance variable.

border_pixel? returns the value of the border_pixel instance variable on the argument stack.

border_pixmap= border_pixmap_object_name sets the border_pixmap instance variable.

border_pixmap? returns the value of the border_pixmap instance variable on the argument stack.

clear_valuemask! clears the valuemask.

colormap= colormap_object_name sets the colormap instance variable.

colormap? returns the value of the colormap instance variable on the argument stack.

cursor= cursor_object_name sets the cursor instance variable.

cursor? returns the value of the cursor instance variable on the argument stack.

create! creates the attributes and sets the id.

do_not_propagate_mask= value sets the do_not_propagate_mask instance variable.

do_not_propagate_mask? returns the value of the do_not_propagate_mask instance variable on the argument stack.

event_mask= value sets the event_mask instance variable.

event_mask? returns the value of the event_mask instance variable on the argument stack.

override_redirect_on! sets override_redirect to true.

override_redirect_off! sets override_redirect to false.

save_under_on! sets save_under to true.

save_under_off! sets save_under to false.

valuemask= value sets the valuemask instance variable. This is usually set by the system rather than the user.

valuemask? returns the value of the valuemask instance variable on the argument stack.

win_gravity= value sets the win_gravity instance variable.

win_gravity? returns the value of the win_gravity instance variable on the argument stack.

EXAMPLE

/* create attributes and use them in an existing window */ xwindow new: the_window create!;

scalar new: center_gravity = 5;

xset_window_attributes new: the_attributes override_redirect_on! bit_gravity = center_gravity;

the_window xset_window_attributes= the_attributes change_window_attributes!;