Enum tk::menu::Index

pub enum Index {
    Active,
    End,
    None,
    At(c_int),
    Number(c_int),
    Pattern(String),
}

Many of the methods of a menu take as one argument an indicator of which entry of the menu to operate on. These indicators are called Indexes and may be specified in any of the following forms:

• Index::Active

Indicates the entry that is currently active. If no entry is active then this form is equivalent to none.

• Index::End

Indicates the bottommost entry in the menu. If there are no entries in the menu then this form is equivalent to none.

• Index::None

Indicates “no entry at all”; this is used most commonly with the activate option to deactivate all the entries in the menu. In most cases the specification of none causes nothing to happen in the widget command.

• Index::At

In this form, number is treated as a y-coordinate in the menu’s window; the entry closest to that y-coordinate is used. For example, Index::At(0) indicates the top-most entry in the window.

• Index::Number

Specifies the entry numerically, where 0 corresponds to the top-most entry of the menu, 1 to the entry below it, and so on.

• Index::Pattern

Pattern is pattern-matched against the label of each entry in the menu, in order from the top down, until a matching entry is found. The rules of string match are used.

Variants

Active

End

None

At(c_int)

Number(c_int)

Pattern(String)

Implementations

impl Index

pub fn pattern(pattern: &str) -> Self

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl From<Index> for Obj

fn from(index: Index) -> Obj

Converts to this type from the input type.

impl From<i32> for Index

fn from(number: c_int) -> Self

Converts to this type from the input type.

impl PartialEq for Index

fn eq(&self, other: &Index) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TkDefaultEnd for Index

fn default_end() -> Self

impl TkDefaultStart for Index

fn default_start() -> Self

impl StructuralPartialEq for Index