Struct droom_ui::element::Handle

pub struct Handle(_);

An object that can wrap any IUP element.

The handle also provides implementation for traits that mayn't be implemented for the contained element, so be careful when using it.

Methods

impl Handle

fn from_named<S: Into<String>>(name: S) -> Option<Handle>

Constructs from a name associated with a element handle (with Element::add_handle_name or LED).

fn try_downcast<E: Element>(self) -> Result<E, Handle>

Converts this handle object into a element object if they are compatible.

Trait Implementations

impl Element for Handle

fn raw(&self) -> *mut Ihandle

Gets the raw IUP handle associated with this element.

unsafe fn from_raw_unchecked(ih: *mut Ihandle) -> Self

Constructs an Element from a raw IUP handle.

unsafe fn target_classname() -> &'static str

Gets the [class name][1] the derived object should be targeting. [1]: http://webserver2.tecgraf.puc-rio.br/iup/en/func/iupgetclassname.html

fn from_handle(handle: Handle) -> Result<Self, Handle>

Constructs a specialized Element object from a general Handle if they are compatible.

fn from_name<S: Into<String>>(name: S) -> Option<Handle>

Constructs from a name associated with a element handle (with Element::add_handle_name or LED).

fn from_raw(ih: *mut Ihandle) -> Self

Constructs an Element from a raw IUP handle.

unsafe fn classname(&self) -> &CStr

Gets the [class name][1] of this element. [1]: http://webserver2.tecgraf.puc-rio.br/iup/en/func/iupgetclassname.html

fn destroy(self)

Destroys an interface element and all its children.

fn does_attrib_exist(&self, cname: &CString) -> bool

Checks if a specific attribute exists in the element.

fn attribs(&self) -> Vec<String>

Returns the names of all attributes of an element that are set in its internal hash table only.

fn set_attrib<S1, S2>(&mut self, name: S1, value: S2) -> Self where S1: Into<String>, S2: Into<String>

Sets an interface element attribute.

fn attrib<S: Into<String>>(&self, name: S) -> Option<String>

Gets an interface element attribute.

fn set_attrib_data<S1>(&mut self, name: S1, data: *const c_void) -> Self where S1: Into<String>

Sets a raw interface element attribute.

fn attrib_data<S1>(&mut self, name: S1) -> *mut c_void where S1: Into<String>

Gets a raw interface element attribute.

fn set_attrib_handle<S1, E>(&mut self, name: S1, elem: E) -> Self where S1: Into<String>, E: Element

Associates a element with an attribute.

fn attrib_handle<S1>(&mut self, name: S1) -> Option<Handle> where S1: Into<String>

Gets the handle associated with an attribute.

fn clear_attrib<S: Into<String>>(&mut self, name: S) -> Self

Clears the value associated with an attribute and use the default value.

fn reset_attrib<S: Into<String>>(&mut self, name: S) -> Self

Removes an attribute from element and its children if the attrib is inheritable.

fn handle_name(&self) -> Option<String>

Returns the identifier of an interface element that has an associated handle name using Element::add_handle_name or using LED.

fn add_handle_name<S: Into<String>>(&self, name: S) -> Option<Handle>

Associates a handle name with an interface element.

fn clear_handle_name<S: Into<String>>(name: S) -> Option<Handle>

Clears the handle name association on the specified name.

impl Debug for Handle

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Copy for Handle

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DestroyCb for Handle

fn set_destroy_cb<F>(&mut self, cb: F) -> Self where F: Callback<(Self,)>

fn remove_destroy_cb(&mut self) -> Option<Box<Callback<(Self,)>>>

impl Container for Handle

Note: The wrapped element may not support Container.

fn append<E: Node>(&mut self, new_child: E) -> Result<Handle, E>

Inserts an interface element at the end of the container, after the last element on it.

fn insert<E1, E2>(&mut self,
                  ref_child: &E1,
                  new_child: E2)
                  -> Result<Handle, E2> where E1: Node, E2: Node

Inserts an interface element before another child of the container.

fn child(&self, pos: usize) -> Option<Handle>

Returns the a child of the element given its position.

fn child_pos<E: Node>(&self, child: &E) -> Option<usize>

Returns the position of a child of the given control.

fn child_count(&self) -> usize

Returns the number of children of the given element.

impl Node for Handle

Note: The wrapped element may not support Node.

fn detach(&mut self) -> Self

Detaches an interface element from its parent.

fn reparent<E1, E2>(&mut self,
                    new_parent: E1,
                    ref_child: E2)
                    -> Result<Self, Self> where E1: Container, E2: Node

Moves an interface element from one position in the hierarchy tree to another.

fn parent(&self) -> Option<Handle>

Returns the parent of a element.

fn brother(&self) -> Option<Handle>

Returns the brother of an element.

fn dialog(&self) -> Option<Handle>

Returns the handle of the dialog that contains that interface element.

fn dialog_child<S: Into<String>>(&self, name: S) -> Option<Handle>

Returns the identifier of the child element that has the NAME attribute equals to the given value on the same dialog hierarchy.

fn refresh(&mut self)

Updates the size and layout of all controls in the same dialog.

fn refresh_children(&mut self)

Updates the size and layout of controls after changing size attributes, or attributes that affect the size of the control.

fn update(&self)

Mark the element to be redraw when the control returns to the system.

fn update_children(&self)

Mark the element children to be redraw when the control returns to the system.

fn redraw(&self, also_redraw_children: bool)

Force the element and its children to be redraw immediately.

impl Widget for Handle

Note: The wrapped element may not support Widget.

fn map(&mut self) -> Result<Self, Self>

Creates (maps) the native interface objects corresponding to the given IUP interface elements.

fn unmap(&mut self)

Unmap the element from the native system. It will also unmap all its children.

fn show(&mut self) -> Result<(), String>

Shows an interfance element.

fn hide(&mut self) -> Self

Hides an interface element.

impl MapCb for Handle

Note: The wrapped element may not support MapCb.

fn set_map_cb<F>(&mut self, cb: F) -> Self where F: Callback<(Self,)>

fn remove_map_cb(&mut self) -> Option<Box<Callback<(Self,)>>>

impl UnmapCb for Handle

Note: The wrapped element may not support UnmapCb.

fn set_unmap_cb<F>(&mut self, cb: F) -> Self where F: Callback<(Self,)>

fn remove_unmap_cb(&mut self) -> Option<Box<Callback<(Self,)>>>

impl GetFocusCb for Handle

Note: The wrapped element may not support GetFocusCb.

fn set_getfocus_cb<F>(&mut self, cb: F) -> Self where F: Callback<(Self,)>

fn remove_getfocus_cb(&mut self) -> Option<Box<Callback<(Self,)>>>

impl KillFocusCb for Handle

Note: The wrapped element may not support KillFocusCb.

fn set_killfocus_cb<F>(&mut self, cb: F) -> Self where F: Callback<(Self,)>

fn remove_killfocus_cb(&mut self) -> Option<Box<Callback<(Self,)>>>

impl EnterWindowCb for Handle

Note: The wrapped element may not support EnterWindowCb.

fn set_enterwindow_cb<F>(&mut self, cb: F) -> Self where F: Callback<(Self,)>

fn remove_enterwindow_cb(&mut self) -> Option<Box<Callback<(Self,)>>>

impl LeaveWindowCb for Handle

Note: The wrapped element may not support LeaveWindowCb.

fn set_leavewindow_cb<F>(&mut self, cb: F) -> Self where F: Callback<(Self,)>

fn remove_leavewindow_cb(&mut self) -> Option<Box<Callback<(Self,)>>>

impl HelpCb for Handle

Note: The wrapped element may not support HelpCb.

fn set_help_cb<F>(&mut self, cb: F) -> Self where F: Callback<(Self,)>

fn remove_help_cb(&mut self) -> Option<Box<Callback<(Self,)>>>

impl From<Dialog> for Handle

fn from(elem: Dialog) -> Handle

Performs the conversion.

impl From<MessageDlg> for Handle

fn from(elem: MessageDlg) -> Handle

Performs the conversion.

impl From<FileDlg> for Handle

fn from(elem: FileDlg) -> Handle

Performs the conversion.

impl From<VBox> for Handle

fn from(elem: VBox) -> Handle

Performs the conversion.

impl From<HBox> for Handle

fn from(elem: HBox) -> Handle

Performs the conversion.

impl From<Radio> for Handle

fn from(elem: Radio) -> Handle

Performs the conversion.

impl From<Fill> for Handle

fn from(elem: Fill) -> Handle

Performs the conversion.

impl From<Label> for Handle

fn from(elem: Label) -> Handle

Performs the conversion.

impl From<Text> for Handle

fn from(elem: Text) -> Handle

Performs the conversion.

impl From<Button> for Handle

fn from(elem: Button) -> Handle

Performs the conversion.

impl From<ProgressBar> for Handle

fn from(elem: ProgressBar) -> Handle

Performs the conversion.

impl From<Toggle> for Handle

fn from(elem: Toggle) -> Handle

Performs the conversion.

impl From<Frame> for Handle

fn from(elem: Frame) -> Handle

Performs the conversion.

impl From<List> for Handle

fn from(elem: List) -> Handle

Performs the conversion.

impl From<Image> for Handle

fn from(elem: Image) -> Handle

Performs the conversion.

impl From<ImageRgb> for Handle

fn from(elem: ImageRgb) -> Handle

Performs the conversion.

impl From<ImageRgba> for Handle

fn from(elem: ImageRgba) -> Handle

Performs the conversion.

impl From<Timer> for Handle

fn from(elem: Timer) -> Handle

Performs the conversion.

impl From<Clipboard> for Handle

fn from(elem: Clipboard) -> Handle

Performs the conversion.