IABSD.fr/xenocara/lib/xcb-util-cursor/cursor/xcb_cursor.h

Branch : - branch - master - tag -

• Show log

  Commit

• Author : matthieu
  Date : 2014-04-14 19:28:44
  Hash : 497c9caa
  Message : Import xcb-util-cursor 0.1.1

• lib/xcb-util-cursor/cursor/xcb_cursor.h

• #ifndef XCB_CURSOR_H
  #define XCB_CURSOR_H
  
  /* Copyright © 2013 Michael Stapelberg
   *
   * Permission is hereby granted, free of charge, to any person obtaining a
   * copy of this software and associated documentation files (the "Software"),
   * to deal in the Software without restriction, including without limitation
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   * and/or sell copies of the Software, and to permit persons to whom the
   * Software is furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included in
   * all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
   * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
   * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   *
   * Except as contained in this notice, the names of the authors or their
   * institutions shall not be used in advertising or otherwise to promote the
   * sale, use or other dealings in this Software without prior written
   * authorization from the authors.
   */
  
  #include <xcb/xcb.h>
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @defgroup xcb__cursor_context_t XCB Cursor Functions
   *
   * These functions are the equivalent of libXcursor, but re-implemented for
   * XCB. They respect the user’s configured cursor theme when loading cursors,
   * specified by the X resources setting "Xcursor.theme".
   *
   * Here is how you would use these functions to change the X11 root window
   * cursor to "watch":
   * @code
   * int screennr;
   * xcb_connection_t *conn = xcb_connect(NULL, &screennr);
   * if (conn == NULL || xcb_connection_has_error(conn))
   *     err(EXIT_FAILURE, "Could not connect to X11");
   *
   * xcb_screen_t *screen = xcb_aux_get_screen(conn, screennr);
   * xcb_cursor_context_t *ctx;
   * if (xcb_cursor_context_new(conn, screen, &ctx) < 0)
   *     err(EXIT_FAILURE, "Could not initialize xcb-cursor");
   *
   * xcb_cursor_t cid = xcb_cursor_load_cursor(ctx, "watch");
   *
   * xcb_screen_t *screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
   * xcb_change_window_attributes(conn, screen->root, XCB_CW_CURSOR, (uint32_t[]){ cid });
   * xcb_flush(conn);
   *
   * xcb_cursor_context_free(ctx);
   * xcb_disconnect(conn);
   * @endcode
   *
   * @{
   */
  
  /**
   * @struct xcb_cursor_context_t
   * Describes a context for using this library.
   *
   * Create a context with @ref xcb_cursor_context_new (), then load one or more
   * cursors with @ref xcb_cursor_load_cursor () and destroy the context with @ref
   * xcb_cursor_context_free ().
   */
  typedef struct xcb_cursor_context_t xcb_cursor_context_t;
  
  /**
   * Create a new @ref xcb_cursor_context_t.
   *
   * @param conn A working XCB connection, which will be used until you destroy
   * the context with @ref xcb_cursor_context_free ().
   * @param screen The xcb_screen_t to use (e.g. for getting the RESOURCE_MANAGER
   * contents, for creating cursors on, for using the size as fallback when
   * calculating the best cursor size).
   * @param ctx A pointer to an xcb_cursor_context_t* which will be modified to
   * refer to the newly created context.
   * @return 0 on success, a negative error code otherwise.
   *
   * @ingroup xcb_cursor_context_t
   */
  int xcb_cursor_context_new(xcb_connection_t *conn, xcb_screen_t *screen, xcb_cursor_context_t **ctx);
  
  /**
   * Loads the specified cursor, either from the cursor theme or by falling back
   * to the X11 "cursor" font.
   *
   * @param ctx A cursor context, created with @ref xcb_cursor_context_new ()
   * @param name The name of the cursor to load, e.g. "watch".
   * @returns The ID of the created cursor. When you are done using it, use
   * xcb_free_cursor. Calling @ref xcb_cursor_context_free () will NOT free the
   * created cursor.
   *
   */
  xcb_cursor_t xcb_cursor_load_cursor(xcb_cursor_context_t *ctx, const char *name);
  
  /**
   * Frees the @ref xcb_cursor_context_t.
   *
   * @param ctx The context to free.
   *
   */
  void xcb_cursor_context_free(xcb_cursor_context_t *ctx);
  
  /**
   * @}
   */
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif