[−][src]Struct gdnative_bindings::ToolButton
core class ToolButton
inherits Button
(unsafe).
Official documentation
See the documentation of this class in the Godot engine's official documentation.
Memory management
Non reference counted objects such as the ones of this type are usually owned by the engine.
ToolButton
is a reference-only type. Persistent references can
only exist in the unsafe Ref<ToolButton>
form.
In the cases where Rust code owns an object of this type, for example if the object was just
created on the Rust side and not passed to the engine yet, ownership should be either given
to the engine or the object must be manually destroyed using Ref::free
, or Ref::queue_free
if it is a Node
.
Class hierarchy
ToolButton 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
impl ToolButton
[src]
pub fn new() -> Ref<Self, Unique>
[src]
Creates a new instance of this object.
Because this type is not reference counted, the lifetime of the returned object is not automatically managed.
Immediately after creation, the object is owned by the caller, and can be
passed to the engine (in which case the engine will be responsible for
destroying the object) or destroyed manually using Ref::free
, or preferably
Ref::queue_free
if it is a Node
.
Methods from Deref<Target = Button>
pub fn button_icon(&self) -> Option<Ref<Texture, Shared>>
[src]
Button's icon, if text is present the icon will be placed before the text.
pub fn clip_text(&self) -> bool
[src]
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.
pub fn text(&self) -> GodotString
[src]
The button's text that will be displayed inside the button's area.
pub fn text_align(&self) -> TextAlign
[src]
Text alignment policy for the button's text, use one of the [enum TextAlign] constants.
pub fn is_expand_icon(&self) -> bool
[src]
When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect.
pub fn is_flat(&self) -> bool
[src]
Flat buttons don't display decoration.
pub fn set_button_icon(&self, texture: impl AsArg<Texture>)
[src]
Button's icon, if text is present the icon will be placed before the text.
pub fn set_clip_text(&self, enabled: bool)
[src]
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.
pub fn set_expand_icon(&self, arg0: bool)
[src]
When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect.
pub fn set_flat(&self, enabled: bool)
[src]
Flat buttons don't display decoration.
pub fn set_text(&self, text: impl Into<GodotString>)
[src]
The button's text that will be displayed inside the button's area.
pub fn set_text_align(&self, align: i64)
[src]
Text alignment policy for the button's text, use one of the [enum TextAlign] constants.
Trait Implementations
impl Debug for ToolButton
[src]
impl Deref for ToolButton
[src]
impl DerefMut for ToolButton
[src]
impl GodotObject for ToolButton
[src]
type RefKind = ManuallyManaged
The memory management kind of this type. This modifies the behavior of the
Ref
smart pointer. See its type-level documentation for more
information. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for ToolButton
[src]
impl QueueFree for ToolButton
[src]
unsafe fn godot_queue_free(obj: *mut godot_object)
[src]
impl Sealed for ToolButton
[src]
impl SubClass<BaseButton> for ToolButton
[src]
impl SubClass<Button> for ToolButton
[src]
impl SubClass<CanvasItem> for ToolButton
[src]
impl SubClass<Control> for ToolButton
[src]
impl SubClass<Node> for ToolButton
[src]
impl SubClass<Object> for ToolButton
[src]
Auto Trait Implementations
impl RefUnwindSafe for ToolButton
impl !Send for ToolButton
impl !Sync for ToolButton
impl Unpin for ToolButton
impl UnwindSafe for ToolButton
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,