Source

pygame / doc / src / sdlwm.xml

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE module SYSTEM "api.dtd">

<module name="pygame2.sdl.wm">
  <short>SDL window manager wrapper module</short>
  <desc>Pygame SDL window manager wrapper module.</desc>

  <func name="get_caption">
    <call>get_caption () -> str, str</call>
    <desc>Gets the caption of the current SDL window.
    
      Gets the title-bar caption and icon name (if any) of the display
      window. If not set, any of the values might be None.
    </desc>
  </func>
  <func name="get_info">
    <call>get_info () -> dict</call>
    <desc>
      Gets operating system and window manager specific information about the
      current SDL window.
    </desc>
  </func>
  <func name="grab_input">
    <call>grab_input (mode) -> int</call>
    <desc>
      Advices the window manager to let the window grab the mouse and keyboard
      input focus (or release it). The function returns the previously set mode.
    </desc>
  </func>
  <func name="iconify_window">
    <call>iconify_window () -> bool</call>
    <desc>
      Advices the window manager to iconify the window and returns, whether the
      operation was successful or not.
    </desc>
  </func>
  <func name="set_caption">
    <call>set_caption (title[, iconname]) -> None</call>
    <desc>Sets the caption of the current SDL window.
    
      Sets the title-bar caption and optional icon name (or description)
      of the display window.
    </desc>
  </func>
  <func name="set_icon">
    <call>set_icon (surface[, mask]) -> None</call>
    <desc>
      Sets the window manager icon to be used by the window.
    </desc>
  </func>
  <func name="toggle_fullscreen">
    <call>toggle_fullscren (bool) -> bool</call>
    <desc>
      Tries to toggle the fullscreen mode for the SDL window and
      returns, whether the operation was successful or not.
    </desc>
  </func>
</module>