gtk-handle-box-snap-edge (object)

object -- a gtk-handle-box widget
edge -- a value of the gtk-position-type enumeration

Accessor of the snap-edge slot of the gtk-handle-box class.

The slot access function gtk-handle-box-snap-edge gets the edge used for determining reattachment of the handle box. The slot access function (setf gtk-handle-box-snap-edge) sets the snap edge.

The snap edge is the edge of the detached child that must be aligned with the corresponding edge of the "ghost" left behind when the child was detached to reattach the torn-off window. Usually, the snap edge should be chosen so that it stays in the same place on the screen when the handle box is torn off.

If the snap edge is not set, then an appropriate value will be guessed from the handle position. If the handle position is :right or :left, then the snap edge will be :top, otherwise it will be :left. The function gtk-handle-box-snap-edge has been deprecated since version 3.4 and should not be used in newly written code. The gtk-handle-box widget has been deprecated.