Struct dui::control::text::Text

pub struct Text(_);

See the [IUP Text Documentation][1]. [1]: http://webserver2.tecgraf.puc-rio.br/iup/en/elem/iuptext.html

Methods

impl Text

pub fn new() -> Text

Creates a editable text-field.

pub fn new_spin() -> Text

Creates a spin control.

The spin increments and decrements an integer number.

pub fn convert_lincol_to_pos(&self, lin: i32, col: i32) -> usize

Converts a (lin, col) character positioning into an absolute position.

lin and col starts at 1, pos starts at 0. For single line controls pos is always col-1.

pub fn convert_pos_to_lincol(&self, pos: usize) -> (i32, i32)

Converts an absolute position into a (lin, col) character positioning.

lin and col starts at 1, pos starts at 0. For single line controls lin is always 1, and col is always pos+1.

Trait Implementations

impl Element for Text

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 Text

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

Formats the value using the given formatter.

impl Copy for Text

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DestroyCb for Text

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 From<Text> for Handle

fn from(elem: Text) -> Handle

Performs the conversion.

impl Widget for Text

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 Node for Text

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 ConvertXYToPos for Text

Returns a position in the string.

fn convert_xy_to_pos(&self, x: i32, y: i32) -> Option<i32>

Converts a x,y coordinate in an item position in the container.

impl MapCb for Text

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 Text

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 Text

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 Text

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 Text

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 Text

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 Text

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 ButtonCb for Text

Action generated when any mouse button is pressed or released.

Use convert_xy_to_pos to convert (x,y) coordinates in character positioning.

fn set_button_cb<F>(&mut self, cb: F) -> Self where
    F: Callback<(Self, MouseButton, MouseButtonState, i32, i32, KeyStates)>, 

fn remove_button_cb(
    &mut self
) -> Option<Box<Callback<(Self, MouseButton, MouseButtonState, i32, i32, KeyStates)>>>

impl CaretCb for Text

Action generated when the caret/cursor position is changed.

For single line controls lin (2nd param) is always 1, and pos (3rd param) is always col-1.

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

fn remove_caret_cb(&mut self) -> Option<Box<Callback<(Self, i32, i32, usize)>>>

impl DropFilesCb for Text

Action generated when one or more files are dropped in the element.

fn set_dropfiles_cb<F>(&mut self, cb: F) -> Self where
    F: Callback<(Self, PathBuf, usize, i32, i32)>, 

fn remove_dropfiles_cb(
    &mut self
) -> Option<Box<Callback<(Self, PathBuf, usize, i32, i32)>>>

impl MotionCb for Text

Action generated when the mouse is moved.

Use convert_xy_to_pos to convert (x,y) coordinates in character positioning.

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

fn remove_motion_cb(
    &mut self
) -> Option<Box<Callback<(Self, i32, i32, KeyStates)>>>

impl SpinCb for Text

Action generated when a spin button is pressed.

Valid only when the element is a spin (Text::new_spin or SPIN=YES attribute). When this callback is called the ACTION callback is not called. The VALUE attribute can be changed during this callback only if SPINAUTO=NO.

The i32 parameter received by the callback is the value of the spin (after incremented).

May return CallbackReturn::Ignore but that is only allowed on Windows and Motif.

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

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

impl ValueChangedCb for Text

Called after the value was interactively changed by the user.

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

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

impl TextAction for Text

See the TextAction documentation.

fn set_action<F>(&mut self, cb: F) -> Self where
    F: Callback<(Self, Option<char>, String)>, 

fn remove_action(
    &mut self
) -> Option<Box<Callback<(Self, Option<char>, String)>>>