Struct gdnative::api::StyleBoxLine

pub struct StyleBoxLine { /* fields omitted */ }

core class StyleBoxLine inherits StyleBox (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

StyleBoxLine inherits methods from:

• StyleBox
• Resource
• Reference
• Object

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 StyleBoxLine

pub fn new() -> Ref<StyleBoxLine, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn color(&self) -> Color

The line's color.

pub fn grow_begin(&self) -> f64

The number of pixels the line will extend before the [StyleBoxLine]'s bounds. If set to a negative value, the line will begin inside the [StyleBoxLine]'s bounds.

pub fn grow_end(&self) -> f64

The number of pixels the line will extend past the [StyleBoxLine]'s bounds. If set to a negative value, the line will end inside the [StyleBoxLine]'s bounds.

pub fn thickness(&self) -> i64

The line's thickness in pixels.

pub fn is_vertical(&self) -> bool

If [code]true[/code], the line will be vertical. If [code]false[/code], the line will be horizontal.

pub fn set_color(&self, color: Color)

The line's color.

pub fn set_grow_begin(&self, offset: f64)

The number of pixels the line will extend before the [StyleBoxLine]'s bounds. If set to a negative value, the line will begin inside the [StyleBoxLine]'s bounds.

pub fn set_grow_end(&self, offset: f64)

The number of pixels the line will extend past the [StyleBoxLine]'s bounds. If set to a negative value, the line will end inside the [StyleBoxLine]'s bounds.

pub fn set_thickness(&self, thickness: i64)

The line's thickness in pixels.

pub fn set_vertical(&self, vertical: bool)

If [code]true[/code], the line will be vertical. If [code]false[/code], the line will be horizontal.

Methods from Deref<Target = StyleBox>

pub fn draw(&self, canvas_item: Rid, rect: Rect<f32, UnknownUnit>)

Draws this stylebox using a [CanvasItem] with given [RID].
				You can get a [RID] value using [method Object.get_instance_id] on a [CanvasItem]-derived node.

pub fn get_center_size(&self) -> Vector2D<f32, UnknownUnit>

Returns the size of this [StyleBox] without the margins.

pub fn get_current_item_drawn(&self) -> Option<Ref<CanvasItem, Shared>>

Returns the [CanvasItem] that handles its [constant CanvasItem.NOTIFICATION_DRAW] or [method CanvasItem._draw] callback at this moment.

pub fn default_margin(&self, margin: i64) -> f64

The top margin for the contents of this style box. Increasing this value reduces the space available to the contents from the top.
			Refer to [member content_margin_bottom] for extra considerations.

pub fn get_margin(&self, margin: i64) -> f64

Returns the content margin offset for the specified [enum Margin].
				Positive values reduce size inwards, unlike [Control]'s margin values.

pub fn get_minimum_size(&self) -> Vector2D<f32, UnknownUnit>

Returns the minimum size that this stylebox can be shrunk to.

pub fn get_offset(&self) -> Vector2D<f32, UnknownUnit>

Returns the "offset" of a stylebox. This helper function returns a value equivalent to [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code].

pub fn set_default_margin(&self, margin: i64, offset: f64)

The top margin for the contents of this style box. Increasing this value reduces the space available to the contents from the top.
			Refer to [member content_margin_bottom] for extra considerations.

pub fn test_mask(
    &self,
    point: Vector2D<f32, UnknownUnit>,
    rect: Rect<f32, UnknownUnit>
) -> bool

Test a position in a rectangle, return whether it passes the mask test.

Trait Implementations

impl Debug for StyleBoxLine

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

Formats the value using the given formatter.

impl Deref for StyleBoxLine

type Target = StyleBox

The resulting type after dereferencing.

fn deref(&self) -> &StyleBox

Dereferences the value.

impl DerefMut for StyleBoxLine

fn deref_mut(&mut self) -> &mut StyleBox

Mutably dereferences the value.

impl GodotObject for StyleBoxLine

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

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.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for StyleBoxLine

fn construct() -> Ref<StyleBoxLine, Unique>

impl SubClass<Object> for StyleBoxLine

impl SubClass<Reference> for StyleBoxLine

impl SubClass<Resource> for StyleBoxLine

impl SubClass<StyleBox> for StyleBoxLine