AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
a71893f88b
gtk2/gtk/gtklayoutmanager.h

130 lines
5.9 KiB
C
Raw Normal View History

Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
/* gtklayoutmanager.h: Layout manager base class
Changes after review - Rename GtkLegacyLayout to GtkCustomLayout - Use for() to iterate over children in GtkBinLayout - Whitespace fixes for code imported from GtkBox - Store the GtkLayoutChild instances inside LayoutManager - Simplify the GtkLayoutManager API by dropping unnecessary arguments - Fix the ownership model of GtkLayoutManager
2019-03-20 15:37:15 +00:00
* Copyright 2019 The GNOME Foundation
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
*
* 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.1 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/>.
*
* Author: Emmanuele Bassi
*/
#pragma once
Changes after review - Rename GtkLegacyLayout to GtkCustomLayout - Use for() to iterate over children in GtkBinLayout - Whitespace fixes for code imported from GtkBox - Store the GtkLayoutChild instances inside LayoutManager - Simplify the GtkLayoutManager API by dropping unnecessary arguments - Fix the ownership model of GtkLayoutManager
2019-03-20 15:37:15 +00:00
#include <gsk/gsk.h>
Hook GtkLayoutManager into GtkWidget We delegate the size request mode, the measuring, and the allocation of a widget through a GtkLayoutManager instance, if one has been attached to the widget; otherwise, we fall back to the widget's own implementation.
2018-12-12 17:20:28 +00:00
#include <gtk/gtktypes.h>
#include <gtk/gtkwidget.h>
Add GtkLayoutChild Layout managers needs a way to store properties that control the layout policy of a widget; typically, we used to store these in GtkContainer's child properties, but since GtkLayoutManager is decoupled from the actual container widget, we need a separate storage. Additionally, child properties have their own downsides, like requiring a separate, global GParamSpecPool storage, and additional lookup API. GtkLayoutChild is a simple GObject class, which means you can introspect and document it as you would any other type.
2018-12-19 16:01:17 +00:00
#include <gtk/gtklayoutchild.h>
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
G_BEGIN_DECLS
#define GTK_TYPE_LAYOUT_MANAGER (gtk_layout_manager_get_type ())
GDK_AVAILABLE_IN_ALL
G_DECLARE_DERIVABLE_TYPE (GtkLayoutManager, gtk_layout_manager, GTK, LAYOUT_MANAGER, GObject)
/**
* GtkLayoutManagerClass:
* @get_request_mode: a virtual function, used to return the preferred
* request mode for the layout manager; for instance, "width for height"
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* or "height for width"; see `GtkSizeRequestMode`
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
* @measure: a virtual function, used to measure the minimum and preferred
* sizes of the widget using the layout manager for a given orientation
* @allocate: a virtual function, used to allocate the size of the widget
* using the layout manager
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* @layout_child_type: the type of `GtkLayoutChild` used by this layout manager
* @create_layout_child: a virtual function, used to create a `GtkLayoutChild`
Changes after review - Rename GtkLegacyLayout to GtkCustomLayout - Use for() to iterate over children in GtkBinLayout - Whitespace fixes for code imported from GtkBox - Store the GtkLayoutChild instances inside LayoutManager - Simplify the GtkLayoutManager API by dropping unnecessary arguments - Fix the ownership model of GtkLayoutManager
2019-03-20 15:37:15 +00:00
* meta object for the layout properties
Propagate rooting and unrooting widgets to layout managers Layout managers may need to get access to data attached to the root of a scene graph.
2019-06-10 13:43:14 +00:00
* @root: a virtual function, called when the widget using the layout
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* manager is attached to a `GtkRoot`
Propagate rooting and unrooting widgets to layout managers Layout managers may need to get access to data attached to the root of a scene graph.
2019-06-10 13:43:14 +00:00
* @unroot: a virtual function, called when the widget using the layout
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* manager is detached from a `GtkRoot`
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
*
* The `GtkLayoutManagerClass` structure contains only private data, and
* should only be accessed through the provided API, or when subclassing
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* `GtkLayoutManager`.
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
*/
struct _GtkLayoutManagerClass
{
/*< private >*/
GObjectClass parent_class;
/*< public >*/
Add GtkLayoutChild Layout managers needs a way to store properties that control the layout policy of a widget; typically, we used to store these in GtkContainer's child properties, but since GtkLayoutManager is decoupled from the actual container widget, we need a separate storage. Additionally, child properties have their own downsides, like requiring a separate, global GParamSpecPool storage, and additional lookup API. GtkLayoutChild is a simple GObject class, which means you can introspect and document it as you would any other type.
2018-12-19 16:01:17 +00:00
GtkSizeRequestMode (* get_request_mode) (GtkLayoutManager *manager,
GtkWidget *widget);
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
Add GtkLayoutChild Layout managers needs a way to store properties that control the layout policy of a widget; typically, we used to store these in GtkContainer's child properties, but since GtkLayoutManager is decoupled from the actual container widget, we need a separate storage. Additionally, child properties have their own downsides, like requiring a separate, global GParamSpecPool storage, and additional lookup API. GtkLayoutChild is a simple GObject class, which means you can introspect and document it as you would any other type.
2018-12-19 16:01:17 +00:00
void (* measure) (GtkLayoutManager *manager,
GtkWidget *widget,
GtkOrientation orientation,
int for_size,
int *minimum,
int *natural,
int *minimum_baseline,
int *natural_baseline);
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
Add GtkLayoutChild Layout managers needs a way to store properties that control the layout policy of a widget; typically, we used to store these in GtkContainer's child properties, but since GtkLayoutManager is decoupled from the actual container widget, we need a separate storage. Additionally, child properties have their own downsides, like requiring a separate, global GParamSpecPool storage, and additional lookup API. GtkLayoutChild is a simple GObject class, which means you can introspect and document it as you would any other type.
2018-12-19 16:01:17 +00:00
void (* allocate) (GtkLayoutManager *manager,
GtkWidget *widget,
int width,
int height,
int baseline);
Connect LayoutManager to LayoutChild If we want to inspect the type of layout properties exposed by a GtkLayoutManager, we need a way to connect the layout manager type to the GtkLayoutChild type it creates. In order to do so, we can set the GtkLayoutChild type on a field of the GtkLayoutManagerClass structure. Storing the GtkLayoutChild type on the class structure of the layout manager also allows us to implement a default create_layout_child() virtual function.
2019-03-28 16:58:00 +00:00
GType layout_child_type;
Properly annotate GtkLayoutManagerClass.create_layout_child() We're missing the ownership transfer rule for the created GtkLayoutChild instance; this makes the virtual function not introspectable. Fixes: #3156
2020-09-12 13:31:52 +00:00
/**
* GtkLayoutManagerClass::create_layout_child:
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* @manager: the `GtkLayoutManager`
Properly annotate GtkLayoutManagerClass.create_layout_child() We're missing the ownership transfer rule for the created GtkLayoutChild instance; this makes the virtual function not introspectable. Fixes: #3156
2020-09-12 13:31:52 +00:00
* @widget: the widget using the @manager
* @for_child: the child of @widget
*
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* Create a `GtkLayoutChild` instance for the given @for_child widget.
Properly annotate GtkLayoutManagerClass.create_layout_child() We're missing the ownership transfer rule for the created GtkLayoutChild instance; this makes the virtual function not introspectable. Fixes: #3156
2020-09-12 13:31:52 +00:00
*
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* Returns: (transfer full): a `GtkLayoutChild`
Properly annotate GtkLayoutManagerClass.create_layout_child() We're missing the ownership transfer rule for the created GtkLayoutChild instance; this makes the virtual function not introspectable. Fixes: #3156
2020-09-12 13:31:52 +00:00
*/
Add GtkLayoutChild Layout managers needs a way to store properties that control the layout policy of a widget; typically, we used to store these in GtkContainer's child properties, but since GtkLayoutManager is decoupled from the actual container widget, we need a separate storage. Additionally, child properties have their own downsides, like requiring a separate, global GParamSpecPool storage, and additional lookup API. GtkLayoutChild is a simple GObject class, which means you can introspect and document it as you would any other type.
2018-12-19 16:01:17 +00:00
GtkLayoutChild * (* create_layout_child) (GtkLayoutManager *manager,
Changes after review - Rename GtkLegacyLayout to GtkCustomLayout - Use for() to iterate over children in GtkBinLayout - Whitespace fixes for code imported from GtkBox - Store the GtkLayoutChild instances inside LayoutManager - Simplify the GtkLayoutManager API by dropping unnecessary arguments - Fix the ownership model of GtkLayoutManager
2019-03-20 15:37:15 +00:00
GtkWidget *widget,
GtkWidget *for_child);
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
Propagate rooting and unrooting widgets to layout managers Layout managers may need to get access to data attached to the root of a scene graph.
2019-06-10 13:43:14 +00:00
void (* root) (GtkLayoutManager *manager);
void (* unroot) (GtkLayoutManager *manager);
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
/*< private >*/
gpointer _padding[16];
};
GDK_AVAILABLE_IN_ALL
void gtk_layout_manager_measure (GtkLayoutManager *manager,
GtkWidget *widget,
GtkOrientation orientation,
int for_size,
int *minimum,
int *natural,
int *minimum_baseline,
int *natural_baseline);
GDK_AVAILABLE_IN_ALL
void gtk_layout_manager_allocate (GtkLayoutManager *manager,
GtkWidget *widget,
int width,
int height,
int baseline);
GDK_AVAILABLE_IN_ALL
Changes after review - Rename GtkLegacyLayout to GtkCustomLayout - Use for() to iterate over children in GtkBinLayout - Whitespace fixes for code imported from GtkBox - Store the GtkLayoutChild instances inside LayoutManager - Simplify the GtkLayoutManager API by dropping unnecessary arguments - Fix the ownership model of GtkLayoutManager
2019-03-20 15:37:15 +00:00
GtkSizeRequestMode gtk_layout_manager_get_request_mode (GtkLayoutManager *manager);
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
Hook GtkLayoutManager into GtkWidget We delegate the size request mode, the measuring, and the allocation of a widget through a GtkLayoutManager instance, if one has been attached to the widget; otherwise, we fall back to the widget's own implementation.
2018-12-12 17:20:28 +00:00
GDK_AVAILABLE_IN_ALL
GtkWidget * gtk_layout_manager_get_widget (GtkLayoutManager *manager);
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
GDK_AVAILABLE_IN_ALL
void gtk_layout_manager_layout_changed (GtkLayoutManager *manager);
Add GtkLayoutChild Layout managers needs a way to store properties that control the layout policy of a widget; typically, we used to store these in GtkContainer's child properties, but since GtkLayoutManager is decoupled from the actual container widget, we need a separate storage. Additionally, child properties have their own downsides, like requiring a separate, global GParamSpecPool storage, and additional lookup API. GtkLayoutChild is a simple GObject class, which means you can introspect and document it as you would any other type.
2018-12-19 16:01:17 +00:00
GDK_AVAILABLE_IN_ALL
GtkLayoutChild * gtk_layout_manager_get_layout_child (GtkLayoutManager *manager,
Changes after review - Rename GtkLegacyLayout to GtkCustomLayout - Use for() to iterate over children in GtkBinLayout - Whitespace fixes for code imported from GtkBox - Store the GtkLayoutChild instances inside LayoutManager - Simplify the GtkLayoutManager API by dropping unnecessary arguments - Fix the ownership model of GtkLayoutManager
2019-03-20 15:37:15 +00:00
GtkWidget *child);
Add GtkLayoutChild Layout managers needs a way to store properties that control the layout policy of a widget; typically, we used to store these in GtkContainer's child properties, but since GtkLayoutManager is decoupled from the actual container widget, we need a separate storage. Additionally, child properties have their own downsides, like requiring a separate, global GParamSpecPool storage, and additional lookup API. GtkLayoutChild is a simple GObject class, which means you can introspect and document it as you would any other type.
2018-12-19 16:01:17 +00:00
Add GtkLayoutManager A base abstract class for layout manager delegate objects. Layout managers are associated to a single widget, like event controllers, and are responsible for measuring and allocating the children of the widget they are bound to.
2018-12-12 15:24:41 +00:00
G_END_DECLS
Reference in New Issue Copy Permalink