Home | History | Annotate | Download | only in html
      1 <HTML
      2 ><HEAD
      3 ><TITLE
      4 >SDL_WM_IconifyWindow</TITLE
      5 ><META
      6 NAME="GENERATOR"
      7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
      8 "><LINK
      9 REL="HOME"
     10 TITLE="SDL Library Documentation"
     11 HREF="index.html"><LINK
     12 REL="UP"
     13 TITLE="Window Management"
     14 HREF="wm.html"><LINK
     15 REL="PREVIOUS"
     16 TITLE="SDL_WM_SetIcon"
     17 HREF="sdlwmseticon.html"><LINK
     18 REL="NEXT"
     19 TITLE="SDL_WM_ToggleFullScreen"
     20 HREF="sdlwmtogglefullscreen.html"></HEAD
     21 ><BODY
     22 CLASS="REFENTRY"
     23 BGCOLOR="#FFF8DC"
     24 TEXT="#000000"
     25 LINK="#0000ee"
     26 VLINK="#551a8b"
     27 ALINK="#ff0000"
     28 ><DIV
     29 CLASS="NAVHEADER"
     30 ><TABLE
     31 SUMMARY="Header navigation table"
     32 WIDTH="100%"
     33 BORDER="0"
     34 CELLPADDING="0"
     35 CELLSPACING="0"
     36 ><TR
     37 ><TH
     38 COLSPAN="3"
     39 ALIGN="center"
     40 >SDL Library Documentation</TH
     41 ></TR
     42 ><TR
     43 ><TD
     44 WIDTH="10%"
     45 ALIGN="left"
     46 VALIGN="bottom"
     47 ><A
     48 HREF="sdlwmseticon.html"
     49 ACCESSKEY="P"
     50 >Prev</A
     51 ></TD
     52 ><TD
     53 WIDTH="80%"
     54 ALIGN="center"
     55 VALIGN="bottom"
     56 ></TD
     57 ><TD
     58 WIDTH="10%"
     59 ALIGN="right"
     60 VALIGN="bottom"
     61 ><A
     62 HREF="sdlwmtogglefullscreen.html"
     63 ACCESSKEY="N"
     64 >Next</A
     65 ></TD
     66 ></TR
     67 ></TABLE
     68 ><HR
     69 ALIGN="LEFT"
     70 WIDTH="100%"></DIV
     71 ><H1
     72 ><A
     73 NAME="SDLWMICONIFYWINDOW"
     74 ></A
     75 >SDL_WM_IconifyWindow</H1
     76 ><DIV
     77 CLASS="REFNAMEDIV"
     78 ><A
     79 NAME="AEN3617"
     80 ></A
     81 ><H2
     82 >Name</H2
     83 >SDL_WM_IconifyWindow&nbsp;--&nbsp;Iconify/Minimise the window</DIV
     84 ><DIV
     85 CLASS="REFSYNOPSISDIV"
     86 ><A
     87 NAME="AEN3620"
     88 ></A
     89 ><H2
     90 >Synopsis</H2
     91 ><DIV
     92 CLASS="FUNCSYNOPSIS"
     93 ><A
     94 NAME="AEN3621"
     95 ></A
     96 ><P
     97 ></P
     98 ><PRE
     99 CLASS="FUNCSYNOPSISINFO"
    100 >#include "SDL.h"</PRE
    101 ><P
    102 ><CODE
    103 ><CODE
    104 CLASS="FUNCDEF"
    105 >int <B
    106 CLASS="FSFUNC"
    107 >SDL_WM_IconifyWindow</B
    108 ></CODE
    109 >(void);</CODE
    110 ></P
    111 ><P
    112 ></P
    113 ></DIV
    114 ></DIV
    115 ><DIV
    116 CLASS="REFSECT1"
    117 ><A
    118 NAME="AEN3627"
    119 ></A
    120 ><H2
    121 >Description</H2
    122 ><P
    123 >If the application is running in a window managed environment SDL attempts to iconify/minimise it. If <TT
    124 CLASS="FUNCTION"
    125 >SDL_WM_IconifyWindow</TT
    126 > is successful, the application will receive a <A
    127 HREF="sdlactiveevent.html"
    128 ><TT
    129 CLASS="LITERAL"
    130 >SDL_APPACTIVE</TT
    131 ></A
    132 > loss event.</P
    133 ></DIV
    134 ><DIV
    135 CLASS="REFSECT1"
    136 ><A
    137 NAME="AEN3633"
    138 ></A
    139 ><H2
    140 >Return Value</H2
    141 ><P
    142 >Returns non-zero on success or <SPAN
    143 CLASS="RETURNVALUE"
    144 >0</SPAN
    145 > if iconification is not support or was refused by the window manager.</P
    146 ></DIV
    147 ><DIV
    148 CLASS="NAVFOOTER"
    149 ><HR
    150 ALIGN="LEFT"
    151 WIDTH="100%"><TABLE
    152 SUMMARY="Footer navigation table"
    153 WIDTH="100%"
    154 BORDER="0"
    155 CELLPADDING="0"
    156 CELLSPACING="0"
    157 ><TR
    158 ><TD
    159 WIDTH="33%"
    160 ALIGN="left"
    161 VALIGN="top"
    162 ><A
    163 HREF="sdlwmseticon.html"
    164 ACCESSKEY="P"
    165 >Prev</A
    166 ></TD
    167 ><TD
    168 WIDTH="34%"
    169 ALIGN="center"
    170 VALIGN="top"
    171 ><A
    172 HREF="index.html"
    173 ACCESSKEY="H"
    174 >Home</A
    175 ></TD
    176 ><TD
    177 WIDTH="33%"
    178 ALIGN="right"
    179 VALIGN="top"
    180 ><A
    181 HREF="sdlwmtogglefullscreen.html"
    182 ACCESSKEY="N"
    183 >Next</A
    184 ></TD
    185 ></TR
    186 ><TR
    187 ><TD
    188 WIDTH="33%"
    189 ALIGN="left"
    190 VALIGN="top"
    191 >SDL_WM_SetIcon</TD
    192 ><TD
    193 WIDTH="34%"
    194 ALIGN="center"
    195 VALIGN="top"
    196 ><A
    197 HREF="wm.html"
    198 ACCESSKEY="U"
    199 >Up</A
    200 ></TD
    201 ><TD
    202 WIDTH="33%"
    203 ALIGN="right"
    204 VALIGN="top"
    205 >SDL_WM_ToggleFullScreen</TD
    206 ></TR
    207 ></TABLE
    208 ></DIV
    209 ></BODY
    210 ></HTML
    211 >