@girs/meta-3 4.2.0 → 4.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/meta-3.d.ts +338 -2
- package/package.json +23 -23
package/meta-3.d.ts
CHANGED
|
@@ -2403,6 +2403,7 @@ export namespace Meta {
|
|
|
2403
2403
|
* instance.
|
|
2404
2404
|
* @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
|
|
2405
2405
|
* @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
|
|
2406
|
+
* @since 2.22
|
|
2406
2407
|
*/
|
|
2407
2408
|
init(cancellable: Gio.Cancellable | null): boolean;
|
|
2408
2409
|
|
|
@@ -2446,6 +2447,7 @@ export namespace Meta {
|
|
|
2446
2447
|
* on the result of `g_object_new()`, regardless of whether it is in fact a new
|
|
2447
2448
|
* instance.
|
|
2448
2449
|
* @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
|
|
2450
|
+
* @since 2.22
|
|
2449
2451
|
* @virtual
|
|
2450
2452
|
*/
|
|
2451
2453
|
vfunc_init(cancellable: Gio.Cancellable | null): boolean;
|
|
@@ -2792,6 +2794,8 @@ export namespace Meta {
|
|
|
2792
2794
|
* @param progress the progress factor
|
|
2793
2795
|
* @param value return location for the animation value
|
|
2794
2796
|
* @returns `true` if the value has been validated and can be applied to the {@link Clutter.Animatable}, and `false` otherwise
|
|
2797
|
+
* @since 1.0
|
|
2798
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
2795
2799
|
*/
|
|
2796
2800
|
animate_property(animation: Clutter.Animation, property_name: string, initial_value: GObject.Value | any, final_value: GObject.Value | any, progress: number, value: GObject.Value | any): boolean;
|
|
2797
2801
|
|
|
@@ -2799,6 +2803,7 @@ export namespace Meta {
|
|
|
2799
2803
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
2800
2804
|
* @param property_name the name of the animatable property to find
|
|
2801
2805
|
* @returns The {@link GObject.ParamSpec} for the given property or `null`
|
|
2806
|
+
* @since 1.4
|
|
2802
2807
|
*/
|
|
2803
2808
|
find_property(property_name: string): GObject.ParamSpec;
|
|
2804
2809
|
|
|
@@ -2806,6 +2811,7 @@ export namespace Meta {
|
|
|
2806
2811
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
2807
2812
|
* @param property_name the name of the animatable property to retrieve
|
|
2808
2813
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
2814
|
+
* @since 1.4
|
|
2809
2815
|
*/
|
|
2810
2816
|
get_initial_state(property_name: string, value: GObject.Value | any): void;
|
|
2811
2817
|
|
|
@@ -2823,6 +2829,7 @@ export namespace Meta {
|
|
|
2823
2829
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
2824
2830
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
2825
2831
|
* @returns `true` if the interpolation was successful, and `false` otherwise
|
|
2832
|
+
* @since 1.8
|
|
2826
2833
|
*/
|
|
2827
2834
|
interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, unknown];
|
|
2828
2835
|
|
|
@@ -2830,6 +2837,7 @@ export namespace Meta {
|
|
|
2830
2837
|
* Sets the current state of `property_name` to `value`
|
|
2831
2838
|
* @param property_name the name of the animatable property to set
|
|
2832
2839
|
* @param value the value of the animatable property to set
|
|
2840
|
+
* @since 1.4
|
|
2833
2841
|
*/
|
|
2834
2842
|
set_final_state(property_name: string, value: GObject.Value | any): void;
|
|
2835
2843
|
|
|
@@ -2848,6 +2856,8 @@ export namespace Meta {
|
|
|
2848
2856
|
* @param final_value the final value of the animation interval
|
|
2849
2857
|
* @param progress the progress factor
|
|
2850
2858
|
* @param value return location for the animation value
|
|
2859
|
+
* @since 1.0
|
|
2860
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
2851
2861
|
* @virtual
|
|
2852
2862
|
*/
|
|
2853
2863
|
vfunc_animate_property(animation: Clutter.Animation, property_name: string, initial_value: unknown, final_value: unknown, progress: number, value: unknown): boolean;
|
|
@@ -2855,6 +2865,7 @@ export namespace Meta {
|
|
|
2855
2865
|
/**
|
|
2856
2866
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
2857
2867
|
* @param property_name the name of the animatable property to find
|
|
2868
|
+
* @since 1.4
|
|
2858
2869
|
* @virtual
|
|
2859
2870
|
*/
|
|
2860
2871
|
vfunc_find_property(property_name: string): GObject.ParamSpec;
|
|
@@ -2863,6 +2874,7 @@ export namespace Meta {
|
|
|
2863
2874
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
2864
2875
|
* @param property_name the name of the animatable property to retrieve
|
|
2865
2876
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
2877
|
+
* @since 1.4
|
|
2866
2878
|
* @virtual
|
|
2867
2879
|
*/
|
|
2868
2880
|
vfunc_get_initial_state(property_name: string, value: unknown): void;
|
|
@@ -2880,6 +2892,7 @@ export namespace Meta {
|
|
|
2880
2892
|
* @param property_name the name of the property to interpolate
|
|
2881
2893
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
2882
2894
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
2895
|
+
* @since 1.8
|
|
2883
2896
|
* @virtual
|
|
2884
2897
|
*/
|
|
2885
2898
|
vfunc_interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, GObject.Value | any];
|
|
@@ -2888,6 +2901,7 @@ export namespace Meta {
|
|
|
2888
2901
|
* Sets the current state of `property_name` to `value`
|
|
2889
2902
|
* @param property_name the name of the animatable property to set
|
|
2890
2903
|
* @param value the value of the animatable property to set
|
|
2904
|
+
* @since 1.4
|
|
2891
2905
|
* @virtual
|
|
2892
2906
|
*/
|
|
2893
2907
|
vfunc_set_final_state(property_name: string, value: unknown): void;
|
|
@@ -2902,6 +2916,8 @@ export namespace Meta {
|
|
|
2902
2916
|
* deprecated virtual function. The default implementation will
|
|
2903
2917
|
* call `clutter_actor_add_child()`.
|
|
2904
2918
|
* @param actor the first {@link Clutter.Actor} to add
|
|
2919
|
+
* @since 0.4
|
|
2920
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
2905
2921
|
*/
|
|
2906
2922
|
add_actor(actor: Clutter.Actor): void;
|
|
2907
2923
|
|
|
@@ -2916,6 +2932,7 @@ export namespace Meta {
|
|
|
2916
2932
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
2917
2933
|
* @param property the name of the property to set.
|
|
2918
2934
|
* @param value the value.
|
|
2935
|
+
* @since 0.8
|
|
2919
2936
|
*/
|
|
2920
2937
|
child_get_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
2921
2938
|
|
|
@@ -2925,6 +2942,7 @@ export namespace Meta {
|
|
|
2925
2942
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
2926
2943
|
* @param child a {@link Clutter.Actor}
|
|
2927
2944
|
* @param pspec a {@link GObject.ParamSpec}
|
|
2945
|
+
* @since 1.6
|
|
2928
2946
|
*/
|
|
2929
2947
|
child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
2930
2948
|
|
|
@@ -2933,6 +2951,7 @@ export namespace Meta {
|
|
|
2933
2951
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
2934
2952
|
* @param property the name of the property to set.
|
|
2935
2953
|
* @param value the value.
|
|
2954
|
+
* @since 0.8
|
|
2936
2955
|
*/
|
|
2937
2956
|
child_set_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
2938
2957
|
|
|
@@ -2947,6 +2966,7 @@ export namespace Meta {
|
|
|
2947
2966
|
*
|
|
2948
2967
|
* Applications should not call this function.
|
|
2949
2968
|
* @param actor a {@link Clutter.Actor}
|
|
2969
|
+
* @since 1.2
|
|
2950
2970
|
*/
|
|
2951
2971
|
create_child_meta(actor: Clutter.Actor): void;
|
|
2952
2972
|
|
|
@@ -2960,6 +2980,7 @@ export namespace Meta {
|
|
|
2960
2980
|
*
|
|
2961
2981
|
* Applications should not call this function.
|
|
2962
2982
|
* @param actor a {@link Clutter.Actor}
|
|
2983
|
+
* @since 1.2
|
|
2963
2984
|
*/
|
|
2964
2985
|
destroy_child_meta(actor: Clutter.Actor): void;
|
|
2965
2986
|
|
|
@@ -2968,6 +2989,7 @@ export namespace Meta {
|
|
|
2968
2989
|
* into any child container.
|
|
2969
2990
|
* @param child_name the name of the requested child.
|
|
2970
2991
|
* @returns The child actor with the requested name, or `null` if no actor with that name was found.
|
|
2992
|
+
* @since 0.6
|
|
2971
2993
|
*/
|
|
2972
2994
|
find_child_by_name(child_name: string): Clutter.Actor;
|
|
2973
2995
|
|
|
@@ -2980,6 +3002,8 @@ export namespace Meta {
|
|
|
2980
3002
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
2981
3003
|
* virtual function, which has been deprecated.
|
|
2982
3004
|
* @param callback a function to be called for each child
|
|
3005
|
+
* @since 0.4
|
|
3006
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
2983
3007
|
*/
|
|
2984
3008
|
foreach(callback: Clutter.Callback): void;
|
|
2985
3009
|
|
|
@@ -2991,6 +3015,8 @@ export namespace Meta {
|
|
|
2991
3015
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
2992
3016
|
* virtual function, which has been deprecated.
|
|
2993
3017
|
* @param callback a function to be called for each child
|
|
3018
|
+
* @since 1.0
|
|
3019
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
2994
3020
|
*/
|
|
2995
3021
|
foreach_with_internals(callback: Clutter.Callback): void;
|
|
2996
3022
|
|
|
@@ -2999,12 +3025,15 @@ export namespace Meta {
|
|
|
2999
3025
|
* `container` specific state for `actor`.
|
|
3000
3026
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
3001
3027
|
* @returns the {@link Clutter.ChildMeta} for the `actor` child of `container` or `null` if the specifiec actor does not exist or the container is not configured to provide {@link Clutter.ChildMeta}<!-- -->s
|
|
3028
|
+
* @since 0.8
|
|
3002
3029
|
*/
|
|
3003
3030
|
get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
3004
3031
|
|
|
3005
3032
|
/**
|
|
3006
3033
|
* Retrieves all the children of `container`.
|
|
3007
3034
|
* @returns a list of {@link Clutter.Actor}<!-- -->s. Use `g_list_free()` on the returned list when done.
|
|
3035
|
+
* @since 0.4
|
|
3036
|
+
* @deprecated since 1.10: Use `clutter_actor_get_children()` instead.
|
|
3008
3037
|
*/
|
|
3009
3038
|
get_children(): Clutter.Actor[];
|
|
3010
3039
|
|
|
@@ -3016,6 +3045,8 @@ export namespace Meta {
|
|
|
3016
3045
|
* `clutter_actor_set_child_below_sibling()`.
|
|
3017
3046
|
* @param actor the actor to raise
|
|
3018
3047
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
3048
|
+
* @since 0.6
|
|
3049
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
3019
3050
|
*/
|
|
3020
3051
|
lower_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
3021
3052
|
|
|
@@ -3027,6 +3058,8 @@ export namespace Meta {
|
|
|
3027
3058
|
* `clutter_actor_set_child_above_sibling()`.
|
|
3028
3059
|
* @param actor the actor to raise
|
|
3029
3060
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
3061
|
+
* @since 0.6
|
|
3062
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
3030
3063
|
*/
|
|
3031
3064
|
raise_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
3032
3065
|
|
|
@@ -3040,12 +3073,16 @@ export namespace Meta {
|
|
|
3040
3073
|
* deprecated virtual function. The default implementation will call
|
|
3041
3074
|
* `clutter_actor_remove_child()`.
|
|
3042
3075
|
* @param actor a {@link Clutter.Actor}
|
|
3076
|
+
* @since 0.4
|
|
3077
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
3043
3078
|
*/
|
|
3044
3079
|
remove_actor(actor: Clutter.Actor): void;
|
|
3045
3080
|
|
|
3046
3081
|
/**
|
|
3047
3082
|
* Sorts a container's children using their depth. This function should not
|
|
3048
3083
|
* be normally used by applications.
|
|
3084
|
+
* @since 0.6
|
|
3085
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
3049
3086
|
*/
|
|
3050
3087
|
sort_depth_order(): void;
|
|
3051
3088
|
|
|
@@ -3071,6 +3108,8 @@ export namespace Meta {
|
|
|
3071
3108
|
* deprecated virtual function. The default implementation will
|
|
3072
3109
|
* call `clutter_actor_add_child()`.
|
|
3073
3110
|
* @param actor the first {@link Clutter.Actor} to add
|
|
3111
|
+
* @since 0.4
|
|
3112
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
3074
3113
|
* @virtual
|
|
3075
3114
|
*/
|
|
3076
3115
|
vfunc_add(actor: Clutter.Actor): void;
|
|
@@ -3081,6 +3120,7 @@ export namespace Meta {
|
|
|
3081
3120
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
3082
3121
|
* @param child a {@link Clutter.Actor}
|
|
3083
3122
|
* @param pspec a {@link GObject.ParamSpec}
|
|
3123
|
+
* @since 1.6
|
|
3084
3124
|
* @virtual
|
|
3085
3125
|
*/
|
|
3086
3126
|
vfunc_child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
@@ -3096,6 +3136,7 @@ export namespace Meta {
|
|
|
3096
3136
|
*
|
|
3097
3137
|
* Applications should not call this function.
|
|
3098
3138
|
* @param actor a {@link Clutter.Actor}
|
|
3139
|
+
* @since 1.2
|
|
3099
3140
|
* @virtual
|
|
3100
3141
|
*/
|
|
3101
3142
|
vfunc_create_child_meta(actor: Clutter.Actor): void;
|
|
@@ -3110,6 +3151,7 @@ export namespace Meta {
|
|
|
3110
3151
|
*
|
|
3111
3152
|
* Applications should not call this function.
|
|
3112
3153
|
* @param actor a {@link Clutter.Actor}
|
|
3154
|
+
* @since 1.2
|
|
3113
3155
|
* @virtual
|
|
3114
3156
|
*/
|
|
3115
3157
|
vfunc_destroy_child_meta(actor: Clutter.Actor): void;
|
|
@@ -3123,6 +3165,8 @@ export namespace Meta {
|
|
|
3123
3165
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
3124
3166
|
* virtual function, which has been deprecated.
|
|
3125
3167
|
* @param callback a function to be called for each child
|
|
3168
|
+
* @since 0.4
|
|
3169
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
3126
3170
|
* @virtual
|
|
3127
3171
|
*/
|
|
3128
3172
|
vfunc_foreach(callback: Clutter.Callback): void;
|
|
@@ -3135,6 +3179,8 @@ export namespace Meta {
|
|
|
3135
3179
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
3136
3180
|
* virtual function, which has been deprecated.
|
|
3137
3181
|
* @param callback a function to be called for each child
|
|
3182
|
+
* @since 1.0
|
|
3183
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
3138
3184
|
* @virtual
|
|
3139
3185
|
*/
|
|
3140
3186
|
vfunc_foreach_with_internals(callback: Clutter.Callback): void;
|
|
@@ -3143,6 +3189,7 @@ export namespace Meta {
|
|
|
3143
3189
|
* Retrieves the {@link Clutter.ChildMeta} which contains the data about the
|
|
3144
3190
|
* `container` specific state for `actor`.
|
|
3145
3191
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
3192
|
+
* @since 0.8
|
|
3146
3193
|
* @virtual
|
|
3147
3194
|
*/
|
|
3148
3195
|
vfunc_get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
@@ -3155,6 +3202,8 @@ export namespace Meta {
|
|
|
3155
3202
|
* `clutter_actor_set_child_below_sibling()`.
|
|
3156
3203
|
* @param actor the actor to raise
|
|
3157
3204
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
3205
|
+
* @since 0.6
|
|
3206
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
3158
3207
|
* @virtual
|
|
3159
3208
|
*/
|
|
3160
3209
|
vfunc_lower(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -3167,6 +3216,8 @@ export namespace Meta {
|
|
|
3167
3216
|
* `clutter_actor_set_child_above_sibling()`.
|
|
3168
3217
|
* @param actor the actor to raise
|
|
3169
3218
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
3219
|
+
* @since 0.6
|
|
3220
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
3170
3221
|
* @virtual
|
|
3171
3222
|
*/
|
|
3172
3223
|
vfunc_raise(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -3181,6 +3232,8 @@ export namespace Meta {
|
|
|
3181
3232
|
* deprecated virtual function. The default implementation will call
|
|
3182
3233
|
* `clutter_actor_remove_child()`.
|
|
3183
3234
|
* @param actor a {@link Clutter.Actor}
|
|
3235
|
+
* @since 0.4
|
|
3236
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
3184
3237
|
* @virtual
|
|
3185
3238
|
*/
|
|
3186
3239
|
vfunc_remove(actor: Clutter.Actor): void;
|
|
@@ -3188,6 +3241,8 @@ export namespace Meta {
|
|
|
3188
3241
|
/**
|
|
3189
3242
|
* Sorts a container's children using their depth. This function should not
|
|
3190
3243
|
* be normally used by applications.
|
|
3244
|
+
* @since 0.6
|
|
3245
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
3191
3246
|
* @virtual
|
|
3192
3247
|
*/
|
|
3193
3248
|
vfunc_sort_depth_order(): void;
|
|
@@ -3195,6 +3250,7 @@ export namespace Meta {
|
|
|
3195
3250
|
/**
|
|
3196
3251
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
3197
3252
|
* @returns the id of the object. The returned string is owned by the scriptable object and should never be modified of freed
|
|
3253
|
+
* @since 0.6
|
|
3198
3254
|
*/
|
|
3199
3255
|
get_id(): string;
|
|
3200
3256
|
|
|
@@ -3206,6 +3262,7 @@ export namespace Meta {
|
|
|
3206
3262
|
* @param name the name of the node
|
|
3207
3263
|
* @param node the JSON node to be parsed
|
|
3208
3264
|
* @returns `true` if the node was successfully parsed, `false` otherwise.
|
|
3265
|
+
* @since 0.6
|
|
3209
3266
|
*/
|
|
3210
3267
|
parse_custom_node(script: Clutter.Script, value: GObject.Value | any, name: string, node: Json.Node): boolean;
|
|
3211
3268
|
|
|
@@ -3215,6 +3272,7 @@ export namespace Meta {
|
|
|
3215
3272
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
3216
3273
|
* @param name the name of the property
|
|
3217
3274
|
* @param value the value of the property
|
|
3275
|
+
* @since 0.6
|
|
3218
3276
|
*/
|
|
3219
3277
|
set_custom_property(script: Clutter.Script, name: string, value: GObject.Value | any): void;
|
|
3220
3278
|
|
|
@@ -3226,11 +3284,13 @@ export namespace Meta {
|
|
|
3226
3284
|
* define a unique name for an object constructable using the UI
|
|
3227
3285
|
* definition language parsed by {@link Clutter.Script}.
|
|
3228
3286
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
3287
|
+
* @since 0.6
|
|
3229
3288
|
*/
|
|
3230
3289
|
set_id(id_: string): void;
|
|
3231
3290
|
|
|
3232
3291
|
/**
|
|
3233
3292
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
3293
|
+
* @since 0.6
|
|
3234
3294
|
* @virtual
|
|
3235
3295
|
*/
|
|
3236
3296
|
vfunc_get_id(): string;
|
|
@@ -3242,6 +3302,7 @@ export namespace Meta {
|
|
|
3242
3302
|
* @param value the generic value to be set
|
|
3243
3303
|
* @param name the name of the node
|
|
3244
3304
|
* @param node the JSON node to be parsed
|
|
3305
|
+
* @since 0.6
|
|
3245
3306
|
* @virtual
|
|
3246
3307
|
*/
|
|
3247
3308
|
vfunc_parse_custom_node(script: Clutter.Script, value: unknown, name: string, node: Json.Node): boolean;
|
|
@@ -3252,6 +3313,7 @@ export namespace Meta {
|
|
|
3252
3313
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
3253
3314
|
* @param name the name of the property
|
|
3254
3315
|
* @param value the value of the property
|
|
3316
|
+
* @since 0.6
|
|
3255
3317
|
* @virtual
|
|
3256
3318
|
*/
|
|
3257
3319
|
vfunc_set_custom_property(script: Clutter.Script, name: string, value: unknown): void;
|
|
@@ -3264,6 +3326,7 @@ export namespace Meta {
|
|
|
3264
3326
|
* define a unique name for an object constructable using the UI
|
|
3265
3327
|
* definition language parsed by {@link Clutter.Script}.
|
|
3266
3328
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
3329
|
+
* @since 0.6
|
|
3267
3330
|
* @virtual
|
|
3268
3331
|
*/
|
|
3269
3332
|
vfunc_set_id(id_: string): void;
|
|
@@ -3411,6 +3474,8 @@ export namespace Meta {
|
|
|
3411
3474
|
* @param progress the progress factor
|
|
3412
3475
|
* @param value return location for the animation value
|
|
3413
3476
|
* @returns `true` if the value has been validated and can be applied to the {@link Clutter.Animatable}, and `false` otherwise
|
|
3477
|
+
* @since 1.0
|
|
3478
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
3414
3479
|
*/
|
|
3415
3480
|
animate_property(animation: Clutter.Animation, property_name: string, initial_value: GObject.Value | any, final_value: GObject.Value | any, progress: number, value: GObject.Value | any): boolean;
|
|
3416
3481
|
|
|
@@ -3418,6 +3483,7 @@ export namespace Meta {
|
|
|
3418
3483
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
3419
3484
|
* @param property_name the name of the animatable property to find
|
|
3420
3485
|
* @returns The {@link GObject.ParamSpec} for the given property or `null`
|
|
3486
|
+
* @since 1.4
|
|
3421
3487
|
*/
|
|
3422
3488
|
find_property(property_name: string): GObject.ParamSpec;
|
|
3423
3489
|
|
|
@@ -3425,6 +3491,7 @@ export namespace Meta {
|
|
|
3425
3491
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
3426
3492
|
* @param property_name the name of the animatable property to retrieve
|
|
3427
3493
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
3494
|
+
* @since 1.4
|
|
3428
3495
|
*/
|
|
3429
3496
|
get_initial_state(property_name: string, value: GObject.Value | any): void;
|
|
3430
3497
|
|
|
@@ -3442,6 +3509,7 @@ export namespace Meta {
|
|
|
3442
3509
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
3443
3510
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
3444
3511
|
* @returns `true` if the interpolation was successful, and `false` otherwise
|
|
3512
|
+
* @since 1.8
|
|
3445
3513
|
*/
|
|
3446
3514
|
interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, unknown];
|
|
3447
3515
|
|
|
@@ -3449,6 +3517,7 @@ export namespace Meta {
|
|
|
3449
3517
|
* Sets the current state of `property_name` to `value`
|
|
3450
3518
|
* @param property_name the name of the animatable property to set
|
|
3451
3519
|
* @param value the value of the animatable property to set
|
|
3520
|
+
* @since 1.4
|
|
3452
3521
|
*/
|
|
3453
3522
|
set_final_state(property_name: string, value: GObject.Value | any): void;
|
|
3454
3523
|
|
|
@@ -3467,6 +3536,8 @@ export namespace Meta {
|
|
|
3467
3536
|
* @param final_value the final value of the animation interval
|
|
3468
3537
|
* @param progress the progress factor
|
|
3469
3538
|
* @param value return location for the animation value
|
|
3539
|
+
* @since 1.0
|
|
3540
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
3470
3541
|
* @virtual
|
|
3471
3542
|
*/
|
|
3472
3543
|
vfunc_animate_property(animation: Clutter.Animation, property_name: string, initial_value: unknown, final_value: unknown, progress: number, value: unknown): boolean;
|
|
@@ -3474,6 +3545,7 @@ export namespace Meta {
|
|
|
3474
3545
|
/**
|
|
3475
3546
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
3476
3547
|
* @param property_name the name of the animatable property to find
|
|
3548
|
+
* @since 1.4
|
|
3477
3549
|
* @virtual
|
|
3478
3550
|
*/
|
|
3479
3551
|
vfunc_find_property(property_name: string): GObject.ParamSpec;
|
|
@@ -3482,6 +3554,7 @@ export namespace Meta {
|
|
|
3482
3554
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
3483
3555
|
* @param property_name the name of the animatable property to retrieve
|
|
3484
3556
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
3557
|
+
* @since 1.4
|
|
3485
3558
|
* @virtual
|
|
3486
3559
|
*/
|
|
3487
3560
|
vfunc_get_initial_state(property_name: string, value: unknown): void;
|
|
@@ -3499,6 +3572,7 @@ export namespace Meta {
|
|
|
3499
3572
|
* @param property_name the name of the property to interpolate
|
|
3500
3573
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
3501
3574
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
3575
|
+
* @since 1.8
|
|
3502
3576
|
* @virtual
|
|
3503
3577
|
*/
|
|
3504
3578
|
vfunc_interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, GObject.Value | any];
|
|
@@ -3507,6 +3581,7 @@ export namespace Meta {
|
|
|
3507
3581
|
* Sets the current state of `property_name` to `value`
|
|
3508
3582
|
* @param property_name the name of the animatable property to set
|
|
3509
3583
|
* @param value the value of the animatable property to set
|
|
3584
|
+
* @since 1.4
|
|
3510
3585
|
* @virtual
|
|
3511
3586
|
*/
|
|
3512
3587
|
vfunc_set_final_state(property_name: string, value: unknown): void;
|
|
@@ -3521,6 +3596,8 @@ export namespace Meta {
|
|
|
3521
3596
|
* deprecated virtual function. The default implementation will
|
|
3522
3597
|
* call `clutter_actor_add_child()`.
|
|
3523
3598
|
* @param actor the first {@link Clutter.Actor} to add
|
|
3599
|
+
* @since 0.4
|
|
3600
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
3524
3601
|
*/
|
|
3525
3602
|
add_actor(actor: Clutter.Actor): void;
|
|
3526
3603
|
|
|
@@ -3535,6 +3612,7 @@ export namespace Meta {
|
|
|
3535
3612
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
3536
3613
|
* @param property the name of the property to set.
|
|
3537
3614
|
* @param value the value.
|
|
3615
|
+
* @since 0.8
|
|
3538
3616
|
*/
|
|
3539
3617
|
child_get_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
3540
3618
|
|
|
@@ -3544,6 +3622,7 @@ export namespace Meta {
|
|
|
3544
3622
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
3545
3623
|
* @param child a {@link Clutter.Actor}
|
|
3546
3624
|
* @param pspec a {@link GObject.ParamSpec}
|
|
3625
|
+
* @since 1.6
|
|
3547
3626
|
*/
|
|
3548
3627
|
child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
3549
3628
|
|
|
@@ -3552,6 +3631,7 @@ export namespace Meta {
|
|
|
3552
3631
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
3553
3632
|
* @param property the name of the property to set.
|
|
3554
3633
|
* @param value the value.
|
|
3634
|
+
* @since 0.8
|
|
3555
3635
|
*/
|
|
3556
3636
|
child_set_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
3557
3637
|
|
|
@@ -3566,6 +3646,7 @@ export namespace Meta {
|
|
|
3566
3646
|
*
|
|
3567
3647
|
* Applications should not call this function.
|
|
3568
3648
|
* @param actor a {@link Clutter.Actor}
|
|
3649
|
+
* @since 1.2
|
|
3569
3650
|
*/
|
|
3570
3651
|
create_child_meta(actor: Clutter.Actor): void;
|
|
3571
3652
|
|
|
@@ -3579,6 +3660,7 @@ export namespace Meta {
|
|
|
3579
3660
|
*
|
|
3580
3661
|
* Applications should not call this function.
|
|
3581
3662
|
* @param actor a {@link Clutter.Actor}
|
|
3663
|
+
* @since 1.2
|
|
3582
3664
|
*/
|
|
3583
3665
|
destroy_child_meta(actor: Clutter.Actor): void;
|
|
3584
3666
|
|
|
@@ -3587,6 +3669,7 @@ export namespace Meta {
|
|
|
3587
3669
|
* into any child container.
|
|
3588
3670
|
* @param child_name the name of the requested child.
|
|
3589
3671
|
* @returns The child actor with the requested name, or `null` if no actor with that name was found.
|
|
3672
|
+
* @since 0.6
|
|
3590
3673
|
*/
|
|
3591
3674
|
find_child_by_name(child_name: string): Clutter.Actor;
|
|
3592
3675
|
|
|
@@ -3599,6 +3682,8 @@ export namespace Meta {
|
|
|
3599
3682
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
3600
3683
|
* virtual function, which has been deprecated.
|
|
3601
3684
|
* @param callback a function to be called for each child
|
|
3685
|
+
* @since 0.4
|
|
3686
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
3602
3687
|
*/
|
|
3603
3688
|
foreach(callback: Clutter.Callback): void;
|
|
3604
3689
|
|
|
@@ -3610,6 +3695,8 @@ export namespace Meta {
|
|
|
3610
3695
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
3611
3696
|
* virtual function, which has been deprecated.
|
|
3612
3697
|
* @param callback a function to be called for each child
|
|
3698
|
+
* @since 1.0
|
|
3699
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
3613
3700
|
*/
|
|
3614
3701
|
foreach_with_internals(callback: Clutter.Callback): void;
|
|
3615
3702
|
|
|
@@ -3618,12 +3705,15 @@ export namespace Meta {
|
|
|
3618
3705
|
* `container` specific state for `actor`.
|
|
3619
3706
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
3620
3707
|
* @returns the {@link Clutter.ChildMeta} for the `actor` child of `container` or `null` if the specifiec actor does not exist or the container is not configured to provide {@link Clutter.ChildMeta}<!-- -->s
|
|
3708
|
+
* @since 0.8
|
|
3621
3709
|
*/
|
|
3622
3710
|
get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
3623
3711
|
|
|
3624
3712
|
/**
|
|
3625
3713
|
* Retrieves all the children of `container`.
|
|
3626
3714
|
* @returns a list of {@link Clutter.Actor}<!-- -->s. Use `g_list_free()` on the returned list when done.
|
|
3715
|
+
* @since 0.4
|
|
3716
|
+
* @deprecated since 1.10: Use `clutter_actor_get_children()` instead.
|
|
3627
3717
|
*/
|
|
3628
3718
|
get_children(): Clutter.Actor[];
|
|
3629
3719
|
|
|
@@ -3635,6 +3725,8 @@ export namespace Meta {
|
|
|
3635
3725
|
* `clutter_actor_set_child_below_sibling()`.
|
|
3636
3726
|
* @param actor the actor to raise
|
|
3637
3727
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
3728
|
+
* @since 0.6
|
|
3729
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
3638
3730
|
*/
|
|
3639
3731
|
lower_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
3640
3732
|
|
|
@@ -3646,6 +3738,8 @@ export namespace Meta {
|
|
|
3646
3738
|
* `clutter_actor_set_child_above_sibling()`.
|
|
3647
3739
|
* @param actor the actor to raise
|
|
3648
3740
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
3741
|
+
* @since 0.6
|
|
3742
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
3649
3743
|
*/
|
|
3650
3744
|
raise_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
3651
3745
|
|
|
@@ -3659,12 +3753,16 @@ export namespace Meta {
|
|
|
3659
3753
|
* deprecated virtual function. The default implementation will call
|
|
3660
3754
|
* `clutter_actor_remove_child()`.
|
|
3661
3755
|
* @param actor a {@link Clutter.Actor}
|
|
3756
|
+
* @since 0.4
|
|
3757
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
3662
3758
|
*/
|
|
3663
3759
|
remove_actor(actor: Clutter.Actor): void;
|
|
3664
3760
|
|
|
3665
3761
|
/**
|
|
3666
3762
|
* Sorts a container's children using their depth. This function should not
|
|
3667
3763
|
* be normally used by applications.
|
|
3764
|
+
* @since 0.6
|
|
3765
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
3668
3766
|
*/
|
|
3669
3767
|
sort_depth_order(): void;
|
|
3670
3768
|
|
|
@@ -3690,6 +3788,8 @@ export namespace Meta {
|
|
|
3690
3788
|
* deprecated virtual function. The default implementation will
|
|
3691
3789
|
* call `clutter_actor_add_child()`.
|
|
3692
3790
|
* @param actor the first {@link Clutter.Actor} to add
|
|
3791
|
+
* @since 0.4
|
|
3792
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
3693
3793
|
* @virtual
|
|
3694
3794
|
*/
|
|
3695
3795
|
vfunc_add(actor: Clutter.Actor): void;
|
|
@@ -3700,6 +3800,7 @@ export namespace Meta {
|
|
|
3700
3800
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
3701
3801
|
* @param child a {@link Clutter.Actor}
|
|
3702
3802
|
* @param pspec a {@link GObject.ParamSpec}
|
|
3803
|
+
* @since 1.6
|
|
3703
3804
|
* @virtual
|
|
3704
3805
|
*/
|
|
3705
3806
|
vfunc_child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
@@ -3715,6 +3816,7 @@ export namespace Meta {
|
|
|
3715
3816
|
*
|
|
3716
3817
|
* Applications should not call this function.
|
|
3717
3818
|
* @param actor a {@link Clutter.Actor}
|
|
3819
|
+
* @since 1.2
|
|
3718
3820
|
* @virtual
|
|
3719
3821
|
*/
|
|
3720
3822
|
vfunc_create_child_meta(actor: Clutter.Actor): void;
|
|
@@ -3729,6 +3831,7 @@ export namespace Meta {
|
|
|
3729
3831
|
*
|
|
3730
3832
|
* Applications should not call this function.
|
|
3731
3833
|
* @param actor a {@link Clutter.Actor}
|
|
3834
|
+
* @since 1.2
|
|
3732
3835
|
* @virtual
|
|
3733
3836
|
*/
|
|
3734
3837
|
vfunc_destroy_child_meta(actor: Clutter.Actor): void;
|
|
@@ -3742,6 +3845,8 @@ export namespace Meta {
|
|
|
3742
3845
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
3743
3846
|
* virtual function, which has been deprecated.
|
|
3744
3847
|
* @param callback a function to be called for each child
|
|
3848
|
+
* @since 0.4
|
|
3849
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
3745
3850
|
* @virtual
|
|
3746
3851
|
*/
|
|
3747
3852
|
vfunc_foreach(callback: Clutter.Callback): void;
|
|
@@ -3754,6 +3859,8 @@ export namespace Meta {
|
|
|
3754
3859
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
3755
3860
|
* virtual function, which has been deprecated.
|
|
3756
3861
|
* @param callback a function to be called for each child
|
|
3862
|
+
* @since 1.0
|
|
3863
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
3757
3864
|
* @virtual
|
|
3758
3865
|
*/
|
|
3759
3866
|
vfunc_foreach_with_internals(callback: Clutter.Callback): void;
|
|
@@ -3762,6 +3869,7 @@ export namespace Meta {
|
|
|
3762
3869
|
* Retrieves the {@link Clutter.ChildMeta} which contains the data about the
|
|
3763
3870
|
* `container` specific state for `actor`.
|
|
3764
3871
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
3872
|
+
* @since 0.8
|
|
3765
3873
|
* @virtual
|
|
3766
3874
|
*/
|
|
3767
3875
|
vfunc_get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
@@ -3774,6 +3882,8 @@ export namespace Meta {
|
|
|
3774
3882
|
* `clutter_actor_set_child_below_sibling()`.
|
|
3775
3883
|
* @param actor the actor to raise
|
|
3776
3884
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
3885
|
+
* @since 0.6
|
|
3886
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
3777
3887
|
* @virtual
|
|
3778
3888
|
*/
|
|
3779
3889
|
vfunc_lower(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -3786,6 +3896,8 @@ export namespace Meta {
|
|
|
3786
3896
|
* `clutter_actor_set_child_above_sibling()`.
|
|
3787
3897
|
* @param actor the actor to raise
|
|
3788
3898
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
3899
|
+
* @since 0.6
|
|
3900
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
3789
3901
|
* @virtual
|
|
3790
3902
|
*/
|
|
3791
3903
|
vfunc_raise(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -3800,6 +3912,8 @@ export namespace Meta {
|
|
|
3800
3912
|
* deprecated virtual function. The default implementation will call
|
|
3801
3913
|
* `clutter_actor_remove_child()`.
|
|
3802
3914
|
* @param actor a {@link Clutter.Actor}
|
|
3915
|
+
* @since 0.4
|
|
3916
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
3803
3917
|
* @virtual
|
|
3804
3918
|
*/
|
|
3805
3919
|
vfunc_remove(actor: Clutter.Actor): void;
|
|
@@ -3807,6 +3921,8 @@ export namespace Meta {
|
|
|
3807
3921
|
/**
|
|
3808
3922
|
* Sorts a container's children using their depth. This function should not
|
|
3809
3923
|
* be normally used by applications.
|
|
3924
|
+
* @since 0.6
|
|
3925
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
3810
3926
|
* @virtual
|
|
3811
3927
|
*/
|
|
3812
3928
|
vfunc_sort_depth_order(): void;
|
|
@@ -3814,6 +3930,7 @@ export namespace Meta {
|
|
|
3814
3930
|
/**
|
|
3815
3931
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
3816
3932
|
* @returns the id of the object. The returned string is owned by the scriptable object and should never be modified of freed
|
|
3933
|
+
* @since 0.6
|
|
3817
3934
|
*/
|
|
3818
3935
|
get_id(): string;
|
|
3819
3936
|
|
|
@@ -3825,6 +3942,7 @@ export namespace Meta {
|
|
|
3825
3942
|
* @param name the name of the node
|
|
3826
3943
|
* @param node the JSON node to be parsed
|
|
3827
3944
|
* @returns `true` if the node was successfully parsed, `false` otherwise.
|
|
3945
|
+
* @since 0.6
|
|
3828
3946
|
*/
|
|
3829
3947
|
parse_custom_node(script: Clutter.Script, value: GObject.Value | any, name: string, node: Json.Node): boolean;
|
|
3830
3948
|
|
|
@@ -3834,6 +3952,7 @@ export namespace Meta {
|
|
|
3834
3952
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
3835
3953
|
* @param name the name of the property
|
|
3836
3954
|
* @param value the value of the property
|
|
3955
|
+
* @since 0.6
|
|
3837
3956
|
*/
|
|
3838
3957
|
set_custom_property(script: Clutter.Script, name: string, value: GObject.Value | any): void;
|
|
3839
3958
|
|
|
@@ -3845,11 +3964,13 @@ export namespace Meta {
|
|
|
3845
3964
|
* define a unique name for an object constructable using the UI
|
|
3846
3965
|
* definition language parsed by {@link Clutter.Script}.
|
|
3847
3966
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
3967
|
+
* @since 0.6
|
|
3848
3968
|
*/
|
|
3849
3969
|
set_id(id_: string): void;
|
|
3850
3970
|
|
|
3851
3971
|
/**
|
|
3852
3972
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
3973
|
+
* @since 0.6
|
|
3853
3974
|
* @virtual
|
|
3854
3975
|
*/
|
|
3855
3976
|
vfunc_get_id(): string;
|
|
@@ -3861,6 +3982,7 @@ export namespace Meta {
|
|
|
3861
3982
|
* @param value the generic value to be set
|
|
3862
3983
|
* @param name the name of the node
|
|
3863
3984
|
* @param node the JSON node to be parsed
|
|
3985
|
+
* @since 0.6
|
|
3864
3986
|
* @virtual
|
|
3865
3987
|
*/
|
|
3866
3988
|
vfunc_parse_custom_node(script: Clutter.Script, value: unknown, name: string, node: Json.Node): boolean;
|
|
@@ -3871,6 +3993,7 @@ export namespace Meta {
|
|
|
3871
3993
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
3872
3994
|
* @param name the name of the property
|
|
3873
3995
|
* @param value the value of the property
|
|
3996
|
+
* @since 0.6
|
|
3874
3997
|
* @virtual
|
|
3875
3998
|
*/
|
|
3876
3999
|
vfunc_set_custom_property(script: Clutter.Script, name: string, value: unknown): void;
|
|
@@ -3883,6 +4006,7 @@ export namespace Meta {
|
|
|
3883
4006
|
* define a unique name for an object constructable using the UI
|
|
3884
4007
|
* definition language parsed by {@link Clutter.Script}.
|
|
3885
4008
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
4009
|
+
* @since 0.6
|
|
3886
4010
|
* @virtual
|
|
3887
4011
|
*/
|
|
3888
4012
|
vfunc_set_id(id_: string): void;
|
|
@@ -4266,26 +4390,41 @@ export namespace Meta {
|
|
|
4266
4390
|
/**
|
|
4267
4391
|
* Gets the {@link Gio.DBusObject} that `interface_` belongs to, if any.
|
|
4268
4392
|
* @returns A {@link Gio.DBusObject} or `null`. The returned reference should be freed with `g_object_unref()`.
|
|
4393
|
+
* @since 2.32
|
|
4269
4394
|
*/
|
|
4270
4395
|
get_object(): Gio.DBusObject | null;
|
|
4271
4396
|
|
|
4272
4397
|
/**
|
|
4273
4398
|
* Gets D-Bus introspection information for the D-Bus interface
|
|
4274
4399
|
* implemented by `interface_`.
|
|
4400
|
+
*
|
|
4401
|
+
* This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
|
|
4402
|
+
* construction of `interface_` and is also not made available otherwise.
|
|
4403
|
+
* For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
|
|
4404
|
+
* {@link Gio.DBusInterfaceInfo}.
|
|
4275
4405
|
* @returns A {@link Gio.DBusInterfaceInfo}. Do not free.
|
|
4406
|
+
* @since 2.30
|
|
4276
4407
|
*/
|
|
4277
|
-
get_info(): Gio.DBusInterfaceInfo;
|
|
4408
|
+
get_info(): Gio.DBusInterfaceInfo | null;
|
|
4409
|
+
|
|
4410
|
+
/**
|
|
4411
|
+
* @param args
|
|
4412
|
+
*/
|
|
4413
|
+
// Conflicted with Gio.DBusInterfaceSkeleton.get_info
|
|
4414
|
+
get_info(...args: never[]): any;
|
|
4278
4415
|
|
|
4279
4416
|
/**
|
|
4280
4417
|
* Sets the {@link Gio.DBusObject} for `interface_` to `object`.
|
|
4281
4418
|
*
|
|
4282
4419
|
* Note that `interface_` will hold a weak reference to `object`.
|
|
4283
4420
|
* @param object A {@link Gio.DBusObject} or `null`.
|
|
4421
|
+
* @since 2.30
|
|
4284
4422
|
*/
|
|
4285
4423
|
set_object(object: Gio.DBusObject | null): void;
|
|
4286
4424
|
|
|
4287
4425
|
/**
|
|
4288
4426
|
* Gets the {@link Gio.DBusObject} that `interface_` belongs to, if any.
|
|
4427
|
+
* @since 2.32
|
|
4289
4428
|
* @virtual
|
|
4290
4429
|
*/
|
|
4291
4430
|
vfunc_dup_object(): Gio.DBusObject | null;
|
|
@@ -4293,15 +4432,29 @@ export namespace Meta {
|
|
|
4293
4432
|
/**
|
|
4294
4433
|
* Gets D-Bus introspection information for the D-Bus interface
|
|
4295
4434
|
* implemented by `interface_`.
|
|
4435
|
+
*
|
|
4436
|
+
* This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
|
|
4437
|
+
* construction of `interface_` and is also not made available otherwise.
|
|
4438
|
+
* For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
|
|
4439
|
+
* {@link Gio.DBusInterfaceInfo}.
|
|
4440
|
+
* @since 2.30
|
|
4441
|
+
* @virtual
|
|
4442
|
+
*/
|
|
4443
|
+
vfunc_get_info(): Gio.DBusInterfaceInfo | null;
|
|
4444
|
+
|
|
4445
|
+
/**
|
|
4446
|
+
* @param args
|
|
4296
4447
|
* @virtual
|
|
4297
4448
|
*/
|
|
4298
|
-
|
|
4449
|
+
// Conflicted with Gio.DBusInterfaceSkeleton.vfunc_get_info
|
|
4450
|
+
vfunc_get_info(...args: never[]): any;
|
|
4299
4451
|
|
|
4300
4452
|
/**
|
|
4301
4453
|
* Sets the {@link Gio.DBusObject} for `interface_` to `object`.
|
|
4302
4454
|
*
|
|
4303
4455
|
* Note that `interface_` will hold a weak reference to `object`.
|
|
4304
4456
|
* @param object A {@link Gio.DBusObject} or `null`.
|
|
4457
|
+
* @since 2.30
|
|
4305
4458
|
* @virtual
|
|
4306
4459
|
*/
|
|
4307
4460
|
vfunc_set_object(object: Gio.DBusObject | null): void;
|
|
@@ -5680,6 +5833,8 @@ export namespace Meta {
|
|
|
5680
5833
|
* @param progress the progress factor
|
|
5681
5834
|
* @param value return location for the animation value
|
|
5682
5835
|
* @returns `true` if the value has been validated and can be applied to the {@link Clutter.Animatable}, and `false` otherwise
|
|
5836
|
+
* @since 1.0
|
|
5837
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
5683
5838
|
*/
|
|
5684
5839
|
animate_property(animation: Clutter.Animation, property_name: string, initial_value: GObject.Value | any, final_value: GObject.Value | any, progress: number, value: GObject.Value | any): boolean;
|
|
5685
5840
|
|
|
@@ -5687,6 +5842,7 @@ export namespace Meta {
|
|
|
5687
5842
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
5688
5843
|
* @param property_name the name of the animatable property to find
|
|
5689
5844
|
* @returns The {@link GObject.ParamSpec} for the given property or `null`
|
|
5845
|
+
* @since 1.4
|
|
5690
5846
|
*/
|
|
5691
5847
|
find_property(property_name: string): GObject.ParamSpec;
|
|
5692
5848
|
|
|
@@ -5694,6 +5850,7 @@ export namespace Meta {
|
|
|
5694
5850
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
5695
5851
|
* @param property_name the name of the animatable property to retrieve
|
|
5696
5852
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
5853
|
+
* @since 1.4
|
|
5697
5854
|
*/
|
|
5698
5855
|
get_initial_state(property_name: string, value: GObject.Value | any): void;
|
|
5699
5856
|
|
|
@@ -5711,6 +5868,7 @@ export namespace Meta {
|
|
|
5711
5868
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
5712
5869
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
5713
5870
|
* @returns `true` if the interpolation was successful, and `false` otherwise
|
|
5871
|
+
* @since 1.8
|
|
5714
5872
|
*/
|
|
5715
5873
|
interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, unknown];
|
|
5716
5874
|
|
|
@@ -5718,6 +5876,7 @@ export namespace Meta {
|
|
|
5718
5876
|
* Sets the current state of `property_name` to `value`
|
|
5719
5877
|
* @param property_name the name of the animatable property to set
|
|
5720
5878
|
* @param value the value of the animatable property to set
|
|
5879
|
+
* @since 1.4
|
|
5721
5880
|
*/
|
|
5722
5881
|
set_final_state(property_name: string, value: GObject.Value | any): void;
|
|
5723
5882
|
|
|
@@ -5736,6 +5895,8 @@ export namespace Meta {
|
|
|
5736
5895
|
* @param final_value the final value of the animation interval
|
|
5737
5896
|
* @param progress the progress factor
|
|
5738
5897
|
* @param value return location for the animation value
|
|
5898
|
+
* @since 1.0
|
|
5899
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
5739
5900
|
* @virtual
|
|
5740
5901
|
*/
|
|
5741
5902
|
vfunc_animate_property(animation: Clutter.Animation, property_name: string, initial_value: unknown, final_value: unknown, progress: number, value: unknown): boolean;
|
|
@@ -5743,6 +5904,7 @@ export namespace Meta {
|
|
|
5743
5904
|
/**
|
|
5744
5905
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
5745
5906
|
* @param property_name the name of the animatable property to find
|
|
5907
|
+
* @since 1.4
|
|
5746
5908
|
* @virtual
|
|
5747
5909
|
*/
|
|
5748
5910
|
vfunc_find_property(property_name: string): GObject.ParamSpec;
|
|
@@ -5751,6 +5913,7 @@ export namespace Meta {
|
|
|
5751
5913
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
5752
5914
|
* @param property_name the name of the animatable property to retrieve
|
|
5753
5915
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
5916
|
+
* @since 1.4
|
|
5754
5917
|
* @virtual
|
|
5755
5918
|
*/
|
|
5756
5919
|
vfunc_get_initial_state(property_name: string, value: unknown): void;
|
|
@@ -5768,6 +5931,7 @@ export namespace Meta {
|
|
|
5768
5931
|
* @param property_name the name of the property to interpolate
|
|
5769
5932
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
5770
5933
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
5934
|
+
* @since 1.8
|
|
5771
5935
|
* @virtual
|
|
5772
5936
|
*/
|
|
5773
5937
|
vfunc_interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, GObject.Value | any];
|
|
@@ -5776,6 +5940,7 @@ export namespace Meta {
|
|
|
5776
5940
|
* Sets the current state of `property_name` to `value`
|
|
5777
5941
|
* @param property_name the name of the animatable property to set
|
|
5778
5942
|
* @param value the value of the animatable property to set
|
|
5943
|
+
* @since 1.4
|
|
5779
5944
|
* @virtual
|
|
5780
5945
|
*/
|
|
5781
5946
|
vfunc_set_final_state(property_name: string, value: unknown): void;
|
|
@@ -5790,6 +5955,8 @@ export namespace Meta {
|
|
|
5790
5955
|
* deprecated virtual function. The default implementation will
|
|
5791
5956
|
* call `clutter_actor_add_child()`.
|
|
5792
5957
|
* @param actor the first {@link Clutter.Actor} to add
|
|
5958
|
+
* @since 0.4
|
|
5959
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
5793
5960
|
*/
|
|
5794
5961
|
add_actor(actor: Clutter.Actor): void;
|
|
5795
5962
|
|
|
@@ -5804,6 +5971,7 @@ export namespace Meta {
|
|
|
5804
5971
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
5805
5972
|
* @param property the name of the property to set.
|
|
5806
5973
|
* @param value the value.
|
|
5974
|
+
* @since 0.8
|
|
5807
5975
|
*/
|
|
5808
5976
|
child_get_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
5809
5977
|
|
|
@@ -5813,6 +5981,7 @@ export namespace Meta {
|
|
|
5813
5981
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
5814
5982
|
* @param child a {@link Clutter.Actor}
|
|
5815
5983
|
* @param pspec a {@link GObject.ParamSpec}
|
|
5984
|
+
* @since 1.6
|
|
5816
5985
|
*/
|
|
5817
5986
|
child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
5818
5987
|
|
|
@@ -5821,6 +5990,7 @@ export namespace Meta {
|
|
|
5821
5990
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
5822
5991
|
* @param property the name of the property to set.
|
|
5823
5992
|
* @param value the value.
|
|
5993
|
+
* @since 0.8
|
|
5824
5994
|
*/
|
|
5825
5995
|
child_set_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
5826
5996
|
|
|
@@ -5835,6 +6005,7 @@ export namespace Meta {
|
|
|
5835
6005
|
*
|
|
5836
6006
|
* Applications should not call this function.
|
|
5837
6007
|
* @param actor a {@link Clutter.Actor}
|
|
6008
|
+
* @since 1.2
|
|
5838
6009
|
*/
|
|
5839
6010
|
create_child_meta(actor: Clutter.Actor): void;
|
|
5840
6011
|
|
|
@@ -5848,6 +6019,7 @@ export namespace Meta {
|
|
|
5848
6019
|
*
|
|
5849
6020
|
* Applications should not call this function.
|
|
5850
6021
|
* @param actor a {@link Clutter.Actor}
|
|
6022
|
+
* @since 1.2
|
|
5851
6023
|
*/
|
|
5852
6024
|
destroy_child_meta(actor: Clutter.Actor): void;
|
|
5853
6025
|
|
|
@@ -5856,6 +6028,7 @@ export namespace Meta {
|
|
|
5856
6028
|
* into any child container.
|
|
5857
6029
|
* @param child_name the name of the requested child.
|
|
5858
6030
|
* @returns The child actor with the requested name, or `null` if no actor with that name was found.
|
|
6031
|
+
* @since 0.6
|
|
5859
6032
|
*/
|
|
5860
6033
|
find_child_by_name(child_name: string): Clutter.Actor;
|
|
5861
6034
|
|
|
@@ -5868,6 +6041,8 @@ export namespace Meta {
|
|
|
5868
6041
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
5869
6042
|
* virtual function, which has been deprecated.
|
|
5870
6043
|
* @param callback a function to be called for each child
|
|
6044
|
+
* @since 0.4
|
|
6045
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
5871
6046
|
*/
|
|
5872
6047
|
foreach(callback: Clutter.Callback): void;
|
|
5873
6048
|
|
|
@@ -5879,6 +6054,8 @@ export namespace Meta {
|
|
|
5879
6054
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
5880
6055
|
* virtual function, which has been deprecated.
|
|
5881
6056
|
* @param callback a function to be called for each child
|
|
6057
|
+
* @since 1.0
|
|
6058
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
5882
6059
|
*/
|
|
5883
6060
|
foreach_with_internals(callback: Clutter.Callback): void;
|
|
5884
6061
|
|
|
@@ -5887,12 +6064,15 @@ export namespace Meta {
|
|
|
5887
6064
|
* `container` specific state for `actor`.
|
|
5888
6065
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
5889
6066
|
* @returns the {@link Clutter.ChildMeta} for the `actor` child of `container` or `null` if the specifiec actor does not exist or the container is not configured to provide {@link Clutter.ChildMeta}<!-- -->s
|
|
6067
|
+
* @since 0.8
|
|
5890
6068
|
*/
|
|
5891
6069
|
get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
5892
6070
|
|
|
5893
6071
|
/**
|
|
5894
6072
|
* Retrieves all the children of `container`.
|
|
5895
6073
|
* @returns a list of {@link Clutter.Actor}<!-- -->s. Use `g_list_free()` on the returned list when done.
|
|
6074
|
+
* @since 0.4
|
|
6075
|
+
* @deprecated since 1.10: Use `clutter_actor_get_children()` instead.
|
|
5896
6076
|
*/
|
|
5897
6077
|
get_children(): Clutter.Actor[];
|
|
5898
6078
|
|
|
@@ -5904,6 +6084,8 @@ export namespace Meta {
|
|
|
5904
6084
|
* `clutter_actor_set_child_below_sibling()`.
|
|
5905
6085
|
* @param actor the actor to raise
|
|
5906
6086
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
6087
|
+
* @since 0.6
|
|
6088
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
5907
6089
|
*/
|
|
5908
6090
|
lower_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
5909
6091
|
|
|
@@ -5915,6 +6097,8 @@ export namespace Meta {
|
|
|
5915
6097
|
* `clutter_actor_set_child_above_sibling()`.
|
|
5916
6098
|
* @param actor the actor to raise
|
|
5917
6099
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
6100
|
+
* @since 0.6
|
|
6101
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
5918
6102
|
*/
|
|
5919
6103
|
raise_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
5920
6104
|
|
|
@@ -5928,12 +6112,16 @@ export namespace Meta {
|
|
|
5928
6112
|
* deprecated virtual function. The default implementation will call
|
|
5929
6113
|
* `clutter_actor_remove_child()`.
|
|
5930
6114
|
* @param actor a {@link Clutter.Actor}
|
|
6115
|
+
* @since 0.4
|
|
6116
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
5931
6117
|
*/
|
|
5932
6118
|
remove_actor(actor: Clutter.Actor): void;
|
|
5933
6119
|
|
|
5934
6120
|
/**
|
|
5935
6121
|
* Sorts a container's children using their depth. This function should not
|
|
5936
6122
|
* be normally used by applications.
|
|
6123
|
+
* @since 0.6
|
|
6124
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
5937
6125
|
*/
|
|
5938
6126
|
sort_depth_order(): void;
|
|
5939
6127
|
|
|
@@ -5959,6 +6147,8 @@ export namespace Meta {
|
|
|
5959
6147
|
* deprecated virtual function. The default implementation will
|
|
5960
6148
|
* call `clutter_actor_add_child()`.
|
|
5961
6149
|
* @param actor the first {@link Clutter.Actor} to add
|
|
6150
|
+
* @since 0.4
|
|
6151
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
5962
6152
|
* @virtual
|
|
5963
6153
|
*/
|
|
5964
6154
|
vfunc_add(actor: Clutter.Actor): void;
|
|
@@ -5969,6 +6159,7 @@ export namespace Meta {
|
|
|
5969
6159
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
5970
6160
|
* @param child a {@link Clutter.Actor}
|
|
5971
6161
|
* @param pspec a {@link GObject.ParamSpec}
|
|
6162
|
+
* @since 1.6
|
|
5972
6163
|
* @virtual
|
|
5973
6164
|
*/
|
|
5974
6165
|
vfunc_child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
@@ -5984,6 +6175,7 @@ export namespace Meta {
|
|
|
5984
6175
|
*
|
|
5985
6176
|
* Applications should not call this function.
|
|
5986
6177
|
* @param actor a {@link Clutter.Actor}
|
|
6178
|
+
* @since 1.2
|
|
5987
6179
|
* @virtual
|
|
5988
6180
|
*/
|
|
5989
6181
|
vfunc_create_child_meta(actor: Clutter.Actor): void;
|
|
@@ -5998,6 +6190,7 @@ export namespace Meta {
|
|
|
5998
6190
|
*
|
|
5999
6191
|
* Applications should not call this function.
|
|
6000
6192
|
* @param actor a {@link Clutter.Actor}
|
|
6193
|
+
* @since 1.2
|
|
6001
6194
|
* @virtual
|
|
6002
6195
|
*/
|
|
6003
6196
|
vfunc_destroy_child_meta(actor: Clutter.Actor): void;
|
|
@@ -6011,6 +6204,8 @@ export namespace Meta {
|
|
|
6011
6204
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
6012
6205
|
* virtual function, which has been deprecated.
|
|
6013
6206
|
* @param callback a function to be called for each child
|
|
6207
|
+
* @since 0.4
|
|
6208
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
6014
6209
|
* @virtual
|
|
6015
6210
|
*/
|
|
6016
6211
|
vfunc_foreach(callback: Clutter.Callback): void;
|
|
@@ -6023,6 +6218,8 @@ export namespace Meta {
|
|
|
6023
6218
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
6024
6219
|
* virtual function, which has been deprecated.
|
|
6025
6220
|
* @param callback a function to be called for each child
|
|
6221
|
+
* @since 1.0
|
|
6222
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
6026
6223
|
* @virtual
|
|
6027
6224
|
*/
|
|
6028
6225
|
vfunc_foreach_with_internals(callback: Clutter.Callback): void;
|
|
@@ -6031,6 +6228,7 @@ export namespace Meta {
|
|
|
6031
6228
|
* Retrieves the {@link Clutter.ChildMeta} which contains the data about the
|
|
6032
6229
|
* `container` specific state for `actor`.
|
|
6033
6230
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
6231
|
+
* @since 0.8
|
|
6034
6232
|
* @virtual
|
|
6035
6233
|
*/
|
|
6036
6234
|
vfunc_get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
@@ -6043,6 +6241,8 @@ export namespace Meta {
|
|
|
6043
6241
|
* `clutter_actor_set_child_below_sibling()`.
|
|
6044
6242
|
* @param actor the actor to raise
|
|
6045
6243
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
6244
|
+
* @since 0.6
|
|
6245
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
6046
6246
|
* @virtual
|
|
6047
6247
|
*/
|
|
6048
6248
|
vfunc_lower(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -6055,6 +6255,8 @@ export namespace Meta {
|
|
|
6055
6255
|
* `clutter_actor_set_child_above_sibling()`.
|
|
6056
6256
|
* @param actor the actor to raise
|
|
6057
6257
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
6258
|
+
* @since 0.6
|
|
6259
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
6058
6260
|
* @virtual
|
|
6059
6261
|
*/
|
|
6060
6262
|
vfunc_raise(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -6069,6 +6271,8 @@ export namespace Meta {
|
|
|
6069
6271
|
* deprecated virtual function. The default implementation will call
|
|
6070
6272
|
* `clutter_actor_remove_child()`.
|
|
6071
6273
|
* @param actor a {@link Clutter.Actor}
|
|
6274
|
+
* @since 0.4
|
|
6275
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
6072
6276
|
* @virtual
|
|
6073
6277
|
*/
|
|
6074
6278
|
vfunc_remove(actor: Clutter.Actor): void;
|
|
@@ -6076,6 +6280,8 @@ export namespace Meta {
|
|
|
6076
6280
|
/**
|
|
6077
6281
|
* Sorts a container's children using their depth. This function should not
|
|
6078
6282
|
* be normally used by applications.
|
|
6283
|
+
* @since 0.6
|
|
6284
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
6079
6285
|
* @virtual
|
|
6080
6286
|
*/
|
|
6081
6287
|
vfunc_sort_depth_order(): void;
|
|
@@ -6083,6 +6289,7 @@ export namespace Meta {
|
|
|
6083
6289
|
/**
|
|
6084
6290
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
6085
6291
|
* @returns the id of the object. The returned string is owned by the scriptable object and should never be modified of freed
|
|
6292
|
+
* @since 0.6
|
|
6086
6293
|
*/
|
|
6087
6294
|
get_id(): string;
|
|
6088
6295
|
|
|
@@ -6094,6 +6301,7 @@ export namespace Meta {
|
|
|
6094
6301
|
* @param name the name of the node
|
|
6095
6302
|
* @param node the JSON node to be parsed
|
|
6096
6303
|
* @returns `true` if the node was successfully parsed, `false` otherwise.
|
|
6304
|
+
* @since 0.6
|
|
6097
6305
|
*/
|
|
6098
6306
|
parse_custom_node(script: Clutter.Script, value: GObject.Value | any, name: string, node: Json.Node): boolean;
|
|
6099
6307
|
|
|
@@ -6103,6 +6311,7 @@ export namespace Meta {
|
|
|
6103
6311
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
6104
6312
|
* @param name the name of the property
|
|
6105
6313
|
* @param value the value of the property
|
|
6314
|
+
* @since 0.6
|
|
6106
6315
|
*/
|
|
6107
6316
|
set_custom_property(script: Clutter.Script, name: string, value: GObject.Value | any): void;
|
|
6108
6317
|
|
|
@@ -6114,11 +6323,13 @@ export namespace Meta {
|
|
|
6114
6323
|
* define a unique name for an object constructable using the UI
|
|
6115
6324
|
* definition language parsed by {@link Clutter.Script}.
|
|
6116
6325
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
6326
|
+
* @since 0.6
|
|
6117
6327
|
*/
|
|
6118
6328
|
set_id(id_: string): void;
|
|
6119
6329
|
|
|
6120
6330
|
/**
|
|
6121
6331
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
6332
|
+
* @since 0.6
|
|
6122
6333
|
* @virtual
|
|
6123
6334
|
*/
|
|
6124
6335
|
vfunc_get_id(): string;
|
|
@@ -6130,6 +6341,7 @@ export namespace Meta {
|
|
|
6130
6341
|
* @param value the generic value to be set
|
|
6131
6342
|
* @param name the name of the node
|
|
6132
6343
|
* @param node the JSON node to be parsed
|
|
6344
|
+
* @since 0.6
|
|
6133
6345
|
* @virtual
|
|
6134
6346
|
*/
|
|
6135
6347
|
vfunc_parse_custom_node(script: Clutter.Script, value: unknown, name: string, node: Json.Node): boolean;
|
|
@@ -6140,6 +6352,7 @@ export namespace Meta {
|
|
|
6140
6352
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
6141
6353
|
* @param name the name of the property
|
|
6142
6354
|
* @param value the value of the property
|
|
6355
|
+
* @since 0.6
|
|
6143
6356
|
* @virtual
|
|
6144
6357
|
*/
|
|
6145
6358
|
vfunc_set_custom_property(script: Clutter.Script, name: string, value: unknown): void;
|
|
@@ -6152,6 +6365,7 @@ export namespace Meta {
|
|
|
6152
6365
|
* define a unique name for an object constructable using the UI
|
|
6153
6366
|
* definition language parsed by {@link Clutter.Script}.
|
|
6154
6367
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
6368
|
+
* @since 0.6
|
|
6155
6369
|
* @virtual
|
|
6156
6370
|
*/
|
|
6157
6371
|
vfunc_set_id(id_: string): void;
|
|
@@ -7404,6 +7618,8 @@ export namespace Meta {
|
|
|
7404
7618
|
* @param progress the progress factor
|
|
7405
7619
|
* @param value return location for the animation value
|
|
7406
7620
|
* @returns `true` if the value has been validated and can be applied to the {@link Clutter.Animatable}, and `false` otherwise
|
|
7621
|
+
* @since 1.0
|
|
7622
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
7407
7623
|
*/
|
|
7408
7624
|
animate_property(animation: Clutter.Animation, property_name: string, initial_value: GObject.Value | any, final_value: GObject.Value | any, progress: number, value: GObject.Value | any): boolean;
|
|
7409
7625
|
|
|
@@ -7411,6 +7627,7 @@ export namespace Meta {
|
|
|
7411
7627
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
7412
7628
|
* @param property_name the name of the animatable property to find
|
|
7413
7629
|
* @returns The {@link GObject.ParamSpec} for the given property or `null`
|
|
7630
|
+
* @since 1.4
|
|
7414
7631
|
*/
|
|
7415
7632
|
find_property(property_name: string): GObject.ParamSpec;
|
|
7416
7633
|
|
|
@@ -7418,6 +7635,7 @@ export namespace Meta {
|
|
|
7418
7635
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
7419
7636
|
* @param property_name the name of the animatable property to retrieve
|
|
7420
7637
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
7638
|
+
* @since 1.4
|
|
7421
7639
|
*/
|
|
7422
7640
|
get_initial_state(property_name: string, value: GObject.Value | any): void;
|
|
7423
7641
|
|
|
@@ -7435,6 +7653,7 @@ export namespace Meta {
|
|
|
7435
7653
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
7436
7654
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
7437
7655
|
* @returns `true` if the interpolation was successful, and `false` otherwise
|
|
7656
|
+
* @since 1.8
|
|
7438
7657
|
*/
|
|
7439
7658
|
interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, unknown];
|
|
7440
7659
|
|
|
@@ -7442,6 +7661,7 @@ export namespace Meta {
|
|
|
7442
7661
|
* Sets the current state of `property_name` to `value`
|
|
7443
7662
|
* @param property_name the name of the animatable property to set
|
|
7444
7663
|
* @param value the value of the animatable property to set
|
|
7664
|
+
* @since 1.4
|
|
7445
7665
|
*/
|
|
7446
7666
|
set_final_state(property_name: string, value: GObject.Value | any): void;
|
|
7447
7667
|
|
|
@@ -7460,6 +7680,8 @@ export namespace Meta {
|
|
|
7460
7680
|
* @param final_value the final value of the animation interval
|
|
7461
7681
|
* @param progress the progress factor
|
|
7462
7682
|
* @param value return location for the animation value
|
|
7683
|
+
* @since 1.0
|
|
7684
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
7463
7685
|
* @virtual
|
|
7464
7686
|
*/
|
|
7465
7687
|
vfunc_animate_property(animation: Clutter.Animation, property_name: string, initial_value: unknown, final_value: unknown, progress: number, value: unknown): boolean;
|
|
@@ -7467,6 +7689,7 @@ export namespace Meta {
|
|
|
7467
7689
|
/**
|
|
7468
7690
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
7469
7691
|
* @param property_name the name of the animatable property to find
|
|
7692
|
+
* @since 1.4
|
|
7470
7693
|
* @virtual
|
|
7471
7694
|
*/
|
|
7472
7695
|
vfunc_find_property(property_name: string): GObject.ParamSpec;
|
|
@@ -7475,6 +7698,7 @@ export namespace Meta {
|
|
|
7475
7698
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
7476
7699
|
* @param property_name the name of the animatable property to retrieve
|
|
7477
7700
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
7701
|
+
* @since 1.4
|
|
7478
7702
|
* @virtual
|
|
7479
7703
|
*/
|
|
7480
7704
|
vfunc_get_initial_state(property_name: string, value: unknown): void;
|
|
@@ -7492,6 +7716,7 @@ export namespace Meta {
|
|
|
7492
7716
|
* @param property_name the name of the property to interpolate
|
|
7493
7717
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
7494
7718
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
7719
|
+
* @since 1.8
|
|
7495
7720
|
* @virtual
|
|
7496
7721
|
*/
|
|
7497
7722
|
vfunc_interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, GObject.Value | any];
|
|
@@ -7500,6 +7725,7 @@ export namespace Meta {
|
|
|
7500
7725
|
* Sets the current state of `property_name` to `value`
|
|
7501
7726
|
* @param property_name the name of the animatable property to set
|
|
7502
7727
|
* @param value the value of the animatable property to set
|
|
7728
|
+
* @since 1.4
|
|
7503
7729
|
* @virtual
|
|
7504
7730
|
*/
|
|
7505
7731
|
vfunc_set_final_state(property_name: string, value: unknown): void;
|
|
@@ -7514,6 +7740,8 @@ export namespace Meta {
|
|
|
7514
7740
|
* deprecated virtual function. The default implementation will
|
|
7515
7741
|
* call `clutter_actor_add_child()`.
|
|
7516
7742
|
* @param actor the first {@link Clutter.Actor} to add
|
|
7743
|
+
* @since 0.4
|
|
7744
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
7517
7745
|
*/
|
|
7518
7746
|
add_actor(actor: Clutter.Actor): void;
|
|
7519
7747
|
|
|
@@ -7528,6 +7756,7 @@ export namespace Meta {
|
|
|
7528
7756
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
7529
7757
|
* @param property the name of the property to set.
|
|
7530
7758
|
* @param value the value.
|
|
7759
|
+
* @since 0.8
|
|
7531
7760
|
*/
|
|
7532
7761
|
child_get_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
7533
7762
|
|
|
@@ -7537,6 +7766,7 @@ export namespace Meta {
|
|
|
7537
7766
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
7538
7767
|
* @param child a {@link Clutter.Actor}
|
|
7539
7768
|
* @param pspec a {@link GObject.ParamSpec}
|
|
7769
|
+
* @since 1.6
|
|
7540
7770
|
*/
|
|
7541
7771
|
child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
7542
7772
|
|
|
@@ -7545,6 +7775,7 @@ export namespace Meta {
|
|
|
7545
7775
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
7546
7776
|
* @param property the name of the property to set.
|
|
7547
7777
|
* @param value the value.
|
|
7778
|
+
* @since 0.8
|
|
7548
7779
|
*/
|
|
7549
7780
|
child_set_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
7550
7781
|
|
|
@@ -7559,6 +7790,7 @@ export namespace Meta {
|
|
|
7559
7790
|
*
|
|
7560
7791
|
* Applications should not call this function.
|
|
7561
7792
|
* @param actor a {@link Clutter.Actor}
|
|
7793
|
+
* @since 1.2
|
|
7562
7794
|
*/
|
|
7563
7795
|
create_child_meta(actor: Clutter.Actor): void;
|
|
7564
7796
|
|
|
@@ -7572,6 +7804,7 @@ export namespace Meta {
|
|
|
7572
7804
|
*
|
|
7573
7805
|
* Applications should not call this function.
|
|
7574
7806
|
* @param actor a {@link Clutter.Actor}
|
|
7807
|
+
* @since 1.2
|
|
7575
7808
|
*/
|
|
7576
7809
|
destroy_child_meta(actor: Clutter.Actor): void;
|
|
7577
7810
|
|
|
@@ -7580,6 +7813,7 @@ export namespace Meta {
|
|
|
7580
7813
|
* into any child container.
|
|
7581
7814
|
* @param child_name the name of the requested child.
|
|
7582
7815
|
* @returns The child actor with the requested name, or `null` if no actor with that name was found.
|
|
7816
|
+
* @since 0.6
|
|
7583
7817
|
*/
|
|
7584
7818
|
find_child_by_name(child_name: string): Clutter.Actor;
|
|
7585
7819
|
|
|
@@ -7592,6 +7826,8 @@ export namespace Meta {
|
|
|
7592
7826
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
7593
7827
|
* virtual function, which has been deprecated.
|
|
7594
7828
|
* @param callback a function to be called for each child
|
|
7829
|
+
* @since 0.4
|
|
7830
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
7595
7831
|
*/
|
|
7596
7832
|
foreach(callback: Clutter.Callback): void;
|
|
7597
7833
|
|
|
@@ -7603,6 +7839,8 @@ export namespace Meta {
|
|
|
7603
7839
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
7604
7840
|
* virtual function, which has been deprecated.
|
|
7605
7841
|
* @param callback a function to be called for each child
|
|
7842
|
+
* @since 1.0
|
|
7843
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
7606
7844
|
*/
|
|
7607
7845
|
foreach_with_internals(callback: Clutter.Callback): void;
|
|
7608
7846
|
|
|
@@ -7611,12 +7849,15 @@ export namespace Meta {
|
|
|
7611
7849
|
* `container` specific state for `actor`.
|
|
7612
7850
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
7613
7851
|
* @returns the {@link Clutter.ChildMeta} for the `actor` child of `container` or `null` if the specifiec actor does not exist or the container is not configured to provide {@link Clutter.ChildMeta}<!-- -->s
|
|
7852
|
+
* @since 0.8
|
|
7614
7853
|
*/
|
|
7615
7854
|
get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
7616
7855
|
|
|
7617
7856
|
/**
|
|
7618
7857
|
* Retrieves all the children of `container`.
|
|
7619
7858
|
* @returns a list of {@link Clutter.Actor}<!-- -->s. Use `g_list_free()` on the returned list when done.
|
|
7859
|
+
* @since 0.4
|
|
7860
|
+
* @deprecated since 1.10: Use `clutter_actor_get_children()` instead.
|
|
7620
7861
|
*/
|
|
7621
7862
|
get_children(): Clutter.Actor[];
|
|
7622
7863
|
|
|
@@ -7628,6 +7869,8 @@ export namespace Meta {
|
|
|
7628
7869
|
* `clutter_actor_set_child_below_sibling()`.
|
|
7629
7870
|
* @param actor the actor to raise
|
|
7630
7871
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
7872
|
+
* @since 0.6
|
|
7873
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
7631
7874
|
*/
|
|
7632
7875
|
lower_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
7633
7876
|
|
|
@@ -7639,6 +7882,8 @@ export namespace Meta {
|
|
|
7639
7882
|
* `clutter_actor_set_child_above_sibling()`.
|
|
7640
7883
|
* @param actor the actor to raise
|
|
7641
7884
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
7885
|
+
* @since 0.6
|
|
7886
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
7642
7887
|
*/
|
|
7643
7888
|
raise_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
7644
7889
|
|
|
@@ -7652,12 +7897,16 @@ export namespace Meta {
|
|
|
7652
7897
|
* deprecated virtual function. The default implementation will call
|
|
7653
7898
|
* `clutter_actor_remove_child()`.
|
|
7654
7899
|
* @param actor a {@link Clutter.Actor}
|
|
7900
|
+
* @since 0.4
|
|
7901
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
7655
7902
|
*/
|
|
7656
7903
|
remove_actor(actor: Clutter.Actor): void;
|
|
7657
7904
|
|
|
7658
7905
|
/**
|
|
7659
7906
|
* Sorts a container's children using their depth. This function should not
|
|
7660
7907
|
* be normally used by applications.
|
|
7908
|
+
* @since 0.6
|
|
7909
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
7661
7910
|
*/
|
|
7662
7911
|
sort_depth_order(): void;
|
|
7663
7912
|
|
|
@@ -7683,6 +7932,8 @@ export namespace Meta {
|
|
|
7683
7932
|
* deprecated virtual function. The default implementation will
|
|
7684
7933
|
* call `clutter_actor_add_child()`.
|
|
7685
7934
|
* @param actor the first {@link Clutter.Actor} to add
|
|
7935
|
+
* @since 0.4
|
|
7936
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
7686
7937
|
* @virtual
|
|
7687
7938
|
*/
|
|
7688
7939
|
vfunc_add(actor: Clutter.Actor): void;
|
|
@@ -7693,6 +7944,7 @@ export namespace Meta {
|
|
|
7693
7944
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
7694
7945
|
* @param child a {@link Clutter.Actor}
|
|
7695
7946
|
* @param pspec a {@link GObject.ParamSpec}
|
|
7947
|
+
* @since 1.6
|
|
7696
7948
|
* @virtual
|
|
7697
7949
|
*/
|
|
7698
7950
|
vfunc_child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
@@ -7708,6 +7960,7 @@ export namespace Meta {
|
|
|
7708
7960
|
*
|
|
7709
7961
|
* Applications should not call this function.
|
|
7710
7962
|
* @param actor a {@link Clutter.Actor}
|
|
7963
|
+
* @since 1.2
|
|
7711
7964
|
* @virtual
|
|
7712
7965
|
*/
|
|
7713
7966
|
vfunc_create_child_meta(actor: Clutter.Actor): void;
|
|
@@ -7722,6 +7975,7 @@ export namespace Meta {
|
|
|
7722
7975
|
*
|
|
7723
7976
|
* Applications should not call this function.
|
|
7724
7977
|
* @param actor a {@link Clutter.Actor}
|
|
7978
|
+
* @since 1.2
|
|
7725
7979
|
* @virtual
|
|
7726
7980
|
*/
|
|
7727
7981
|
vfunc_destroy_child_meta(actor: Clutter.Actor): void;
|
|
@@ -7735,6 +7989,8 @@ export namespace Meta {
|
|
|
7735
7989
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
7736
7990
|
* virtual function, which has been deprecated.
|
|
7737
7991
|
* @param callback a function to be called for each child
|
|
7992
|
+
* @since 0.4
|
|
7993
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
7738
7994
|
* @virtual
|
|
7739
7995
|
*/
|
|
7740
7996
|
vfunc_foreach(callback: Clutter.Callback): void;
|
|
@@ -7747,6 +8003,8 @@ export namespace Meta {
|
|
|
7747
8003
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
7748
8004
|
* virtual function, which has been deprecated.
|
|
7749
8005
|
* @param callback a function to be called for each child
|
|
8006
|
+
* @since 1.0
|
|
8007
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
7750
8008
|
* @virtual
|
|
7751
8009
|
*/
|
|
7752
8010
|
vfunc_foreach_with_internals(callback: Clutter.Callback): void;
|
|
@@ -7755,6 +8013,7 @@ export namespace Meta {
|
|
|
7755
8013
|
* Retrieves the {@link Clutter.ChildMeta} which contains the data about the
|
|
7756
8014
|
* `container` specific state for `actor`.
|
|
7757
8015
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
8016
|
+
* @since 0.8
|
|
7758
8017
|
* @virtual
|
|
7759
8018
|
*/
|
|
7760
8019
|
vfunc_get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
@@ -7767,6 +8026,8 @@ export namespace Meta {
|
|
|
7767
8026
|
* `clutter_actor_set_child_below_sibling()`.
|
|
7768
8027
|
* @param actor the actor to raise
|
|
7769
8028
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
8029
|
+
* @since 0.6
|
|
8030
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
7770
8031
|
* @virtual
|
|
7771
8032
|
*/
|
|
7772
8033
|
vfunc_lower(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -7779,6 +8040,8 @@ export namespace Meta {
|
|
|
7779
8040
|
* `clutter_actor_set_child_above_sibling()`.
|
|
7780
8041
|
* @param actor the actor to raise
|
|
7781
8042
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
8043
|
+
* @since 0.6
|
|
8044
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
7782
8045
|
* @virtual
|
|
7783
8046
|
*/
|
|
7784
8047
|
vfunc_raise(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -7793,6 +8056,8 @@ export namespace Meta {
|
|
|
7793
8056
|
* deprecated virtual function. The default implementation will call
|
|
7794
8057
|
* `clutter_actor_remove_child()`.
|
|
7795
8058
|
* @param actor a {@link Clutter.Actor}
|
|
8059
|
+
* @since 0.4
|
|
8060
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
7796
8061
|
* @virtual
|
|
7797
8062
|
*/
|
|
7798
8063
|
vfunc_remove(actor: Clutter.Actor): void;
|
|
@@ -7800,6 +8065,8 @@ export namespace Meta {
|
|
|
7800
8065
|
/**
|
|
7801
8066
|
* Sorts a container's children using their depth. This function should not
|
|
7802
8067
|
* be normally used by applications.
|
|
8068
|
+
* @since 0.6
|
|
8069
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
7803
8070
|
* @virtual
|
|
7804
8071
|
*/
|
|
7805
8072
|
vfunc_sort_depth_order(): void;
|
|
@@ -7807,6 +8074,7 @@ export namespace Meta {
|
|
|
7807
8074
|
/**
|
|
7808
8075
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
7809
8076
|
* @returns the id of the object. The returned string is owned by the scriptable object and should never be modified of freed
|
|
8077
|
+
* @since 0.6
|
|
7810
8078
|
*/
|
|
7811
8079
|
get_id(): string;
|
|
7812
8080
|
|
|
@@ -7818,6 +8086,7 @@ export namespace Meta {
|
|
|
7818
8086
|
* @param name the name of the node
|
|
7819
8087
|
* @param node the JSON node to be parsed
|
|
7820
8088
|
* @returns `true` if the node was successfully parsed, `false` otherwise.
|
|
8089
|
+
* @since 0.6
|
|
7821
8090
|
*/
|
|
7822
8091
|
parse_custom_node(script: Clutter.Script, value: GObject.Value | any, name: string, node: Json.Node): boolean;
|
|
7823
8092
|
|
|
@@ -7827,6 +8096,7 @@ export namespace Meta {
|
|
|
7827
8096
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
7828
8097
|
* @param name the name of the property
|
|
7829
8098
|
* @param value the value of the property
|
|
8099
|
+
* @since 0.6
|
|
7830
8100
|
*/
|
|
7831
8101
|
set_custom_property(script: Clutter.Script, name: string, value: GObject.Value | any): void;
|
|
7832
8102
|
|
|
@@ -7838,11 +8108,13 @@ export namespace Meta {
|
|
|
7838
8108
|
* define a unique name for an object constructable using the UI
|
|
7839
8109
|
* definition language parsed by {@link Clutter.Script}.
|
|
7840
8110
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
8111
|
+
* @since 0.6
|
|
7841
8112
|
*/
|
|
7842
8113
|
set_id(id_: string): void;
|
|
7843
8114
|
|
|
7844
8115
|
/**
|
|
7845
8116
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
8117
|
+
* @since 0.6
|
|
7846
8118
|
* @virtual
|
|
7847
8119
|
*/
|
|
7848
8120
|
vfunc_get_id(): string;
|
|
@@ -7854,6 +8126,7 @@ export namespace Meta {
|
|
|
7854
8126
|
* @param value the generic value to be set
|
|
7855
8127
|
* @param name the name of the node
|
|
7856
8128
|
* @param node the JSON node to be parsed
|
|
8129
|
+
* @since 0.6
|
|
7857
8130
|
* @virtual
|
|
7858
8131
|
*/
|
|
7859
8132
|
vfunc_parse_custom_node(script: Clutter.Script, value: unknown, name: string, node: Json.Node): boolean;
|
|
@@ -7864,6 +8137,7 @@ export namespace Meta {
|
|
|
7864
8137
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
7865
8138
|
* @param name the name of the property
|
|
7866
8139
|
* @param value the value of the property
|
|
8140
|
+
* @since 0.6
|
|
7867
8141
|
* @virtual
|
|
7868
8142
|
*/
|
|
7869
8143
|
vfunc_set_custom_property(script: Clutter.Script, name: string, value: unknown): void;
|
|
@@ -7876,6 +8150,7 @@ export namespace Meta {
|
|
|
7876
8150
|
* define a unique name for an object constructable using the UI
|
|
7877
8151
|
* definition language parsed by {@link Clutter.Script}.
|
|
7878
8152
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
8153
|
+
* @since 0.6
|
|
7879
8154
|
* @virtual
|
|
7880
8155
|
*/
|
|
7881
8156
|
vfunc_set_id(id_: string): void;
|
|
@@ -8021,6 +8296,8 @@ export namespace Meta {
|
|
|
8021
8296
|
* @param progress the progress factor
|
|
8022
8297
|
* @param value return location for the animation value
|
|
8023
8298
|
* @returns `true` if the value has been validated and can be applied to the {@link Clutter.Animatable}, and `false` otherwise
|
|
8299
|
+
* @since 1.0
|
|
8300
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
8024
8301
|
*/
|
|
8025
8302
|
animate_property(animation: Clutter.Animation, property_name: string, initial_value: GObject.Value | any, final_value: GObject.Value | any, progress: number, value: GObject.Value | any): boolean;
|
|
8026
8303
|
|
|
@@ -8028,6 +8305,7 @@ export namespace Meta {
|
|
|
8028
8305
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
8029
8306
|
* @param property_name the name of the animatable property to find
|
|
8030
8307
|
* @returns The {@link GObject.ParamSpec} for the given property or `null`
|
|
8308
|
+
* @since 1.4
|
|
8031
8309
|
*/
|
|
8032
8310
|
find_property(property_name: string): GObject.ParamSpec;
|
|
8033
8311
|
|
|
@@ -8035,6 +8313,7 @@ export namespace Meta {
|
|
|
8035
8313
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
8036
8314
|
* @param property_name the name of the animatable property to retrieve
|
|
8037
8315
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
8316
|
+
* @since 1.4
|
|
8038
8317
|
*/
|
|
8039
8318
|
get_initial_state(property_name: string, value: GObject.Value | any): void;
|
|
8040
8319
|
|
|
@@ -8052,6 +8331,7 @@ export namespace Meta {
|
|
|
8052
8331
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
8053
8332
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
8054
8333
|
* @returns `true` if the interpolation was successful, and `false` otherwise
|
|
8334
|
+
* @since 1.8
|
|
8055
8335
|
*/
|
|
8056
8336
|
interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, unknown];
|
|
8057
8337
|
|
|
@@ -8059,6 +8339,7 @@ export namespace Meta {
|
|
|
8059
8339
|
* Sets the current state of `property_name` to `value`
|
|
8060
8340
|
* @param property_name the name of the animatable property to set
|
|
8061
8341
|
* @param value the value of the animatable property to set
|
|
8342
|
+
* @since 1.4
|
|
8062
8343
|
*/
|
|
8063
8344
|
set_final_state(property_name: string, value: GObject.Value | any): void;
|
|
8064
8345
|
|
|
@@ -8077,6 +8358,8 @@ export namespace Meta {
|
|
|
8077
8358
|
* @param final_value the final value of the animation interval
|
|
8078
8359
|
* @param progress the progress factor
|
|
8079
8360
|
* @param value return location for the animation value
|
|
8361
|
+
* @since 1.0
|
|
8362
|
+
* @deprecated since 1.8: Use `clutter_animatable_interpolate_value()` instead
|
|
8080
8363
|
* @virtual
|
|
8081
8364
|
*/
|
|
8082
8365
|
vfunc_animate_property(animation: Clutter.Animation, property_name: string, initial_value: unknown, final_value: unknown, progress: number, value: unknown): boolean;
|
|
@@ -8084,6 +8367,7 @@ export namespace Meta {
|
|
|
8084
8367
|
/**
|
|
8085
8368
|
* Finds the {@link GObject.ParamSpec} for `property_name`
|
|
8086
8369
|
* @param property_name the name of the animatable property to find
|
|
8370
|
+
* @since 1.4
|
|
8087
8371
|
* @virtual
|
|
8088
8372
|
*/
|
|
8089
8373
|
vfunc_find_property(property_name: string): GObject.ParamSpec;
|
|
@@ -8092,6 +8376,7 @@ export namespace Meta {
|
|
|
8092
8376
|
* Retrieves the current state of `property_name` and sets `value` with it
|
|
8093
8377
|
* @param property_name the name of the animatable property to retrieve
|
|
8094
8378
|
* @param value a {@link GObject.Value} initialized to the type of the property to retrieve
|
|
8379
|
+
* @since 1.4
|
|
8095
8380
|
* @virtual
|
|
8096
8381
|
*/
|
|
8097
8382
|
vfunc_get_initial_state(property_name: string, value: unknown): void;
|
|
@@ -8109,6 +8394,7 @@ export namespace Meta {
|
|
|
8109
8394
|
* @param property_name the name of the property to interpolate
|
|
8110
8395
|
* @param interval a {@link Clutter.Interval} with the animation range
|
|
8111
8396
|
* @param progress the progress to use to interpolate between the initial and final values of the `interval`
|
|
8397
|
+
* @since 1.8
|
|
8112
8398
|
* @virtual
|
|
8113
8399
|
*/
|
|
8114
8400
|
vfunc_interpolate_value(property_name: string, interval: Clutter.Interval, progress: number): [boolean, GObject.Value | any];
|
|
@@ -8117,6 +8403,7 @@ export namespace Meta {
|
|
|
8117
8403
|
* Sets the current state of `property_name` to `value`
|
|
8118
8404
|
* @param property_name the name of the animatable property to set
|
|
8119
8405
|
* @param value the value of the animatable property to set
|
|
8406
|
+
* @since 1.4
|
|
8120
8407
|
* @virtual
|
|
8121
8408
|
*/
|
|
8122
8409
|
vfunc_set_final_state(property_name: string, value: unknown): void;
|
|
@@ -8131,6 +8418,8 @@ export namespace Meta {
|
|
|
8131
8418
|
* deprecated virtual function. The default implementation will
|
|
8132
8419
|
* call `clutter_actor_add_child()`.
|
|
8133
8420
|
* @param actor the first {@link Clutter.Actor} to add
|
|
8421
|
+
* @since 0.4
|
|
8422
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
8134
8423
|
*/
|
|
8135
8424
|
add_actor(actor: Clutter.Actor): void;
|
|
8136
8425
|
|
|
@@ -8145,6 +8434,7 @@ export namespace Meta {
|
|
|
8145
8434
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
8146
8435
|
* @param property the name of the property to set.
|
|
8147
8436
|
* @param value the value.
|
|
8437
|
+
* @since 0.8
|
|
8148
8438
|
*/
|
|
8149
8439
|
child_get_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
8150
8440
|
|
|
@@ -8154,6 +8444,7 @@ export namespace Meta {
|
|
|
8154
8444
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
8155
8445
|
* @param child a {@link Clutter.Actor}
|
|
8156
8446
|
* @param pspec a {@link GObject.ParamSpec}
|
|
8447
|
+
* @since 1.6
|
|
8157
8448
|
*/
|
|
8158
8449
|
child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
8159
8450
|
|
|
@@ -8162,6 +8453,7 @@ export namespace Meta {
|
|
|
8162
8453
|
* @param child a {@link Clutter.Actor} that is a child of `container`.
|
|
8163
8454
|
* @param property the name of the property to set.
|
|
8164
8455
|
* @param value the value.
|
|
8456
|
+
* @since 0.8
|
|
8165
8457
|
*/
|
|
8166
8458
|
child_set_property(child: Clutter.Actor, property: string, value: GObject.Value | any): void;
|
|
8167
8459
|
|
|
@@ -8176,6 +8468,7 @@ export namespace Meta {
|
|
|
8176
8468
|
*
|
|
8177
8469
|
* Applications should not call this function.
|
|
8178
8470
|
* @param actor a {@link Clutter.Actor}
|
|
8471
|
+
* @since 1.2
|
|
8179
8472
|
*/
|
|
8180
8473
|
create_child_meta(actor: Clutter.Actor): void;
|
|
8181
8474
|
|
|
@@ -8189,6 +8482,7 @@ export namespace Meta {
|
|
|
8189
8482
|
*
|
|
8190
8483
|
* Applications should not call this function.
|
|
8191
8484
|
* @param actor a {@link Clutter.Actor}
|
|
8485
|
+
* @since 1.2
|
|
8192
8486
|
*/
|
|
8193
8487
|
destroy_child_meta(actor: Clutter.Actor): void;
|
|
8194
8488
|
|
|
@@ -8197,6 +8491,7 @@ export namespace Meta {
|
|
|
8197
8491
|
* into any child container.
|
|
8198
8492
|
* @param child_name the name of the requested child.
|
|
8199
8493
|
* @returns The child actor with the requested name, or `null` if no actor with that name was found.
|
|
8494
|
+
* @since 0.6
|
|
8200
8495
|
*/
|
|
8201
8496
|
find_child_by_name(child_name: string): Clutter.Actor;
|
|
8202
8497
|
|
|
@@ -8209,6 +8504,8 @@ export namespace Meta {
|
|
|
8209
8504
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
8210
8505
|
* virtual function, which has been deprecated.
|
|
8211
8506
|
* @param callback a function to be called for each child
|
|
8507
|
+
* @since 0.4
|
|
8508
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
8212
8509
|
*/
|
|
8213
8510
|
foreach(callback: Clutter.Callback): void;
|
|
8214
8511
|
|
|
@@ -8220,6 +8517,8 @@ export namespace Meta {
|
|
|
8220
8517
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
8221
8518
|
* virtual function, which has been deprecated.
|
|
8222
8519
|
* @param callback a function to be called for each child
|
|
8520
|
+
* @since 1.0
|
|
8521
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
8223
8522
|
*/
|
|
8224
8523
|
foreach_with_internals(callback: Clutter.Callback): void;
|
|
8225
8524
|
|
|
@@ -8228,12 +8527,15 @@ export namespace Meta {
|
|
|
8228
8527
|
* `container` specific state for `actor`.
|
|
8229
8528
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
8230
8529
|
* @returns the {@link Clutter.ChildMeta} for the `actor` child of `container` or `null` if the specifiec actor does not exist or the container is not configured to provide {@link Clutter.ChildMeta}<!-- -->s
|
|
8530
|
+
* @since 0.8
|
|
8231
8531
|
*/
|
|
8232
8532
|
get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
8233
8533
|
|
|
8234
8534
|
/**
|
|
8235
8535
|
* Retrieves all the children of `container`.
|
|
8236
8536
|
* @returns a list of {@link Clutter.Actor}<!-- -->s. Use `g_list_free()` on the returned list when done.
|
|
8537
|
+
* @since 0.4
|
|
8538
|
+
* @deprecated since 1.10: Use `clutter_actor_get_children()` instead.
|
|
8237
8539
|
*/
|
|
8238
8540
|
get_children(): Clutter.Actor[];
|
|
8239
8541
|
|
|
@@ -8245,6 +8547,8 @@ export namespace Meta {
|
|
|
8245
8547
|
* `clutter_actor_set_child_below_sibling()`.
|
|
8246
8548
|
* @param actor the actor to raise
|
|
8247
8549
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
8550
|
+
* @since 0.6
|
|
8551
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
8248
8552
|
*/
|
|
8249
8553
|
lower_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
8250
8554
|
|
|
@@ -8256,6 +8560,8 @@ export namespace Meta {
|
|
|
8256
8560
|
* `clutter_actor_set_child_above_sibling()`.
|
|
8257
8561
|
* @param actor the actor to raise
|
|
8258
8562
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
8563
|
+
* @since 0.6
|
|
8564
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
8259
8565
|
*/
|
|
8260
8566
|
raise_child(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
8261
8567
|
|
|
@@ -8269,12 +8575,16 @@ export namespace Meta {
|
|
|
8269
8575
|
* deprecated virtual function. The default implementation will call
|
|
8270
8576
|
* `clutter_actor_remove_child()`.
|
|
8271
8577
|
* @param actor a {@link Clutter.Actor}
|
|
8578
|
+
* @since 0.4
|
|
8579
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
8272
8580
|
*/
|
|
8273
8581
|
remove_actor(actor: Clutter.Actor): void;
|
|
8274
8582
|
|
|
8275
8583
|
/**
|
|
8276
8584
|
* Sorts a container's children using their depth. This function should not
|
|
8277
8585
|
* be normally used by applications.
|
|
8586
|
+
* @since 0.6
|
|
8587
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
8278
8588
|
*/
|
|
8279
8589
|
sort_depth_order(): void;
|
|
8280
8590
|
|
|
@@ -8300,6 +8610,8 @@ export namespace Meta {
|
|
|
8300
8610
|
* deprecated virtual function. The default implementation will
|
|
8301
8611
|
* call `clutter_actor_add_child()`.
|
|
8302
8612
|
* @param actor the first {@link Clutter.Actor} to add
|
|
8613
|
+
* @since 0.4
|
|
8614
|
+
* @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
|
|
8303
8615
|
* @virtual
|
|
8304
8616
|
*/
|
|
8305
8617
|
vfunc_add(actor: Clutter.Actor): void;
|
|
@@ -8310,6 +8622,7 @@ export namespace Meta {
|
|
|
8310
8622
|
* {@link Clutter.Container.SignalSignatures.child_notify | Clutter.Container::child-notify} signal.
|
|
8311
8623
|
* @param child a {@link Clutter.Actor}
|
|
8312
8624
|
* @param pspec a {@link GObject.ParamSpec}
|
|
8625
|
+
* @since 1.6
|
|
8313
8626
|
* @virtual
|
|
8314
8627
|
*/
|
|
8315
8628
|
vfunc_child_notify(child: Clutter.Actor, pspec: GObject.ParamSpec): void;
|
|
@@ -8325,6 +8638,7 @@ export namespace Meta {
|
|
|
8325
8638
|
*
|
|
8326
8639
|
* Applications should not call this function.
|
|
8327
8640
|
* @param actor a {@link Clutter.Actor}
|
|
8641
|
+
* @since 1.2
|
|
8328
8642
|
* @virtual
|
|
8329
8643
|
*/
|
|
8330
8644
|
vfunc_create_child_meta(actor: Clutter.Actor): void;
|
|
@@ -8339,6 +8653,7 @@ export namespace Meta {
|
|
|
8339
8653
|
*
|
|
8340
8654
|
* Applications should not call this function.
|
|
8341
8655
|
* @param actor a {@link Clutter.Actor}
|
|
8656
|
+
* @since 1.2
|
|
8342
8657
|
* @virtual
|
|
8343
8658
|
*/
|
|
8344
8659
|
vfunc_destroy_child_meta(actor: Clutter.Actor): void;
|
|
@@ -8352,6 +8667,8 @@ export namespace Meta {
|
|
|
8352
8667
|
* This function calls the {@link Clutter.ContainerIface}.foreach()
|
|
8353
8668
|
* virtual function, which has been deprecated.
|
|
8354
8669
|
* @param callback a function to be called for each child
|
|
8670
|
+
* @since 0.4
|
|
8671
|
+
* @deprecated since 1.10: Use `clutter_actor_get_first_child()` or `clutter_actor_get_last_child()` to retrieve the beginning of the list of children, and `clutter_actor_get_next_sibling()` and `clutter_actor_get_previous_sibling()` to iterate over it; alternatively, use the {@link Clutter.ActorIter} API.
|
|
8355
8672
|
* @virtual
|
|
8356
8673
|
*/
|
|
8357
8674
|
vfunc_foreach(callback: Clutter.Callback): void;
|
|
@@ -8364,6 +8681,8 @@ export namespace Meta {
|
|
|
8364
8681
|
* This function calls the {@link Clutter.ContainerIface}.foreach_with_internals()
|
|
8365
8682
|
* virtual function, which has been deprecated.
|
|
8366
8683
|
* @param callback a function to be called for each child
|
|
8684
|
+
* @since 1.0
|
|
8685
|
+
* @deprecated since 1.10: See `clutter_container_foreach()`.
|
|
8367
8686
|
* @virtual
|
|
8368
8687
|
*/
|
|
8369
8688
|
vfunc_foreach_with_internals(callback: Clutter.Callback): void;
|
|
@@ -8372,6 +8691,7 @@ export namespace Meta {
|
|
|
8372
8691
|
* Retrieves the {@link Clutter.ChildMeta} which contains the data about the
|
|
8373
8692
|
* `container` specific state for `actor`.
|
|
8374
8693
|
* @param actor a {@link Clutter.Actor} that is a child of `container`.
|
|
8694
|
+
* @since 0.8
|
|
8375
8695
|
* @virtual
|
|
8376
8696
|
*/
|
|
8377
8697
|
vfunc_get_child_meta(actor: Clutter.Actor): Clutter.ChildMeta;
|
|
@@ -8384,6 +8704,8 @@ export namespace Meta {
|
|
|
8384
8704
|
* `clutter_actor_set_child_below_sibling()`.
|
|
8385
8705
|
* @param actor the actor to raise
|
|
8386
8706
|
* @param sibling the sibling to lower to, or `null` to lower to the bottom
|
|
8707
|
+
* @since 0.6
|
|
8708
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_below_sibling()` instead.
|
|
8387
8709
|
* @virtual
|
|
8388
8710
|
*/
|
|
8389
8711
|
vfunc_lower(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -8396,6 +8718,8 @@ export namespace Meta {
|
|
|
8396
8718
|
* `clutter_actor_set_child_above_sibling()`.
|
|
8397
8719
|
* @param actor the actor to raise
|
|
8398
8720
|
* @param sibling the sibling to raise to, or `null` to raise to the top
|
|
8721
|
+
* @since 0.6
|
|
8722
|
+
* @deprecated since 1.10: Use `clutter_actor_set_child_above_sibling()` instead.
|
|
8399
8723
|
* @virtual
|
|
8400
8724
|
*/
|
|
8401
8725
|
vfunc_raise(actor: Clutter.Actor, sibling: Clutter.Actor | null): void;
|
|
@@ -8410,6 +8734,8 @@ export namespace Meta {
|
|
|
8410
8734
|
* deprecated virtual function. The default implementation will call
|
|
8411
8735
|
* `clutter_actor_remove_child()`.
|
|
8412
8736
|
* @param actor a {@link Clutter.Actor}
|
|
8737
|
+
* @since 0.4
|
|
8738
|
+
* @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
|
|
8413
8739
|
* @virtual
|
|
8414
8740
|
*/
|
|
8415
8741
|
vfunc_remove(actor: Clutter.Actor): void;
|
|
@@ -8417,6 +8743,8 @@ export namespace Meta {
|
|
|
8417
8743
|
/**
|
|
8418
8744
|
* Sorts a container's children using their depth. This function should not
|
|
8419
8745
|
* be normally used by applications.
|
|
8746
|
+
* @since 0.6
|
|
8747
|
+
* @deprecated since 1.10: The {@link Clutter.ContainerIface}.sort_depth_order() virtual function should not be used any more; the default implementation in {@link Clutter.Container} does not do anything.
|
|
8420
8748
|
* @virtual
|
|
8421
8749
|
*/
|
|
8422
8750
|
vfunc_sort_depth_order(): void;
|
|
@@ -8424,6 +8752,7 @@ export namespace Meta {
|
|
|
8424
8752
|
/**
|
|
8425
8753
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
8426
8754
|
* @returns the id of the object. The returned string is owned by the scriptable object and should never be modified of freed
|
|
8755
|
+
* @since 0.6
|
|
8427
8756
|
*/
|
|
8428
8757
|
get_id(): string;
|
|
8429
8758
|
|
|
@@ -8435,6 +8764,7 @@ export namespace Meta {
|
|
|
8435
8764
|
* @param name the name of the node
|
|
8436
8765
|
* @param node the JSON node to be parsed
|
|
8437
8766
|
* @returns `true` if the node was successfully parsed, `false` otherwise.
|
|
8767
|
+
* @since 0.6
|
|
8438
8768
|
*/
|
|
8439
8769
|
parse_custom_node(script: Clutter.Script, value: GObject.Value | any, name: string, node: Json.Node): boolean;
|
|
8440
8770
|
|
|
@@ -8444,6 +8774,7 @@ export namespace Meta {
|
|
|
8444
8774
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
8445
8775
|
* @param name the name of the property
|
|
8446
8776
|
* @param value the value of the property
|
|
8777
|
+
* @since 0.6
|
|
8447
8778
|
*/
|
|
8448
8779
|
set_custom_property(script: Clutter.Script, name: string, value: GObject.Value | any): void;
|
|
8449
8780
|
|
|
@@ -8455,11 +8786,13 @@ export namespace Meta {
|
|
|
8455
8786
|
* define a unique name for an object constructable using the UI
|
|
8456
8787
|
* definition language parsed by {@link Clutter.Script}.
|
|
8457
8788
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
8789
|
+
* @since 0.6
|
|
8458
8790
|
*/
|
|
8459
8791
|
set_id(id_: string): void;
|
|
8460
8792
|
|
|
8461
8793
|
/**
|
|
8462
8794
|
* Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.
|
|
8795
|
+
* @since 0.6
|
|
8463
8796
|
* @virtual
|
|
8464
8797
|
*/
|
|
8465
8798
|
vfunc_get_id(): string;
|
|
@@ -8471,6 +8804,7 @@ export namespace Meta {
|
|
|
8471
8804
|
* @param value the generic value to be set
|
|
8472
8805
|
* @param name the name of the node
|
|
8473
8806
|
* @param node the JSON node to be parsed
|
|
8807
|
+
* @since 0.6
|
|
8474
8808
|
* @virtual
|
|
8475
8809
|
*/
|
|
8476
8810
|
vfunc_parse_custom_node(script: Clutter.Script, value: unknown, name: string, node: Json.Node): boolean;
|
|
@@ -8481,6 +8815,7 @@ export namespace Meta {
|
|
|
8481
8815
|
* @param script the {@link Clutter.Script} creating the scriptable instance
|
|
8482
8816
|
* @param name the name of the property
|
|
8483
8817
|
* @param value the value of the property
|
|
8818
|
+
* @since 0.6
|
|
8484
8819
|
* @virtual
|
|
8485
8820
|
*/
|
|
8486
8821
|
vfunc_set_custom_property(script: Clutter.Script, name: string, value: unknown): void;
|
|
@@ -8493,6 +8828,7 @@ export namespace Meta {
|
|
|
8493
8828
|
* define a unique name for an object constructable using the UI
|
|
8494
8829
|
* definition language parsed by {@link Clutter.Script}.
|
|
8495
8830
|
* @param id_ the {@link Clutter.Script} id of the object
|
|
8831
|
+
* @since 0.6
|
|
8496
8832
|
* @virtual
|
|
8497
8833
|
*/
|
|
8498
8834
|
vfunc_set_id(id_: string): void;
|