gtk/gdk/x11/gdkx11display.h
Matthias Clasen fff2b3c710 gdk: Clean up docs syntax
Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-22 17:25:26 -04:00

137 lines
5.1 KiB
C

/* GDK - The GIMP Drawing Kit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#ifndef __GDK_X11_DISPLAY_H__
#define __GDK_X11_DISPLAY_H__
#if !defined (__GDKX_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gdk/x11/gdkx.h> can be included directly."
#endif
#include <gdk/gdk.h>
#include <gdk/x11/gdkx11screen.h>
#include <X11/Xlib.h>
#include <X11/Xutil.h>
G_BEGIN_DECLS
#ifdef GTK_COMPILATION
typedef struct _GdkX11Display GdkX11Display;
#else
typedef GdkDisplay GdkX11Display;
#endif
typedef struct _GdkX11DisplayClass GdkX11DisplayClass;
#define GDK_TYPE_X11_DISPLAY (gdk_x11_display_get_type())
#define GDK_X11_DISPLAY(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_X11_DISPLAY, GdkX11Display))
#define GDK_X11_DISPLAY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_X11_DISPLAY, GdkX11DisplayClass))
#define GDK_IS_X11_DISPLAY(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_X11_DISPLAY))
#define GDK_IS_X11_DISPLAY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_X11_DISPLAY))
#define GDK_X11_DISPLAY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_X11_DISPLAY, GdkX11DisplayClass))
GDK_AVAILABLE_IN_ALL
GType gdk_x11_display_get_type (void);
GDK_AVAILABLE_IN_ALL
GdkDisplay * gdk_x11_display_open (const char *display_name);
GDK_AVAILABLE_IN_ALL
Display * gdk_x11_display_get_xdisplay (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
Screen * gdk_x11_display_get_xscreen (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
Window gdk_x11_display_get_xrootwindow (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
Cursor gdk_x11_display_get_xcursor (GdkDisplay *display,
GdkCursor *cursor);
/**
* GDK_DISPLAY_XDISPLAY:
* @display: a `GdkDisplay`
*
* Returns the display of a `GdkDisplay`.
*
* Returns: an Xlib Display*
*/
#define GDK_DISPLAY_XDISPLAY(display) (gdk_x11_display_get_xdisplay (display))
GDK_AVAILABLE_IN_ALL
guint32 gdk_x11_display_get_user_time (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
const char * gdk_x11_display_get_startup_notification_id (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
void gdk_x11_display_set_startup_notification_id (GdkDisplay *display,
const char *startup_id);
GDK_AVAILABLE_IN_ALL
void gdk_x11_display_set_program_class (GdkDisplay *display,
const char *program_class);
GDK_AVAILABLE_IN_ALL
void gdk_x11_display_set_cursor_theme (GdkDisplay *display,
const char *theme,
const int size);
GDK_AVAILABLE_IN_ALL
void gdk_x11_display_broadcast_startup_message (GdkDisplay *display,
const char *message_type,
...) G_GNUC_NULL_TERMINATED;
GDK_AVAILABLE_IN_ALL
GdkDisplay *gdk_x11_lookup_xdisplay (Display *xdisplay);
GDK_AVAILABLE_IN_ALL
GdkX11Screen *gdk_x11_display_get_screen (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
GdkMonitor * gdk_x11_display_get_primary_monitor (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
void gdk_x11_display_grab (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
void gdk_x11_display_ungrab (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
void gdk_x11_display_set_surface_scale (GdkDisplay *display,
int scale);
GDK_AVAILABLE_IN_ALL
void gdk_x11_display_error_trap_push (GdkDisplay *display);
/* warn unused because you could use pop_ignored otherwise */
GDK_AVAILABLE_IN_ALL
G_GNUC_WARN_UNUSED_RESULT int gdk_x11_display_error_trap_pop (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
void gdk_x11_display_error_trap_pop_ignored (GdkDisplay *display);
GDK_AVAILABLE_IN_ALL
void gdk_x11_set_sm_client_id (const char *sm_client_id);
GDK_AVAILABLE_IN_ALL
GdkSurface * gdk_x11_display_get_default_group (GdkDisplay *display);
G_END_DECLS
#endif /* __GDK_X11_DISPLAY_H__ */