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

205 lines
9.8 KiB
C
Raw Normal View History

Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
/*
* Copyright © 2019 Benjamin Otte
*
* 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/>.
*
* Authors: Benjamin Otte <otte@gnome.org>
*/
#ifndef __GTK_EXPRESSION_H__
#define __GTK_EXPRESSION_H__
#include <gtk/gtktypes.h>
G_BEGIN_DECLS
Box GtkExpressionWatch Otherwise bindings won't know how to deal with memory management.
2021-02-22 18:23:36 +00:00
#define GTK_TYPE_EXPRESSION (gtk_expression_get_type ())
#define GTK_TYPE_EXPRESSION_WATCH (gtk_expression_watch_get_type())
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
#define GTK_IS_EXPRESSION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_EXPRESSION))
#define GTK_EXPRESSION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_EXPRESSION, GtkExpression))
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
typedef struct _GtkExpression GtkExpression;
expression: Add the ability to watch an expression
2019-11-21 04:53:56 +00:00
typedef struct _GtkExpressionWatch GtkExpressionWatch;
/**
* GtkExpressionNotify:
* @user_data: data passed to gtk_expression_watch()
*
* Callback called by gtk_expression_watch() when the
* expression value changes.
*/
typedef void (* GtkExpressionNotify) (gpointer user_data);
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
GDK_AVAILABLE_IN_ALL
GType gtk_expression_get_type (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
GtkExpression * gtk_expression_ref (GtkExpression *self);
GDK_AVAILABLE_IN_ALL
void gtk_expression_unref (GtkExpression *self);
GDK_AVAILABLE_IN_ALL
GType gtk_expression_get_value_type (GtkExpression *self);
GDK_AVAILABLE_IN_ALL
expression: Add the ability to watch an expression
2019-11-21 04:53:56 +00:00
gboolean gtk_expression_is_static (GtkExpression *self);
GDK_AVAILABLE_IN_ALL
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
gboolean gtk_expression_evaluate (GtkExpression *self,
gpointer this_,
GValue *value);
expression: Add the ability to watch an expression
2019-11-21 04:53:56 +00:00
GDK_AVAILABLE_IN_ALL
GtkExpressionWatch * gtk_expression_watch (GtkExpression *self,
gpointer this_,
GtkExpressionNotify notify,
gpointer user_data,
GDestroyNotify user_destroy);
expression: Add gtk_expression_bind() Add a simple way to bind expressions to object properties. This is essentially the thing to replace g_object_bind_property().
2019-11-24 07:05:41 +00:00
GDK_AVAILABLE_IN_ALL
GtkExpressionWatch * gtk_expression_bind (GtkExpression *self,
expression: Allow passing a this object to bind() This gives a bit more control over the arguments passed to expressions.
2019-11-28 01:32:12 +00:00
gpointer target,
const char * property,
gpointer this_);
expression: Add the ability to watch an expression
2019-11-21 04:53:56 +00:00
Box GtkExpressionWatch Otherwise bindings won't know how to deal with memory management.
2021-02-22 18:23:36 +00:00
GDK_AVAILABLE_IN_4_2
GType gtk_expression_watch_get_type (void) G_GNUC_CONST;
expression: Add the ability to watch an expression
2019-11-21 04:53:56 +00:00
GDK_AVAILABLE_IN_ALL
GtkExpressionWatch * gtk_expression_watch_ref (GtkExpressionWatch *watch);
GDK_AVAILABLE_IN_ALL
void gtk_expression_watch_unref (GtkExpressionWatch *watch);
GDK_AVAILABLE_IN_ALL
gboolean gtk_expression_watch_evaluate (GtkExpressionWatch *watch,
GValue *value);
GDK_AVAILABLE_IN_ALL
void gtk_expression_watch_unwatch (GtkExpressionWatch *watch);
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
#define GTK_TYPE_PROPERTY_EXPRESSION (gtk_property_expression_get_type())
typedef struct _GtkPropertyExpression GtkPropertyExpression;
GDK_AVAILABLE_IN_ALL
GType gtk_property_expression_get_type (void) G_GNUC_CONST;
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
GDK_AVAILABLE_IN_ALL
GtkExpression * gtk_property_expression_new (GType this_type,
GtkExpression *expression,
const char *property_name);
GDK_AVAILABLE_IN_ALL
GtkExpression * gtk_property_expression_new_for_pspec (GtkExpression *expression,
GParamSpec *pspec);
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
expression: Add some introspection Add a few apis to peek inside expressions, mainly for the benefit of GtkInspector and similar uses.
2020-07-14 00:19:07 +00:00
GDK_AVAILABLE_IN_ALL
GtkExpression * gtk_property_expression_get_expression (GtkExpression *expression);
GDK_AVAILABLE_IN_ALL
GParamSpec * gtk_property_expression_get_pspec (GtkExpression *expression);
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
#define GTK_TYPE_CONSTANT_EXPRESSION (gtk_constant_expression_get_type())
typedef struct _GtkConstantExpression GtkConstantExpression;
GDK_AVAILABLE_IN_ALL
GType gtk_constant_expression_get_type (void) G_GNUC_CONST;
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
GDK_AVAILABLE_IN_ALL
GtkExpression * gtk_constant_expression_new (GType value_type,
...);
GDK_AVAILABLE_IN_ALL
GtkExpression * gtk_constant_expression_new_for_value (const GValue *value);
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
expression: Add some introspection Add a few apis to peek inside expressions, mainly for the benefit of GtkInspector and similar uses.
2020-07-14 00:19:07 +00:00
GDK_AVAILABLE_IN_ALL
const GValue * gtk_constant_expression_get_value (GtkExpression *expression);
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
#define GTK_TYPE_OBJECT_EXPRESSION (gtk_object_expression_get_type())
typedef struct _GtkObjectExpression GtkObjectExpression;
GDK_AVAILABLE_IN_ALL
GType gtk_object_expression_get_type (void) G_GNUC_CONST;
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
GDK_AVAILABLE_IN_ALL
expression: Add GtkObjectExpression Weak refs break cycles...
2019-11-26 17:59:34 +00:00
GtkExpression * gtk_object_expression_new (GObject *object);
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
expression: Add some introspection Add a few apis to peek inside expressions, mainly for the benefit of GtkInspector and similar uses.
2020-07-14 00:19:07 +00:00
GDK_AVAILABLE_IN_ALL
GObject * gtk_object_expression_get_object (GtkExpression *expression);
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
#define GTK_TYPE_CLOSURE_EXPRESSION (gtk_closure_expression_get_type())
typedef struct _GtkClosureExpression GtkClosureExpression;
GDK_AVAILABLE_IN_ALL
GType gtk_closure_expression_get_type (void) G_GNUC_CONST;
expression: Add GtkObjectExpression Weak refs break cycles...
2019-11-26 17:59:34 +00:00
GDK_AVAILABLE_IN_ALL
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
GtkExpression * gtk_closure_expression_new (GType value_type,
GClosure *closure,
guint n_params,
GtkExpression **params);
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
#define GTK_TYPE_CCLOSURE_EXPRESSION (gtk_cclosure_expression_get_type())
typedef struct _GtkCClosureExpression GtkCClosureExpression;
GDK_AVAILABLE_IN_ALL
GType gtk_cclosure_expression_get_type (void) G_GNUC_CONST;
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
GDK_AVAILABLE_IN_ALL
GtkExpression * gtk_cclosure_expression_new (GType value_type,
GClosureMarshal marshal,
guint n_params,
GtkExpression **params,
GCallback callback_func,
gpointer user_data,
GClosureNotify user_destroy);
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
/* GObject integration, so we can use GtkBuilder */
docs: Annotate missing symbols
2020-12-01 17:28:16 +00:00
/**
* GTK_VALUE_HOLDS_EXPRESSION:
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* @value: a `GValue`
docs: Annotate missing symbols
2020-12-01 17:28:16 +00:00
*
* Evaluates to %TRUE if @value was initialized with %GTK_TYPE_EXPRESSION.
*/
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
#define GTK_VALUE_HOLDS_EXPRESSION(value) (G_VALUE_HOLDS ((value), GTK_TYPE_EXPRESSION))
GDK_AVAILABLE_IN_ALL
void gtk_value_set_expression (GValue *value,
GtkExpression *expression);
GDK_AVAILABLE_IN_ALL
void gtk_value_take_expression (GValue *value,
GtkExpression *expression);
GDK_AVAILABLE_IN_ALL
GtkExpression * gtk_value_get_expression (const GValue *value);
GDK_AVAILABLE_IN_ALL
GtkExpression * gtk_value_dup_expression (const GValue *value);
#define GTK_TYPE_PARAM_SPEC_EXPRESSION (gtk_param_expression_get_type())
#define GTK_PARAM_SPEC_EXPRESSION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PARAM_SPEC_EXPRESSION, GtkParamSpecExpression))
#define GTK_IS_PARAM_SPEC_EXPRESSION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PARAM_SPEC_EXPRESSION))
docs: Annotate missing symbols
2020-12-01 17:28:16 +00:00
/**
* GtkParamSpecExpression:
*
gtk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-20 13:17:04 +00:00
* A `GParamSpec` for properties holding a `GtkExpression`.
docs: Annotate missing symbols
2020-12-01 17:28:16 +00:00
*/
Turn GtkExpression into a GTypeInstance Since it's a type with sub-classes, we need to use GTypeInstance (at the very least), otherwise we won't be able to address each sub-class as such. This is similar to how GskRenderNode and GdkEvent are handled, with the added difficulty that GtkExpression is meant to be used in properties, in order to be deserialised by GtkBuilder. This requires adding a GParamSpec sub-class that we can match on from within GtkBuilder, alongside some convenience API for storing a GtkExpression inside a GValue.
2020-06-01 20:07:53 +00:00
typedef struct {
/*< private >*/
GParamSpec parent_instance;
} GtkParamSpecExpression;
GDK_AVAILABLE_IN_ALL
GType gtk_param_expression_get_type (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
GParamSpec * gtk_param_spec_expression (const char *name,
const char *nick,
const char *blurb,
GParamFlags flags);
Add GtkExpression GtkExpressions allow looking up values from objects. There are a few simple expressions, but the main one is the closure expression that just calls a user-provided closure.
2019-11-16 20:52:18 +00:00
G_END_DECLS
#endif /* __GTK_EXPRESSION_H__ */
Reference in New Issue Copy Permalink