Function: iconify-frame

iconify-frame is an interactive function defined in frame.c.

Signature

(iconify-frame &optional FRAME)

Documentation

Make the frame FRAME into an icon.

If omitted, FRAME defaults to the currently selected frame.

If FRAME is a child frame, consult the variable iconify-child-frame for how to proceed.

View in manual

Probably introduced at or before Emacs version 19.29.

Key Bindings

Source Code

// Defined in /usr/src/emacs/src/frame.c
{
  struct frame *f = decode_live_frame (frame);

  if (FRAME_PARENT_FRAME (f))
    {
      if (NILP (iconify_child_frame))
	/* Do nothing.  */
	return Qnil;
      else if (FRAME_WINDOW_P (f)
	       && EQ (iconify_child_frame, Qiconify_top_level))
	{
	  /* Iconify root frame (the default).  */
	  Lisp_Object root;

	  XSETFRAME (root, root_frame (f));
	  Ficonify_frame (root);

	  return Qnil;
	}
      else if (EQ (iconify_child_frame, Qmake_invisible))
	{
	  /* Make frame invisible.  */
	  Fmake_frame_invisible (frame, Qnil);

	  return Qnil;
	}
    }

  if (FRAME_WINDOW_P (f) && FRAME_TERMINAL (f)->iconify_frame_hook)
    FRAME_TERMINAL (f)->iconify_frame_hook (f);

  return Qnil;
}