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

ximage_manager(x) Xlib ximage_manager(x)

NAME

ximage_manager - a manager of ximages in an xwindow.

DESCRIPTION

The ximage_manager class keeps track of sets of images. The sets are referenced using index numbers. They can then be displayed in an xwindow where the indexes correspond to positions in the window.

SUPERCLASS

object

INSTANCE VARIABLES

display_offset is the number of positions to offset the display of an index in the window. For example, if the display_offset = 3, index_number 4 would be displayed in the upper left hand corner of the window. Negative numbers can also be used. The default is 0.

index_number is the number of the current set of ximages. The index numbers start at one. They are displayed in the window starting at the upper left hand corner and fill the rows from top to bottom.

index_string is a string that can be displayed in the indexes in the window.

load_indexes is a list of indexes to load ximages into.

number_of_indexes is the number of indexes that currently exist. This is a private variable and thus should not be altered by the user.

number_of_columns is the number of columns of indexes in the xwindow.

number_of_rows is the number of rows of indexes in the xwindow.

index_list is a private variable that is used to track the indexes.

xwindow is that name of the xwindow object where the ximages will be displayed.

MESSAGES

backward: index_list sets the paging direction to backward for the given indexes.

backward_all! sets the paging direction to backward for all indexes.

backward! sets the paging direction of the current index to backward.

cine_loop: index_list sets the paging mode of the given indexes to cine loop.

cine_loop_all! sets the paging mode of all indexes to cine loop.

cine_loop! sets the paging mode of the current index to cine loop.

clear: index_list clears the contents of the given indexes. High indexes may be deleted if no longer needed.

clear_all! clears the contents of all indexes and deleted them.

clear! clears the contents of the current index and deletes it if it is no longer needed.

copy: index_one index_two copies the contents of index_one to index_two.

current_ximage? returns the name of the current ximage at the current index.

display: index_list displays the given indexes in the window if they are viewable. Note that the ximage_manager does not worry about the ximage size.

display_all! displays the viewable indexes in the window. Note that the ximage_manager does not worry about the ximage size.

display! displays the current index in the window if it is viewable. Note that the ximage_manager does not

worry about the ximage size.

display_index_string: index_list, display_string: index displays the index string and the application scalar of the current ximage for the given indexes.

display_index_string_all!, display_string_all! displays the index string and the application scalar of the current ximage for all indexes.

display_index_string!, display_string! displays the index string and the application scalar of the current ximage for the current index.

display_offset= value sets the display_offset instance variable.

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

erase: index_list erases the given indexes in the window.

erase_all! erases all contents in the window.

erase! erases the current index from the window. sets the paging direction to forward for the given indexes.

forward_all! sets the paging direction to forward for all indexes.

forward! sets the paging direction of the current index to forward.

goto: ximage_number will set the current ximage at the current index if the ximage_number is in range.

index_string= value sets the index_string instance variable.

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

index_number= value sets the index_number instance variable.

index_number? returns the value of the index_number instance

variable on the argument stack.

load_indexes= index_list sets the load_indexes instance variable.

load_indexes? returns the load_indexes on the argument stack.

load_ximages: ximage_list loads the ximages into the indexes specified by load_indexes. If there are more ximages than indexes, the remaining images will be loaded starting at the first index again. For example, if load_indexes contains the indexes 1, 2, and 3 and the ximage list contains four ximage names, index 1 will contain the first and last ximages, index 2 the second and index three will contain the third ximage. As the ximages are loaded, they will be displayed. The previous contents of the indexes will be overwritten.

load_ximages+ ximage_list is similar to the load_ximages: message except the ximages are added to the indexes rather than overwriting the contents of the indexes.

next: index_list updates the current ximage at each of the given indexes using paging information. If there is no next ximage at an index, the index will not be changed.

next_all! updates the current ximage at each index using paging information. If there is no next ximage at an index, the index will not be changed.

next! updates the current ximage at the current index using paging information. If there is no next ximage at the index, it will not be changed.

no_loop: index_list turns looping off at the given indexes.

no_loop_all! turns looping off at all indexes.

no_loop! turns looping off at the current index.

number_of_columns= value sets the number_of_columns instance variable.

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

number_of_rows= value sets the number_of_rows instance variable.

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

print_all_indexes! prints the attributes of all indexes. This includes paging mode, paging direction, the current ximage and the list list of ximages.

print_index! prints the attributes of the current index. This includes paging mode, paging direction, the current ximage and the list list of ximages.

print_indexes: index_list prints the attributes of the given indexes. This includes paging mode, paging direction, the current ximage and the list list of ximages.

rewind: index_list sets the current ximage to the first ximage at each of the given indexes.

rewind_all! sets the current ximage to the first ximage at each index.

rewind! sets the current ximage to the first ximage at the current index.

spatial_loop: index_list sets the paging mode of the given indexes to spatial loop.

spatial_loop_all! sets the paging mode of all indexes to spatial loop.

spatial_loop! sets the paging mode of the current index to spatial loop.

swap: index_one index_two swaps the contents of the two indexes.

ximages- ximage_names subtracts the given ximages from the list of images for the current index. The ximage_names are names of ximage objects.

ximages+ ximage_names adds the given ximages to the list of images for the current index. The ximage_names are names of ximage objects.

xwindow= xwindow_object_name sets the xwindow instance variable.

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

EXAMPLE

/* create xwindow */ xwindow new: the_window width= 700 height= 700 map! ;

/* assume that the ximages have been created */

/* create ximage_manager and display images */ ximage_manager new: the_manager number_of_rows= 2 number_of_columns= 2 @1 ximages: ximage_one @2 ximages: (ximage_two_a, ximage_two_b) spatial_loop! @4 ximages: ximage_four display_all! ;