delete_frame

Synopsis

Delete the specified frame.

delete_frame()
delete_frame( [ChipsId] )
delete_frame( "frame_id" )
delete_frame( "all" )

Description

Depending on the argument, the delete_frame command deletes the current frame, the frame indicated in a ChipsId structure or by the frame_id, or all frames.

• (no argument) - the current frame is deleted.
• ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
• frame_id - identification tag given to each object that is created; use this to delete a specific frame.
• all - deletes all frames.

There is also a delete_all_frames command, which removes all frames from the specified window(s). It is equivalent to the command delete_frame("all").

Example 1

chips> add_frame(.1, .1, .5, .5)
chips> set_frame(["bgcolor",red"])
chips> delete_frame()

Create a frame, then delete it.

Example 2

chips> id = ChipsId()
chips> add_frame()
chips> set_frame(["bgcolor",cornflower"])
chips> add_frame()
chips> set_frame(["bgcolor",yellow"])
chips> id.frame = "frm1"
chips> delete_frame(id)

Two frames are created; the second frame is current after it is created. The id.frame command sets the frame value of the ChipsId structure to the first frame, which has the id "frm1" by default. That frame is then deleted.

Example 3

chips> add_frame(.1, .1, .5, .5,"id=data06")
chips> set_frame(["bgcolor","tan"])
chips> add_frame(.5, .5, .9, .9,"id=data05")
chips> set_frame(["bgcolor","white"])
chips> delete_frame("all")

Two frames are created, then the delete_frame command deletes them both.

Example 4

chips> add_frame(.1,.1,.9,.5,'bgcolor=gray')
chips> add_frame(.1,.5,.9,.9,'bgcolor=mediumblue')
chips> delete_all_frames()

Delete all the frames that were created.

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.

See Also

concepts

chipsid, currency

frames

add_frame, arrange_frames, blink_frames, current_frame, display_frame, get_frame, hide_frame, move_frame, next_frame, reposition_frame, set_frame, tile, view_placed_frame, view_single_frame

utilities

erase, get_object_count