Subversion Repositories Kolibri OS

Rev

Blame | Last modification | View Log | RSS feed

  1. <HTML
  2. ><HEAD
  3. ><TITLE
  4. >SDL_WM_IconifyWindow</TITLE
  5. ><META
  6. NAME="GENERATOR"
  7. CONTENT="Modular DocBook HTML Stylesheet Version 1.64
  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. WIDTH="100%"
  32. BORDER="0"
  33. CELLPADDING="0"
  34. CELLSPACING="0"
  35. ><TR
  36. ><TH
  37. COLSPAN="3"
  38. ALIGN="center"
  39. >SDL Library Documentation</TH
  40. ></TR
  41. ><TR
  42. ><TD
  43. WIDTH="10%"
  44. ALIGN="left"
  45. VALIGN="bottom"
  46. ><A
  47. HREF="sdlwmseticon.html"
  48. >Prev</A
  49. ></TD
  50. ><TD
  51. WIDTH="80%"
  52. ALIGN="center"
  53. VALIGN="bottom"
  54. ></TD
  55. ><TD
  56. WIDTH="10%"
  57. ALIGN="right"
  58. VALIGN="bottom"
  59. ><A
  60. HREF="sdlwmtogglefullscreen.html"
  61. >Next</A
  62. ></TD
  63. ></TR
  64. ></TABLE
  65. ><HR
  66. ALIGN="LEFT"
  67. WIDTH="100%"></DIV
  68. ><H1
  69. ><A
  70. NAME="SDLWMICONIFYWINDOW"
  71. >SDL_WM_IconifyWindow</A
  72. ></H1
  73. ><DIV
  74. CLASS="REFNAMEDIV"
  75. ><A
  76. NAME="AEN3195"
  77. ></A
  78. ><H2
  79. >Name</H2
  80. >SDL_WM_IconifyWindow&nbsp;--&nbsp;Iconify/Minimise the window</DIV
  81. ><DIV
  82. CLASS="REFSYNOPSISDIV"
  83. ><A
  84. NAME="AEN3198"
  85. ></A
  86. ><H2
  87. >Synopsis</H2
  88. ><DIV
  89. CLASS="FUNCSYNOPSIS"
  90. ><A
  91. NAME="AEN3199"
  92. ></A
  93. ><P
  94. ></P
  95. ><PRE
  96. CLASS="FUNCSYNOPSISINFO"
  97. >#include "SDL.h"</PRE
  98. ><P
  99. ><CODE
  100. ><CODE
  101. CLASS="FUNCDEF"
  102. >int <B
  103. CLASS="FSFUNC"
  104. >SDL_WM_IconifyWindow</B
  105. ></CODE
  106. >(void);</CODE
  107. ></P
  108. ><P
  109. ></P
  110. ></DIV
  111. ></DIV
  112. ><DIV
  113. CLASS="REFSECT1"
  114. ><A
  115. NAME="AEN3205"
  116. ></A
  117. ><H2
  118. >Description</H2
  119. ><P
  120. >If the application is running in a window managed environment SDL attempts to iconify/minimise it. If <TT
  121. CLASS="FUNCTION"
  122. >SDL_WM_IconifyWindow</TT
  123. > is successful, the application will receive a <A
  124. HREF="sdlactiveevent.html"
  125. ><TT
  126. CLASS="LITERAL"
  127. >SDL_APPACTIVE</TT
  128. ></A
  129. > loss event.</P
  130. ></DIV
  131. ><DIV
  132. CLASS="REFSECT1"
  133. ><A
  134. NAME="AEN3211"
  135. ></A
  136. ><H2
  137. >Return Value</H2
  138. ><P
  139. >Returns non-zero on success or <SPAN
  140. CLASS="RETURNVALUE"
  141. >0</SPAN
  142. > if iconification is not support or was refused by the window manager.</P
  143. ></DIV
  144. ><DIV
  145. CLASS="NAVFOOTER"
  146. ><HR
  147. ALIGN="LEFT"
  148. WIDTH="100%"><TABLE
  149. WIDTH="100%"
  150. BORDER="0"
  151. CELLPADDING="0"
  152. CELLSPACING="0"
  153. ><TR
  154. ><TD
  155. WIDTH="33%"
  156. ALIGN="left"
  157. VALIGN="top"
  158. ><A
  159. HREF="sdlwmseticon.html"
  160. >Prev</A
  161. ></TD
  162. ><TD
  163. WIDTH="34%"
  164. ALIGN="center"
  165. VALIGN="top"
  166. ><A
  167. HREF="index.html"
  168. >Home</A
  169. ></TD
  170. ><TD
  171. WIDTH="33%"
  172. ALIGN="right"
  173. VALIGN="top"
  174. ><A
  175. HREF="sdlwmtogglefullscreen.html"
  176. >Next</A
  177. ></TD
  178. ></TR
  179. ><TR
  180. ><TD
  181. WIDTH="33%"
  182. ALIGN="left"
  183. VALIGN="top"
  184. >SDL_WM_SetIcon</TD
  185. ><TD
  186. WIDTH="34%"
  187. ALIGN="center"
  188. VALIGN="top"
  189. ><A
  190. HREF="wm.html"
  191. >Up</A
  192. ></TD
  193. ><TD
  194. WIDTH="33%"
  195. ALIGN="right"
  196. VALIGN="top"
  197. >SDL_WM_ToggleFullScreen</TD
  198. ></TR
  199. ></TABLE
  200. ></DIV
  201. ></BODY
  202. ></HTML
  203. >