include/SDL_hints.h
changeset 8576 8dd593afe2d7
parent 8543 b9dd3cf38585
child 8577 462760a8b82e
     1.1 --- a/include/SDL_hints.h	Mon Dec 30 11:59:04 2013 -0500
     1.2 +++ b/include/SDL_hints.h	Wed Jan 01 16:05:37 2014 -0500
     1.3 @@ -332,6 +332,53 @@
     1.4  #define SDL_HINT_VIDEO_WIN_D3DCOMPILER              "SDL_VIDEO_WIN_D3DCOMPILER"
     1.5  
     1.6  /**
     1.7 + *  \brief A URL to a WinRT app's privacy policy
     1.8 + *
     1.9 + *  All network-enabled WinRT apps must make a privacy policy available to its
    1.10 + *  users.  On Windows 8, 8.1, and RT, Microsoft mandates that this policy be
    1.11 + *  be available in the Windows Settings charm, as accessed from within the app.
    1.12 + *  SDL provides code to add a URL-based link there, which can point to the app's
    1.13 + *  privacy policy.
    1.14 + *
    1.15 + *  To setup a URL to an app's privacy policy, set SDL_HINT_WINRT_PRIVACY_POLICY_URL
    1.16 + *  before calling any SDL_Init functions.  The contents of the hint should
    1.17 + *  be a valid URL.  For example, "http://www.example.com".
    1.18 + *
    1.19 + *  The default value is "", which will prevent SDL from adding a privacy policy
    1.20 + *  link to the Settings charm.  This hint should only be set during app init.
    1.21 + *
    1.22 + *  The label text of an app's "Privacy Policy" link may be customized via another
    1.23 + *  hint, SDL_HINT_WINRT_PRIVACY_POLICY_LABEL.
    1.24 + *
    1.25 + *  Please note that on Windows Phone, Microsoft does not provide standard UI
    1.26 + *  for displaying a privacy policy link, and as such, SDL_HINT_WINRT_PRIVACY_POLICY_URL
    1.27 + *  will not get used on that platform.  Network-enabled phone apps should display
    1.28 + *  their privacy policy through some other, in-app means.
    1.29 + */
    1.30 +#define SDL_HINT_WINRT_PRIVACY_POLICY_URL "SDL_HINT_WINRT_PRIVACY_POLICY_URL"
    1.31 +
    1.32 +/** \brief Label text for a WinRT app's privacy policy link
    1.33 + *
    1.34 + *  Network-enabled WinRT apps must include a privacy policy.  On Windows 8, 8.1, and RT,
    1.35 + *  Microsoft mandates that this policy be available via the Windows Settings charm.
    1.36 + *  SDL provides code to add a link there, with it's label text being set via the
    1.37 + *  optional hint, SDL_HINT_WINRT_PRIVACY_POLICY_LABEL.
    1.38 + *
    1.39 + *  Please note that a privacy policy's contents are not set via this hint.  A separate
    1.40 + *  hint, SDL_HINT_WINRT_PRIVACY_POLICY_URL, is used to link to the actual text of the
    1.41 + *  policy.
    1.42 + *
    1.43 + *  The contents of this hint should be encoded as a UTF8 string.
    1.44 + *
    1.45 + *  The default value is "Privacy Policy".  This hint should only be set during app
    1.46 + *  initialization, preferably before any calls to SDL_Init.
    1.47 + *
    1.48 + *  For additional information on linking to a privacy policy, see the documentation for
    1.49 + *  SDL_HINT_WINRT_PRIVACY_POLICY_URL.
    1.50 + */
    1.51 +#define SDL_HINT_WINRT_PRIVACY_POLICY_LABEL "SDL_HINT_WINRT_PRIVACY_POLICY_LABEL"
    1.52 +
    1.53 +/**
    1.54   *  \brief  An enumeration of hint priorities
    1.55   */
    1.56  typedef enum