include/SDL_keyboard.h
changeset 7191 75360622e65f
parent 6885 700f1b25f77f
child 7258 89d47188c9a4
     1.1 --- a/include/SDL_keyboard.h	Sat May 18 12:48:50 2013 -0700
     1.2 +++ b/include/SDL_keyboard.h	Sat May 18 14:17:52 2013 -0700
     1.3 @@ -21,7 +21,7 @@
     1.4  
     1.5  /**
     1.6   *  \file SDL_keyboard.h
     1.7 - *  
     1.8 + *
     1.9   *  Include file for SDL keyboard event handling
    1.10   */
    1.11  
    1.12 @@ -36,9 +36,7 @@
    1.13  #include "begin_code.h"
    1.14  /* Set up for C function definitions, even when using C++ */
    1.15  #ifdef __cplusplus
    1.16 -/* *INDENT-OFF* */
    1.17  extern "C" {
    1.18 -/* *INDENT-ON* */
    1.19  #endif
    1.20  
    1.21  /**
    1.22 @@ -61,11 +59,11 @@
    1.23  
    1.24  /**
    1.25   *  \brief Get a snapshot of the current state of the keyboard.
    1.26 - *  
    1.27 + *
    1.28   *  \param numkeys if non-NULL, receives the length of the returned array.
    1.29 - *  
    1.30 + *
    1.31   *  \return An array of key states. Indexes into this array are obtained by using ::SDL_Scancode values.
    1.32 - *  
    1.33 + *
    1.34   *  \b Example:
    1.35   *  \code
    1.36   *  Uint8 *state = SDL_GetKeyboardState(NULL);
    1.37 @@ -83,7 +81,7 @@
    1.38  
    1.39  /**
    1.40   *  \brief Set the current key modifier state for the keyboard.
    1.41 - *  
    1.42 + *
    1.43   *  \note This does not change the keyboard state, only the key modifier flags.
    1.44   */
    1.45  extern DECLSPEC void SDLCALL SDL_SetModState(SDL_Keymod modstate);
    1.46 @@ -91,9 +89,9 @@
    1.47  /**
    1.48   *  \brief Get the key code corresponding to the given scancode according
    1.49   *         to the current keyboard layout.
    1.50 - *  
    1.51 + *
    1.52   *  See ::SDL_Keycode for details.
    1.53 - *  
    1.54 + *
    1.55   *  \sa SDL_GetKeyName()
    1.56   */
    1.57  extern DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scancode);
    1.58 @@ -101,16 +99,16 @@
    1.59  /**
    1.60   *  \brief Get the scancode corresponding to the given key code according to the
    1.61   *         current keyboard layout.
    1.62 - *  
    1.63 + *
    1.64   *  See ::SDL_Scancode for details.
    1.65 - *  
    1.66 + *
    1.67   *  \sa SDL_GetScancodeName()
    1.68   */
    1.69  extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key);
    1.70  
    1.71  /**
    1.72   *  \brief Get a human-readable name for a scancode.
    1.73 - *  
    1.74 + *
    1.75   *  \return A pointer to the name for the scancode.
    1.76   *          If the scancode doesn't have a name, this function returns
    1.77   *          an empty string ("").
    1.78 @@ -121,7 +119,7 @@
    1.79  
    1.80  /**
    1.81   *  \brief Get a scancode from a human-readable name
    1.82 - *  
    1.83 + *
    1.84   *  \return scancode, or SDL_SCANCODE_UNKNOWN if the name wasn't recognized
    1.85   *
    1.86   *  \sa SDL_Scancode
    1.87 @@ -130,19 +128,19 @@
    1.88  
    1.89  /**
    1.90   *  \brief Get a human-readable name for a key.
    1.91 - *  
    1.92 + *
    1.93   *  \return A pointer to a UTF-8 string that stays valid at least until the next
    1.94 - *          call to this function. If you need it around any longer, you must 
    1.95 - *          copy it.  If the key doesn't have a name, this function returns an 
    1.96 + *          call to this function. If you need it around any longer, you must
    1.97 + *          copy it.  If the key doesn't have a name, this function returns an
    1.98   *          empty string ("").
    1.99 - *  
   1.100 + *
   1.101   *  \sa SDL_Key
   1.102   */
   1.103  extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDL_Keycode key);
   1.104  
   1.105  /**
   1.106   *  \brief Get a key code from a human-readable name
   1.107 - *  
   1.108 + *
   1.109   *  \return key code, or SDLK_UNKNOWN if the name wasn't recognized
   1.110   *
   1.111   *  \sa SDL_Keycode
   1.112 @@ -152,7 +150,7 @@
   1.113  /**
   1.114   *  \brief Start accepting Unicode text input events.
   1.115   *         This function will show the on-screen keyboard if supported.
   1.116 - *  
   1.117 + *
   1.118   *  \sa SDL_StopTextInput()
   1.119   *  \sa SDL_SetTextInputRect()
   1.120   *  \sa SDL_HasScreenKeyboardSupport()
   1.121 @@ -170,7 +168,7 @@
   1.122  /**
   1.123   *  \brief Stop receiving any text input events.
   1.124   *         This function will hide the on-screen keyboard if supported.
   1.125 - *  
   1.126 + *
   1.127   *  \sa SDL_StartTextInput()
   1.128   *  \sa SDL_HasScreenKeyboardSupport()
   1.129   */
   1.130 @@ -179,38 +177,36 @@
   1.131  /**
   1.132   *  \brief Set the rectangle used to type Unicode text inputs.
   1.133   *         This is used as a hint for IME and on-screen keyboard placement.
   1.134 - *  
   1.135 + *
   1.136   *  \sa SDL_StartTextInput()
   1.137   */
   1.138  extern DECLSPEC void SDLCALL SDL_SetTextInputRect(SDL_Rect *rect);
   1.139  
   1.140  /**
   1.141   *  \brief Returns whether the platform has some screen keyboard support.
   1.142 - *  
   1.143 + *
   1.144   *  \return SDL_TRUE if some keyboard support is available else SDL_FALSE.
   1.145 - *  
   1.146 + *
   1.147   *  \note Not all screen keyboard functions are supported on all platforms.
   1.148 - *  
   1.149 + *
   1.150   *  \sa SDL_IsScreenKeyboardShown()
   1.151   */
   1.152  extern DECLSPEC SDL_bool SDLCALL SDL_HasScreenKeyboardSupport(void);
   1.153  
   1.154  /**
   1.155   *  \brief Returns whether the screen keyboard is shown for given window.
   1.156 - *  
   1.157 + *
   1.158   *  \param window The window for which screen keyboard should be queried.
   1.159 - *  
   1.160 + *
   1.161   *  \return SDL_TRUE if screen keyboard is shown else SDL_FALSE.
   1.162 - *  
   1.163 + *
   1.164   *  \sa SDL_HasScreenKeyboardSupport()
   1.165   */
   1.166  extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenKeyboardShown(SDL_Window *window);
   1.167  
   1.168  /* Ends C function definitions when using C++ */
   1.169  #ifdef __cplusplus
   1.170 -/* *INDENT-OFF* */
   1.171  }
   1.172 -/* *INDENT-ON* */
   1.173  #endif
   1.174  #include "close_code.h"
   1.175