mirror of
https://gitlab.gnome.org/GNOME/gtk.git
synced 2024-11-15 05:00:09 +00:00
d27adb10a0
Mention that sizes are in application pixels. Also, remove some X11-specific docs.
306 lines
7.7 KiB
C
306 lines
7.7 KiB
C
/* GDK - The GIMP Drawing Kit
|
|
* Copyright (C) 2020 Red Hat
|
|
*
|
|
* 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/>.
|
|
*
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include "gdktoplevellayout.h"
|
|
|
|
#include "gdkmonitor.h"
|
|
|
|
/**
|
|
* SECTION:gdktoplevellayout
|
|
* @Title: GdkToplevelLayout
|
|
* @Short_description: Information for presenting toplevels
|
|
*
|
|
* Toplevel surfaces are sovereign windows that can be presented
|
|
* to the user in various states (maximized, on all workspaces,
|
|
* etc).
|
|
*
|
|
* The GdkToplevelLayout struct contains information that
|
|
* is necessary to do so, and is passed to gdk_toplevel_present().
|
|
*/
|
|
struct _GdkToplevelLayout
|
|
{
|
|
/* < private >*/
|
|
grefcount ref_count;
|
|
|
|
int min_width;
|
|
int min_height;
|
|
guint resizable : 1;
|
|
guint maximized : 1;
|
|
guint fullscreen : 1;
|
|
GdkMonitor *fullscreen_monitor;
|
|
};
|
|
|
|
G_DEFINE_BOXED_TYPE (GdkToplevelLayout, gdk_toplevel_layout,
|
|
gdk_toplevel_layout_ref,
|
|
gdk_toplevel_layout_unref)
|
|
|
|
/**
|
|
* gdk_toplevel_layout_new: (constructor)
|
|
* @min_width: the minimum width for the layout
|
|
* @min_height: the minimum height for the layout
|
|
*
|
|
* Create a toplevel layout description.
|
|
*
|
|
* Used together with gdk_toplevel_present() to describe
|
|
* how a toplevel surface should be placed and behave on-screen.
|
|
*
|
|
* The size is in ”application pixels”, not
|
|
* ”device pixels” (see gdk_surface_get_scale_factor()).
|
|
*
|
|
* Returns: (transfer full): newly created instance of #GdkToplevelLayout
|
|
*/
|
|
GdkToplevelLayout *
|
|
gdk_toplevel_layout_new (int min_width,
|
|
int min_height)
|
|
{
|
|
GdkToplevelLayout *layout;
|
|
|
|
layout = g_new0 (GdkToplevelLayout, 1);
|
|
g_ref_count_init (&layout->ref_count);
|
|
layout->min_width = min_width;
|
|
layout->min_height = min_height;
|
|
layout->resizable = TRUE;
|
|
layout->maximized = FALSE;
|
|
layout->fullscreen = FALSE;
|
|
layout->fullscreen_monitor = NULL;
|
|
|
|
return layout;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_ref:
|
|
* @layout: a #GdkToplevelLayout
|
|
*
|
|
* Increases the reference count of @layout.
|
|
*
|
|
* Returns: the same @layout
|
|
*/
|
|
GdkToplevelLayout *
|
|
gdk_toplevel_layout_ref (GdkToplevelLayout *layout)
|
|
{
|
|
g_ref_count_inc (&layout->ref_count);
|
|
return layout;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_unref:
|
|
* @layout: a #GdkToplevelLayout
|
|
*
|
|
* Decreases the reference count of @layout.
|
|
*/
|
|
void
|
|
gdk_toplevel_layout_unref (GdkToplevelLayout *layout)
|
|
{
|
|
if (g_ref_count_dec (&layout->ref_count))
|
|
{
|
|
g_clear_object (&layout->fullscreen_monitor);
|
|
g_free (layout);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_copy:
|
|
* @layout: a #GdkToplevelLayout
|
|
*
|
|
* Create a new #GdkToplevelLayout and copy the contents of @layout into it.
|
|
*
|
|
* Returns: (transfer full): a copy of @layout.
|
|
*/
|
|
GdkToplevelLayout *
|
|
gdk_toplevel_layout_copy (GdkToplevelLayout *layout)
|
|
{
|
|
GdkToplevelLayout *new_layout;
|
|
|
|
new_layout = g_new0 (GdkToplevelLayout, 1);
|
|
g_ref_count_init (&new_layout->ref_count);
|
|
|
|
new_layout->min_width = layout->min_width;
|
|
new_layout->min_height = layout->min_height;
|
|
new_layout->resizable = layout->resizable;
|
|
new_layout->maximized = layout->maximized;
|
|
new_layout->fullscreen = layout->fullscreen;
|
|
if (layout->fullscreen_monitor)
|
|
new_layout->fullscreen_monitor = g_object_ref (layout->fullscreen_monitor);
|
|
|
|
return new_layout;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_equal:
|
|
* @layout: a #GdkToplevelLayout
|
|
* @other: another #GdkToplevelLayout
|
|
*
|
|
* Check whether @layout and @other has identical layout properties.
|
|
*
|
|
* Returns: %TRUE if @layout and @other have identical layout properties,
|
|
* otherwise %FALSE.
|
|
*/
|
|
gboolean
|
|
gdk_toplevel_layout_equal (GdkToplevelLayout *layout,
|
|
GdkToplevelLayout *other)
|
|
{
|
|
g_return_val_if_fail (layout, FALSE);
|
|
g_return_val_if_fail (other, FALSE);
|
|
|
|
return layout->min_width == other->min_width &&
|
|
layout->min_height == other->min_height &&
|
|
layout->resizable == other->resizable &&
|
|
layout->maximized == other->maximized &&
|
|
layout->fullscreen == other->fullscreen &&
|
|
layout->fullscreen_monitor == other->fullscreen_monitor;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_get_min_width:
|
|
* @layout: a #GdkToplevelLayout
|
|
*
|
|
* Returns the minimum width of the given layout.
|
|
*
|
|
* Returns: the minimum width of @layout
|
|
*/
|
|
int
|
|
gdk_toplevel_layout_get_min_width (GdkToplevelLayout *layout)
|
|
{
|
|
return layout->min_width;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_get_min_height:
|
|
* @layout: a #GdkToplevelLayout
|
|
*
|
|
* Returns the minimum height of the given layout.
|
|
*
|
|
* Returns: the minimum height of @layout
|
|
*/
|
|
int
|
|
gdk_toplevel_layout_get_min_height (GdkToplevelLayout *layout)
|
|
{
|
|
return layout->min_height;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_set_resizable:
|
|
* @layout: a #GdkToplevelLayout
|
|
* @resizable: %TRUE to allow resizing
|
|
*
|
|
* Sets whether the layout should allow the user
|
|
* to resize the surface after it has been presented.
|
|
*/
|
|
void
|
|
gdk_toplevel_layout_set_resizable (GdkToplevelLayout *layout,
|
|
gboolean resizable)
|
|
{
|
|
layout->resizable = resizable;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_get_resizable:
|
|
* @layout: a #GdkToplevelLayout
|
|
*
|
|
* Returns whether the layout should allow the user
|
|
* to resize the surface.
|
|
*
|
|
* Returns: %TRUE if the layout is resizable
|
|
*/
|
|
gboolean
|
|
gdk_toplevel_layout_get_resizable (GdkToplevelLayout *layout)
|
|
{
|
|
return layout->resizable;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_set_maximized:
|
|
* @layout: a #GdkToplevelLayout
|
|
* @maximized: %TRUE to maximize
|
|
*
|
|
* Sets whether the layout should cause the surface
|
|
* to be maximized when presented.
|
|
*/
|
|
void
|
|
gdk_toplevel_layout_set_maximized (GdkToplevelLayout *layout,
|
|
gboolean maximized)
|
|
{
|
|
layout->maximized = maximized;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_get_maximized:
|
|
* @layout: a #GdkToplevelLayout
|
|
*
|
|
* Returns whether the layout should present the
|
|
* surface as maximized.
|
|
*
|
|
* Returns: %TRUE if the layout is maximized
|
|
*/
|
|
gboolean
|
|
gdk_toplevel_layout_get_maximized (GdkToplevelLayout *layout)
|
|
{
|
|
return layout->maximized;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_set_fullscreen:
|
|
* @layout: a #GdkToplevelLayout
|
|
* @fullscreen: %TRUE to fullscreen the surface
|
|
* @monitor: (nullable): the monitor to fullscreen on
|
|
*
|
|
* Sets whether the layout should cause the surface
|
|
* to be fullscreen when presented.
|
|
*/
|
|
void
|
|
gdk_toplevel_layout_set_fullscreen (GdkToplevelLayout *layout,
|
|
gboolean fullscreen,
|
|
GdkMonitor *monitor)
|
|
{
|
|
layout->fullscreen = fullscreen;
|
|
if (monitor)
|
|
layout->fullscreen_monitor = g_object_ref (monitor);
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_get_fullscreen:
|
|
* @layout: a #GdkToplevelLayout
|
|
*
|
|
* Returns whether the layout should cause the surface
|
|
* to be fullscreen when presented.
|
|
*
|
|
* Returns: %TRUE if @layout is fullscreen
|
|
*/
|
|
gboolean
|
|
gdk_toplevel_layout_get_fullscreen (GdkToplevelLayout *layout)
|
|
{
|
|
return layout->fullscreen;
|
|
}
|
|
|
|
/**
|
|
* gdk_toplevel_layout_get_fullscreen_monitor:
|
|
* @layout: a #GdkToplevelLayout
|
|
*
|
|
* Returns the monitor that the layout is fullscreening
|
|
* the surface on.
|
|
*
|
|
* Returns: (nullable) (transfer none): the monitor on which @layout fullscreens
|
|
*/
|
|
GdkMonitor *
|
|
gdk_toplevel_layout_get_fullscreen_monitor (GdkToplevelLayout *layout)
|
|
{
|
|
return layout->fullscreen_monitor;
|
|
}
|