home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xresetscreensaver.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  7.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. XSetScreenSaver(3X11)      XLIB FUNCTIONS    XSetScreenSaver(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XSetScreenSaver, XForceScreenSaver, XActivateScreenSaver,
  9.        XResetScreenSaver, XGetScreenSaver - manipulate the screen
  10.        saver
  11.  
  12. SSYYNNTTAAXX
  13.        XSetScreenSaver(_d_i_s_p_l_a_y, _t_i_m_e_o_u_t, _i_n_t_e_r_v_a_l,
  14.        _p_r_e_f_e_r___b_l_a_n_k_i_n_g, _a_l_l_o_w___e_x_p_o_s_u_r_e_s)
  15.          Display *_d_i_s_p_l_a_y;
  16.          int _t_i_m_e_o_u_t, _i_n_t_e_r_v_a_l;
  17.          int _p_r_e_f_e_r___b_l_a_n_k_i_n_g;
  18.          int _a_l_l_o_w___e_x_p_o_s_u_r_e_s;
  19.  
  20.        XForceScreenSaver(_d_i_s_p_l_a_y, _m_o_d_e)
  21.          Display *_d_i_s_p_l_a_y;
  22.          int _m_o_d_e;
  23.  
  24.        XActivateScreenSaver(_d_i_s_p_l_a_y)
  25.          Display *_d_i_s_p_l_a_y;
  26.  
  27.        XResetScreenSaver(_d_i_s_p_l_a_y)
  28.          Display *_d_i_s_p_l_a_y;
  29.  
  30.        XGetScreenSaver(_d_i_s_p_l_a_y, _t_i_m_e_o_u_t___r_e_t_u_r_n, _i_n_t_e_r_v_a_l___r_e_t_u_r_n,
  31.        _p_r_e_f_e_r___b_l_a_n_k_i_n_g___r_e_t_u_r_n,
  32.              _a_l_l_o_w___e_x_p_o_s_u_r_e_s___r_e_t_u_r_n)
  33.          Display *_d_i_s_p_l_a_y;
  34.          int *_t_i_m_e_o_u_t___r_e_t_u_r_n, *_i_n_t_e_r_v_a_l___r_e_t_u_r_n;
  35.          int *_p_r_e_f_e_r___b_l_a_n_k_i_n_g___r_e_t_u_r_n;
  36.          int *_a_l_l_o_w___e_x_p_o_s_u_r_e_s___r_e_t_u_r_n;
  37.  
  38. AARRGGUUMMEENNTTSS
  39.        _a_l_l_o_w___e_x_p_o_s_u_r_e_s
  40.          Specifies the screen save control values.  You
  41.          can pass _D_o_n_t_A_l_l_o_w_E_x_p_o_s_u_r_e_s, _A_l_l_o_w_E_x_p_o_s_u_r_e_s, or
  42.          _D_e_f_a_u_l_t_E_x_p_o_s_u_r_e_s.
  43.  
  44.        _a_l_l_o_w___e_x_p_o_s_u_r_e_s___r_e_t_u_r_n
  45.          Returns the current screen save control value
  46.          (_D_o_n_t_A_l_l_o_w_E_x_p_o_s_u_r_e_s, _A_l_l_o_w_E_x_p_o_s_u_r_e_s, or
  47.          _D_e_f_a_u_l_t_E_x_p_o_s_u_r_e_s).
  48.  
  49.        _d_i_s_p_l_a_y     Specifies the connection to the X server.
  50.  
  51.        _i_n_t_e_r_v_a_l     Specifies the interval, in seconds, between
  52.          screen saver alterations.
  53.  
  54.        _i_n_t_e_r_v_a_l___r_e_t_u_r_n
  55.          Returns the interval between screen saver invo-
  56.          cations.
  57.  
  58.        _m_o_d_e     Specifies the mode that is to be applied.  You
  59.          can pass _S_c_r_e_e_n_S_a_v_e_r_A_c_t_i_v_e or _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t.
  60.  
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XSetScreenSaver(3X11)      XLIB FUNCTIONS    XSetScreenSaver(3X11)
  71.  
  72.  
  73.        _p_r_e_f_e_r___b_l_a_n_k_i_n_g
  74.          Specifies how to enable screen blanking.  You
  75.          can pass _D_o_n_t_P_r_e_f_e_r_B_l_a_n_k_i_n_g, _P_r_e_f_e_r_B_l_a_n_k_i_n_g, or
  76.          _D_e_f_a_u_l_t_B_l_a_n_k_i_n_g.
  77.  
  78.        _p_r_e_f_e_r___b_l_a_n_k_i_n_g___r_e_t_u_r_n
  79.          Returns the current screen blanking preference
  80.          (_D_o_n_t_P_r_e_f_e_r_B_l_a_n_k_i_n_g, _P_r_e_f_e_r_B_l_a_n_k_i_n_g, or
  81.          _D_e_f_a_u_l_t_B_l_a_n_k_i_n_g).
  82.  
  83.        _t_i_m_e_o_u_t     Specifies the timeout, in seconds, until the
  84.          screen saver turns on.
  85.  
  86.        _t_i_m_e_o_u_t___r_e_t_u_r_n
  87.          Returns the timeout, in seconds, until the
  88.          screen saver turns on.
  89.  
  90. DDEESSCCRRIIPPTTIIOONN
  91.        Timeout and interval are specified in seconds.  A timeout
  92.        of 0 disables the screen saver (but an activated screen
  93.        saver is not deactivated), and a timeout of -1 restores
  94.        the default.  Other negative values generate a _B_a_d_V_a_l_u_e
  95.        error.  If the timeout value is nonzero, _X_S_e_t_S_c_r_e_e_n_S_a_v_e_r
  96.        enables the screen saver.  An interval of 0 disables the
  97.        random-pattern motion.  If no input from devices (key-
  98.        board, mouse, and so on) is generated for the specified
  99.        number of timeout seconds once the screen saver is
  100.        enabled, the screen saver is activated.
  101.  
  102.        For each screen, if blanking is preferred and the hardware
  103.        supports video blanking, the screen simply goes blank.
  104.        Otherwise, if either exposures are allowed or the screen
  105.        can be regenerated without sending _E_x_p_o_s_e events to
  106.        clients, the screen is tiled with the root window back-
  107.        ground tile randomly re-origined each interval seconds.
  108.        Otherwise, the screens' state do not change, and the
  109.        screen saver is not activated.  The screen saver is deac-
  110.        tivated, and all screen states are restored at the next
  111.        keyboard or pointer input or at the next call to _X_F_o_r_c_e_-
  112.        _S_c_r_e_e_n_S_a_v_e_r with mode _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t.
  113.  
  114.        If the server-dependent screen saver method supports peri-
  115.        odic change, the interval argument serves as a hint about
  116.        how long the change period should be, and zero hints that
  117.        no periodic change should be made.  Examples of ways to
  118.        change the screen include scrambling the colormap periodi-
  119.        cally, moving an icon image around the screen periodi-
  120.        cally, or tiling the screen with the root window back-
  121.        ground tile, randomly re-origined periodically.
  122.  
  123.        _X_S_e_t_S_c_r_e_e_n_S_a_v_e_r can generate a _B_a_d_V_a_l_u_e error.
  124.  
  125.        If the specified mode is _S_c_r_e_e_n_S_a_v_e_r_A_c_t_i_v_e and the screen
  126.        saver currently is deactivated, _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XSetScreenSaver(3X11)      XLIB FUNCTIONS    XSetScreenSaver(3X11)
  137.  
  138.  
  139.        activates the screen saver even if the screen saver had
  140.        been disabled with a timeout of zero.  If the specified
  141.        mode is _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t and the screen saver currently is
  142.        enabled, _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r deactivates the screen saver if
  143.        it was activated, and the activation timer is reset to its
  144.        initial state (as if device input had been received).
  145.  
  146.        _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r can generate a _B_a_d_V_a_l_u_e error.
  147.  
  148.        The _X_A_c_t_i_v_a_t_e_S_c_r_e_e_n_S_a_v_e_r function activates the screen
  149.        saver.
  150.  
  151.        The _X_R_e_s_e_t_S_c_r_e_e_n_S_a_v_e_r function resets the screen saver.
  152.  
  153.        The _X_G_e_t_S_c_r_e_e_n_S_a_v_e_r function gets the current screen saver
  154.        values.
  155.  
  156. DDIIAAGGNNOOSSTTIICCSS
  157.        _B_a_d_V_a_l_u_e     Some numeric value falls outside the range of
  158.          values accepted by the request.  Unless a spe-
  159.          cific range is specified for an argument, the
  160.          full range defined by the argument's type is
  161.          accepted.  Any argument defined as a set of
  162.          alternatives can generate this error.
  163.  
  164. SSEEEE AALLSSOO
  165.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.