Struct gdnative_bindings_lily::theme::Theme [−][src]
pub struct Theme { /* fields omitted */ }
Expand description
core class Theme
inherits Resource
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
Theme inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Clears the Color at name
if the theme has type
.
Clears the constant at name
if the theme has type
.
Clears the Font at name
if the theme has type
.
Clears the icon at name
if the theme has type
.
Clears StyleBox at name
if the theme has type
.
Sets the theme’s values to a copy of the default theme values.
Sets the theme’s values to a copy of a given theme.
pub fn get_color(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> Color
pub fn get_color(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> Color
Returns the Color at name
if the theme has type
.
pub fn get_constant(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> i64
pub fn get_constant(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> i64
Returns the constant at name
if the theme has type
.
Returns all the constants as a [PoolStringArray] filled with each constant’s name, for use in [method get_constant], if the theme has type
.
pub fn get_font(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> Option<Ref<Font, Shared>>
pub fn get_font(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> Option<Ref<Font, Shared>>
Returns the Font at name
if the theme has type
.
pub fn get_icon(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> Option<Ref<Texture, Shared>>
pub fn get_icon(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> Option<Ref<Texture, Shared>>
Returns the icon Texture at name
if the theme has type
.
Returns all the icons as a [PoolStringArray] filled with each Texture’s name, for use in [method get_icon], if the theme has type
.
pub fn get_stylebox(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> Option<Ref<StyleBox, Shared>>
pub fn get_stylebox(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> Option<Ref<StyleBox, Shared>>
Returns the icon StyleBox at name
if the theme has type
.
Returns all the types in type
as a [PoolStringArray] for use in any of the get_*
functions, if the theme has type
.
pub fn has_color(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
pub fn has_color(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
Returns true
if Color with name
is in type
.
Returns false
if the theme does not have type
.
pub fn has_constant(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
pub fn has_constant(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
Returns true
if constant with name
is in type
.
Returns false
if the theme does not have type
.
pub fn has_font(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
pub fn has_font(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
Returns true
if Font with name
is in type
.
Returns false
if the theme does not have type
.
pub fn has_icon(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
pub fn has_icon(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
Returns true
if icon Texture with name
is in type
.
Returns false
if the theme does not have type
.
pub fn has_stylebox(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
pub fn has_stylebox(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>
) -> bool
Returns true
if StyleBox with name
is in type
.
Returns false
if the theme does not have type
.
pub fn set_color(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
color: Color
)
pub fn set_color(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
color: Color
)
Sets the theme’s Color to color
at name
in type
.
Does nothing if the theme does not have type
.
pub fn set_constant(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
constant: i64
)
pub fn set_constant(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
constant: i64
)
Sets the theme’s constant to constant
at name
in type
.
Does nothing if the theme does not have type
.
The theme’s default font.
pub fn set_font(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
font: impl AsArg<Font>
)
pub fn set_font(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
font: impl AsArg<Font>
)
Sets the theme’s Font to font
at name
in type
.
Does nothing if the theme does not have type
.
pub fn set_icon(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
texture: impl AsArg<Texture>
)
pub fn set_icon(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
texture: impl AsArg<Texture>
)
Sets the theme’s icon Texture to texture
at name
in type
.
Does nothing if the theme does not have type
.
pub fn set_stylebox(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
texture: impl AsArg<StyleBox>
)
pub fn set_stylebox(
&self,
name: impl Into<GodotString>,
node_type: impl Into<GodotString>,
texture: impl AsArg<StyleBox>
)
Sets theme’s StyleBox to stylebox
at name
in type
.
Does nothing if the theme does not have type
.
Methods from Deref<Target = Resource>
Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing true
to the subresources
argument which will copy the subresources.
Note: If subresources
is true
, this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.
Default Arguments
subresources
-false
If [member resource_local_to_scene] is enabled and the resource was loaded from a PackedScene instantiation, returns the local scene where this resource’s unique copy is in use. Otherwise, returns null
.
The name of the resource. This is an optional identifier.
The path to the resource. In case it has its own file, it will return its filepath. If it’s tied to the scene, it will return the scene’s path, followed by the resource’s index.
If true
, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.
If true
, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.
The name of the resource. This is an optional identifier.
The path to the resource. In case it has its own file, it will return its filepath. If it’s tied to the scene, it will return the scene’s path, followed by the resource’s index.
This method is called when a resource with [member resource_local_to_scene] enabled is loaded from a PackedScene instantiation. Its behavior can be customized by overriding [method _setup_local_to_scene] from script. For most resources, this method performs no base logic. ViewportTexture performs custom logic to properly set the proxy texture and flags in the local viewport.
Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path.
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Theme
impl UnwindSafe for Theme