Mercurial > sdl-ios-xcode

<HTML
><HEAD
><TITLE
>SDL_WM_IconifyWindow</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Window Management"
HREF="wm.html"><LINK
REL="PREVIOUS"
TITLE="SDL_WM_SetIcon"
HREF="sdlwmseticon.html"><LINK
REL="NEXT"
TITLE="SDL_WM_ToggleFullScreen"
HREF="sdlwmtogglefullscreen.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlwmseticon.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlwmtogglefullscreen.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLWMICONIFYWINDOW"
></A
>SDL_WM_IconifyWindow</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3617"
></A
><H2
>Name</H2
>SDL_WM_IconifyWindow&nbsp;--&nbsp;Iconify/Minimise the window</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3620"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN3621"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="FSFUNC"
>SDL_WM_IconifyWindow</B
></CODE
>(void);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3627"
></A
><H2
>Description</H2
><P
>If the application is running in a window managed environment SDL attempts to iconify/minimise it. If <TT
CLASS="FUNCTION"
>SDL_WM_IconifyWindow</TT
> is successful, the application will receive a <A
HREF="sdlactiveevent.html"
><TT
CLASS="LITERAL"
>SDL_APPACTIVE</TT
></A
> loss event.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3633"
></A
><H2
>Return Value</H2
><P
>Returns non-zero on success or <SPAN
CLASS="RETURNVALUE"
>0</SPAN
> if iconification is not support or was refused by the window manager.</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlwmseticon.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlwmtogglefullscreen.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_WM_SetIcon</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="wm.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_WM_ToggleFullScreen</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
author	Ryan C. Gordon <icculus@icculus.org>
date	Mon, 01 Dec 2008 09:09:31 +0000
parents	355632dca928
children