Trait CaretMethods 

pub trait CaretMethods: WxRustMethods {
    // Provided methods
    fn create_int<W: WindowMethods>(
        &self,
        window: Option<&W>,
        width: c_int,
        height: c_int,
    ) -> bool { ... }
    fn create_size<W: WindowMethods, S: SizeMethods>(
        &self,
        window: Option<&W>,
        size: &S,
    ) -> bool { ... }
    fn get_position_int(&self, x: *mut c_void, y: *mut c_void) { ... }
    fn get_position(&self) -> Point { ... }
    fn get_size_int(&self, width: *mut c_void, height: *mut c_void) { ... }
    fn get_size(&self) -> Size { ... }
    fn get_window(&self) -> WeakRef<Window> { ... }
    fn hide(&self) { ... }
    fn is_ok(&self) -> bool { ... }
    fn is_visible(&self) -> bool { ... }
    fn move_int(&self, x: c_int, y: c_int) { ... }
    fn move_point<P: PointMethods>(&self, pt: &P) { ... }
    fn set_size_int(&self, width: c_int, height: c_int) { ... }
    fn set_size_size<S: SizeMethods>(&self, size: &S) { ... }
    fn show(&self, show: bool) { ... }
    fn get_blink_time() -> c_int { ... }
    fn set_blink_time(milliseconds: c_int) { ... }
}

This trait represents C++ wxCaret class’s methods and inheritance.

See CaretIsOwned documentation for the class usage.

Provided Methods

fn create_int<W: WindowMethods>( &self, window: Option<&W>, width: c_int, height: c_int, ) -> bool

Creates a caret with the given size (in pixels) and associates it with the window (same as the equivalent constructors).

See C++ wxCaret::Create()’s documentation.

fn create_size<W: WindowMethods, S: SizeMethods>( &self, window: Option<&W>, size: &S, ) -> bool

See C++ wxCaret::Create()’s documentation.

fn get_position_int(&self, x: *mut c_void, y: *mut c_void)

Get the caret position (in pixels).

See C++ wxCaret::GetPosition()’s documentation.

fn get_position(&self) -> Point

See C++ wxCaret::GetPosition()’s documentation.

fn get_size_int(&self, width: *mut c_void, height: *mut c_void)

Get the caret size.

See C++ wxCaret::GetSize()’s documentation.

fn get_size(&self) -> Size

See C++ wxCaret::GetSize()’s documentation.

fn get_window(&self) -> WeakRef<Window>

Get the window the caret is associated with.

See C++ wxCaret::GetWindow()’s documentation.

fn hide(&self)

Hides the caret, same as Show(false).

See C++ wxCaret::Hide()’s documentation.

fn is_ok(&self) -> bool

Returns true if the caret was created successfully.

See C++ wxCaret::IsOk()’s documentation.

fn is_visible(&self) -> bool

Returns true if the caret is visible and false if it is permanently hidden (if it is blinking and not shown currently but will be after the next blink, this method still returns true).

See C++ wxCaret::IsVisible()’s documentation.

fn move_int(&self, x: c_int, y: c_int)

Move the caret to given position (in logical coordinates).

See C++ wxCaret::Move()’s documentation.

fn move_point<P: PointMethods>(&self, pt: &P)

See C++ wxCaret::Move()’s documentation.

fn set_size_int(&self, width: c_int, height: c_int)

Changes the size of the caret.

See C++ wxCaret::SetSize()’s documentation.

fn set_size_size<S: SizeMethods>(&self, size: &S)

See C++ wxCaret::SetSize()’s documentation.

fn show(&self, show: bool)

Shows or hides the caret.

See C++ wxCaret::Show()’s documentation.

fn get_blink_time() -> c_int

Returns the blink time which is measured in milliseconds and is the time elapsed between 2 inversions of the caret (blink time of the caret is the same for all carets, so this functions is static).

See C++ wxCaret::GetBlinkTime()’s documentation.

fn set_blink_time(milliseconds: c_int)

Sets the blink time for all the carets.

See C++ wxCaret::SetBlinkTime()’s documentation.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<const OWNED: bool> CaretMethods for CaretIsOwned<OWNED>