mirror of
https://gitlab.gnome.org/GNOME/gtk.git
synced 2024-11-10 02:40:11 +00:00
gdk: Documentation fixups
Document some missing symbols.
This commit is contained in:
parent
3d7c1f8950
commit
61c83f9ffe
@ -93,7 +93,6 @@ gdk_display_get_clipboard
|
||||
gdk_display_get_primary_clipboard
|
||||
gdk_display_get_setting
|
||||
gdk_display_get_startup_notification_id
|
||||
gdk_display_setup_window_visual
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_display_put_event
|
||||
@ -502,6 +501,7 @@ gdk_event_get_position
|
||||
gdk_event_get_axes
|
||||
gdk_event_get_axis
|
||||
gdk_event_get_pointer_emulated
|
||||
gdk_event_triggers_context_menu
|
||||
gdk_button_event_get_button
|
||||
gdk_scroll_event_get_direction
|
||||
gdk_scroll_event_get_deltas
|
||||
@ -520,6 +520,7 @@ gdk_crossing_event_get_mode
|
||||
gdk_crossing_event_get_detail
|
||||
gdk_crossing_event_get_focus
|
||||
gdk_grab_broken_event_get_grab_surface
|
||||
gdk_grab_broken_event_get_implicit
|
||||
gdk_dnd_event_get_drop
|
||||
gdk_configure_event_get_size
|
||||
gdk_touchpad_event_get_gesture_phase
|
||||
@ -545,8 +546,23 @@ GDK_TYPE_CROSSING_MODE
|
||||
GDK_TYPE_SCROLL_DIRECTION
|
||||
GDK_TYPE_NOTIFY_TYPE
|
||||
GDK_IS_EVENT
|
||||
|
||||
gdk_event_get_type
|
||||
gdk_event_sequence_get_type
|
||||
gdk_button_event_get_type
|
||||
gdk_configure_event_get_type
|
||||
gdk_crossing_event_get_type
|
||||
gdk_delete_event_get_type
|
||||
gdk_dnd_event_get_type
|
||||
gdk_focus_event_get_type
|
||||
gdk_grab_broken_event_get_type
|
||||
gdk_key_event_get_type
|
||||
gdk_motion_event_get_type
|
||||
gdk_pad_event_get_type
|
||||
gdk_proximity_event_get_type
|
||||
gdk_scroll_event_get_type
|
||||
gdk_touch_event_get_type
|
||||
gdk_touchpad_event_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
|
@ -27,15 +27,19 @@ private_headers = [
|
||||
'gdkmonitorprivate.h',
|
||||
'gdkmemorytextureprivate.h',
|
||||
'gdkpipeiostreamprivate.h',
|
||||
'gdkpopupprivate.h',
|
||||
'gdkprofilerprivate.h',
|
||||
'gdkscreenprivate.h',
|
||||
'gdkseatdefaultprivate.h',
|
||||
'gdkseatprivate.h',
|
||||
'gdksnapshotprivate.h',
|
||||
'gdksurfaceimpl.h',
|
||||
'gdksurfaceprivate.h',
|
||||
'gdktextureprivate.h',
|
||||
'gdktoplevelprivate.h',
|
||||
'gdkvulkancontextprivate.h',
|
||||
'keyname-table.h',
|
||||
'gdkprivate-x11.h',
|
||||
'x11/gdkprivate-x11.h',
|
||||
'x11/gdkeventsource.h',
|
||||
'gtk-primary-selection-client-protocol.h',
|
||||
'gtk-shell-client-protocol.h',
|
||||
|
@ -1775,6 +1775,15 @@ gdk_device_get_device_tool (GdkDevice *device)
|
||||
return device->last_tool;
|
||||
}
|
||||
|
||||
/**
|
||||
* gdk_device_get_caps_lock_state:
|
||||
* @device: a #GdkDevice
|
||||
*
|
||||
* Retrieves whether the Caps Lock modifier of the
|
||||
* keyboard is locked, if @device is a keyboard device.
|
||||
*
|
||||
* Returns: %TRUE if Caps Lock is on for @device
|
||||
*/
|
||||
gboolean
|
||||
gdk_device_get_caps_lock_state (GdkDevice *device)
|
||||
{
|
||||
@ -1786,6 +1795,15 @@ gdk_device_get_caps_lock_state (GdkDevice *device)
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* gdk_device_get_num_lock_state:
|
||||
* @device: a #GdkDevice
|
||||
*
|
||||
* Retrieves whether the Num Lock modifier of the
|
||||
* keyboard is locked, if @device is a keyboard device.
|
||||
*
|
||||
* Returns: %TRUE if Num Lock is on for @device
|
||||
*/
|
||||
gboolean
|
||||
gdk_device_get_num_lock_state (GdkDevice *device)
|
||||
{
|
||||
@ -1797,6 +1815,15 @@ gdk_device_get_num_lock_state (GdkDevice *device)
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* gdk_device_get_scroll_lock_state:
|
||||
* @device: a #GdkDevice
|
||||
*
|
||||
* Retrieves whether the Scroll Lock modifier of the
|
||||
* keyboard is locked, if @device is a keyboard device.
|
||||
*
|
||||
* Returns: %TRUE if Scroll Lock is on for @device
|
||||
*/
|
||||
gboolean
|
||||
gdk_device_get_scroll_lock_state (GdkDevice *device)
|
||||
{
|
||||
@ -1808,6 +1835,15 @@ gdk_device_get_scroll_lock_state (GdkDevice *device)
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* gdk_device_get_modifier_state:
|
||||
* @device: a #GdkDevice
|
||||
*
|
||||
* Retrieves the current modifier state of the keyboard,
|
||||
* if @device is a keyboard device.
|
||||
*
|
||||
* Returns: the current modifier state
|
||||
*/
|
||||
GdkModifierType
|
||||
gdk_device_get_modifier_state (GdkDevice *device)
|
||||
{
|
||||
@ -1819,6 +1855,20 @@ gdk_device_get_modifier_state (GdkDevice *device)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* gdk_device_get_direction:
|
||||
* @device: a #GdkDevice
|
||||
*
|
||||
* Returns the direction of effective layout of the keyboard,
|
||||
* if @device is a keyboard device.
|
||||
*
|
||||
* The direction of a layout is the direction of the majority
|
||||
* of its symbols. See pango_unichar_direction().
|
||||
*
|
||||
* Returns: %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL
|
||||
* if it can determine the direction. %PANGO_DIRECTION_NEUTRAL
|
||||
* otherwise
|
||||
*/
|
||||
PangoDirection
|
||||
gdk_device_get_direction (GdkDevice *device)
|
||||
{
|
||||
@ -1830,6 +1880,17 @@ gdk_device_get_direction (GdkDevice *device)
|
||||
return PANGO_DIRECTION_NEUTRAL;
|
||||
}
|
||||
|
||||
/**
|
||||
* gdk_device_has_bidi_layouts:
|
||||
* @device: a #GdkDevice
|
||||
*
|
||||
* Determines if keyboard layouts for both right-to-left and
|
||||
* left-to-right languages are in use on the keyboard, if
|
||||
* @device is a keyboard device.
|
||||
*
|
||||
* Returns: %TRUE if there are layouts with both directions,
|
||||
* %FALSE otherwise
|
||||
*/
|
||||
gboolean
|
||||
gdk_device_has_bidi_layouts (GdkDevice *device)
|
||||
{
|
||||
|
@ -71,6 +71,8 @@ typedef enum
|
||||
|
||||
/**
|
||||
* GdkPopupLayout:
|
||||
*
|
||||
* Struct containing information for gdk_popup_present()
|
||||
*/
|
||||
typedef struct _GdkPopupLayout GdkPopupLayout;
|
||||
|
||||
|
@ -31,6 +31,8 @@ G_BEGIN_DECLS
|
||||
|
||||
/**
|
||||
* GdkTopLevelLayout:
|
||||
*
|
||||
* Struct containing information for gdk_toplevel_present()
|
||||
*/
|
||||
typedef struct _GdkToplevelLayout GdkToplevelLayout;
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user