Struct Theme

#[repr(C)]
pub struct Theme { /* private fields */ }

Godot class Theme.

Inherits Resource.

Related symbols:

• theme: sidecar module with related enum/flag types
• ITheme: virtual methods

See also Godot docs for Theme.

Construction

This class is reference-counted. You can create a new instance using Theme::new_gd().

Implementations

impl Theme

pub fn set_icon( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, texture: impl AsObjectArg<Texture2D>, )

pub fn get_icon( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> Option<Gd<Texture2D>>

pub fn has_icon( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> bool

pub fn rename_icon( &mut self, old_name: impl AsArg<StringName>, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn clear_icon( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn get_icon_list( &self, theme_type: impl AsArg<GString>, ) -> PackedStringArray

pub fn get_icon_type_list(&self) -> PackedStringArray

pub fn set_stylebox( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, texture: impl AsObjectArg<StyleBox>, )

pub fn get_stylebox( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> Option<Gd<StyleBox>>

pub fn has_stylebox( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> bool

pub fn rename_stylebox( &mut self, old_name: impl AsArg<StringName>, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn clear_stylebox( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn get_stylebox_list( &self, theme_type: impl AsArg<GString>, ) -> PackedStringArray

pub fn get_stylebox_type_list(&self) -> PackedStringArray

pub fn set_font( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, font: impl AsObjectArg<Font>, )

pub fn get_font( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> Option<Gd<Font>>

pub fn has_font( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> bool

pub fn rename_font( &mut self, old_name: impl AsArg<StringName>, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn clear_font( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn get_font_list( &self, theme_type: impl AsArg<GString>, ) -> PackedStringArray

pub fn get_font_type_list(&self) -> PackedStringArray

pub fn set_font_size( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, font_size: i32, )

pub fn get_font_size( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> i32

pub fn has_font_size( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> bool

pub fn rename_font_size( &mut self, old_name: impl AsArg<StringName>, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn clear_font_size( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn get_font_size_list( &self, theme_type: impl AsArg<GString>, ) -> PackedStringArray

pub fn get_font_size_type_list(&self) -> PackedStringArray

pub fn set_color( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, color: Color, )

pub fn get_color( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> Color

pub fn has_color( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> bool

pub fn rename_color( &mut self, old_name: impl AsArg<StringName>, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn clear_color( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn get_color_list( &self, theme_type: impl AsArg<GString>, ) -> PackedStringArray

pub fn get_color_type_list(&self) -> PackedStringArray

pub fn set_constant( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, constant: i32, )

pub fn get_constant( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> i32

pub fn has_constant( &self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> bool

pub fn rename_constant( &mut self, old_name: impl AsArg<StringName>, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn clear_constant( &mut self, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn get_constant_list( &self, theme_type: impl AsArg<GString>, ) -> PackedStringArray

pub fn get_constant_type_list(&self) -> PackedStringArray

pub fn set_default_base_scale(&mut self, base_scale: f32)

pub fn get_default_base_scale(&self) -> f32

pub fn has_default_base_scale(&self) -> bool

pub fn set_default_font(&mut self, font: impl AsObjectArg<Font>)

pub fn get_default_font(&self) -> Option<Gd<Font>>

pub fn has_default_font(&self) -> bool

pub fn set_default_font_size(&mut self, font_size: i32)

pub fn get_default_font_size(&self) -> i32

pub fn has_default_font_size(&self) -> bool

pub fn set_theme_item( &mut self, data_type: DataType, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, value: &Variant, )

pub fn get_theme_item( &self, data_type: DataType, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> Variant

pub fn has_theme_item( &self, data_type: DataType, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, ) -> bool

pub fn rename_theme_item( &mut self, data_type: DataType, old_name: impl AsArg<StringName>, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn clear_theme_item( &mut self, data_type: DataType, name: impl AsArg<StringName>, theme_type: impl AsArg<StringName>, )

pub fn get_theme_item_list( &self, data_type: DataType, theme_type: impl AsArg<GString>, ) -> PackedStringArray

pub fn get_theme_item_type_list(&self, data_type: DataType) -> PackedStringArray

pub fn set_type_variation( &mut self, theme_type: impl AsArg<StringName>, base_type: impl AsArg<StringName>, )

pub fn is_type_variation( &self, theme_type: impl AsArg<StringName>, base_type: impl AsArg<StringName>, ) -> bool

pub fn clear_type_variation(&mut self, theme_type: impl AsArg<StringName>)

pub fn get_type_variation_base( &self, theme_type: impl AsArg<StringName>, ) -> StringName

pub fn get_type_variation_list( &self, base_type: impl AsArg<StringName>, ) -> PackedStringArray

pub fn add_type(&mut self, theme_type: impl AsArg<StringName>)

pub fn remove_type(&mut self, theme_type: impl AsArg<StringName>)

pub fn get_type_list(&self) -> PackedStringArray

pub fn merge_with(&mut self, other: impl AsObjectArg<Theme>)

pub fn clear(&mut self)

Methods from Deref<Target = Resource>

pub fn set_path(&mut self, path: impl AsArg<GString>)

pub fn take_over_path(&mut self, path: impl AsArg<GString>)

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: impl AsArg<GString>)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn is_local_to_scene(&self) -> bool

pub fn get_local_scene(&self) -> Option<Gd<Node>>

pub fn setup_local_to_scene(&mut self)

pub fn set_scene_unique_id(&mut self, id: impl AsArg<GString>)

pub fn get_scene_unique_id(&self) -> GString

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_ex and its builder methods. See the book for detailed usage instructions.

pub fn duplicate_ex<'a>(&'a self) -> ExDuplicate<'a>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for Theme

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for Theme

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for Theme

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &<Theme as Deref>::Target

Dereferences the value.

impl DerefMut for Theme

fn deref_mut(&mut self) -> &mut <Theme as Deref>::Target

Mutably dereferences the value.

impl GodotClass for Theme

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = Resource

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl GodotDefault for Theme

impl Inherits<Object> for Theme

impl Inherits<RefCounted> for Theme

impl Inherits<Resource> for Theme