Skip to main content

ControlBase

Struct ControlBase 

Source
pub struct ControlBase { /* private fields */ }
Expand description

Dados comuns de todo controle visual.

left, top, width e height são os valores pedidos. A posição e o tamanho reais, calculados pelo layout (Align/Anchors), ficam em bounds.

Implementations§

Source§

impl ControlBase

Source

pub const PROPS: &'static [PropInfo]

Propriedades publicadas comuns a todos os controles.

Source

pub fn new(width: f32, height: f32) -> Self

Source

pub fn left(&self) -> f32

Source

pub fn top(&self) -> f32

Source

pub fn width(&self) -> f32

Source

pub fn height(&self) -> f32

Source

pub fn position(&self) -> PointF

Source

pub fn size(&self) -> SizeF

Source

pub fn margins(&self) -> Bounds

As margens que valem no layout (com a escala de espaços da vista ativa; a propriedade guarda a do desenho).

Source

pub fn padding(&self) -> Bounds

O padding que vale no layout, como as margins.

Source

pub fn align(&self) -> Align

Source

pub fn anchors(&self) -> Anchors

Source

pub fn visible(&self) -> bool

Source

pub fn design_only(&self) -> bool

Só aparece no designer (em execução não é pintado nem recebe o mouse).

Source

pub fn colors(&self) -> ColorOverride

As cores próprias.

Source

pub fn set_colors(&mut self, colors: ColorOverride) -> &mut Self

Source

pub fn set_design_only(&mut self, on: bool) -> &mut Self

Source

pub fn keep_left_to_right(&self) -> bool

Fica da esquerda para a direita (ele e os filhos) com a interface espelhada.

Source

pub fn set_keep_left_to_right(&mut self, on: bool) -> &mut Self

Source

pub fn enabled(&self) -> bool

Source

pub fn hit_test(&self) -> bool

Source

pub fn translatable(&self) -> bool

Source

pub fn set_translatable(&mut self, v: bool) -> &mut Self

Source

pub fn inherit_state(&self) -> bool

Source

pub fn set_inherit_state(&mut self, v: bool) -> &mut Self

Source

pub fn clip_children(&self) -> bool

Source

pub fn captures_wheel(&self) -> bool

Source

pub fn captures_gesture(&self) -> bool

Source

pub fn draggable(&self) -> bool

Pode receber o foco do teclado (como CanFocus). Arrastável: passar de alguns pontos com o botão pressionado dispara on_drag_start, e o handler começa o arrasto com Ui::begin_drag.

Source

pub fn set_draggable(&mut self, v: bool) -> &mut Self

Source

pub fn accepts_drops(&self) -> bool

Recebe o que é arrastado: on_drag_over ao entrar (o handler recusa com Ui::reject_drop) e on_drag_drop ao soltar.

Source

pub fn set_accepts_drops(&mut self, v: bool) -> &mut Self

Source

pub fn drag_data(&self) -> &str

O que vai no arrasto declarado (vazio: só com o on_drag_start).

Source

pub fn drag_label(&self) -> &str

Source

pub fn drag_image(&self) -> Option<ComponentId>

O DragImage do arrasto (a imagem que acompanha o cursor).

Source

pub fn drop_types(&self) -> &str

Os tipos aceitos ao soltar (vazio: decide o on_drag_over).

Source

pub fn can_focus(&self) -> bool

Source

pub fn tab_stop(&self) -> bool

Participa da navegação com Tab (como TabStop).

Source

pub fn popup_menu(&self) -> Option<ComponentId>

Menu de contexto do controle.

Source

pub fn set_popup_menu(&mut self, menu: Option<ComponentId>) -> &mut Self

Source

pub fn pan_on_touch(&self) -> bool

Source

pub fn hover_within(&self) -> bool

Source

pub fn set_hover_within(&mut self, v: bool) -> &mut Self

A pintura depende do mouse estar no controle ou num filho dele (o :hover do CSS, que vale com o mouse num filho): o núcleo repinta o controle quando o mouse entra ou sai de qualquer um dos de dentro, e Ui::hover_within diz se está.

Source

pub fn cursor(&self) -> CursorShape

Cursor do mouse sobre o controle. Default herda o do pai.

Source

pub fn opacity(&self) -> f32

Source

pub fn blend_mode(&self) -> BlendMode

Como o controle se junta ao que está por baixo (veja o campo).

Source

pub fn set_blend_mode(&mut self, mode: BlendMode) -> &mut Self

Source

pub fn cache_layer(&self) -> bool

O desenho guardado numa imagem (veja o campo).

Source

pub fn set_cache_layer(&mut self, on: bool) -> &mut Self

Source

pub fn rotation(&self) -> f32

Giro em graus, em torno do centro. Só a pintura gira; o clique usa o retângulo sem giro.

Source

pub fn scale(&self) -> f32

A escala dele e de tudo dentro dele (set_scale; 1 = normal).

Source

pub fn inner_size(&self) -> SizeF

O tamanho do espaço de dentro: o do retângulo dividido pela escala. É nele que o controle se desenha (PaintCtx::rect) e que os filhos são arrumados.

Source

pub fn shadow(&self) -> Option<Shadow>

Source

pub fn aspect_ratio(&self) -> f32

Proporção fixa (largura ÷ altura); 0 = livre. No layout, a altura sai da largura (Top, Bottom, Horizontal, None), a largura sai da altura (Left, Right, Vertical) ou o controle cabe na área mantendo a proporção (Client, Center).

Source

pub fn set_aspect_ratio(&mut self, ratio: f32) -> &mut Self

Source

pub fn max_width(&self) -> f32

Largura máxima (0 = sem limite). O controle não passa dela; alinhado em cima, embaixo ou no cliente, fica no meio da área (o conteúdo de uma página que não se espalha numa tela larga). No form, é a largura máxima da janela.

Source

pub fn set_max_width(&mut self, width: f32) -> &mut Self

Source

pub fn min_width(&self) -> f32

Largura mínima (0 = sem limite). O layout não deixa o controle mais estreito que ela, mesmo alinhado (top, client…): o que passar da área do pai fica cortado (ou rola, num ScrollBox), e um texto com wrap para de quebrar nessa largura. No form, é a largura mínima da janela.

Source

pub fn set_min_width(&mut self, width: f32) -> &mut Self

Source

pub fn min_height(&self) -> f32

Altura mínima (0 = sem limite), como a min_width.

Source

pub fn set_min_height(&mut self, height: f32) -> &mut Self

Source

pub fn max_height(&self) -> f32

Altura máxima (0 = sem limite). No form, é a altura máxima da janela.

Source

pub fn set_max_height(&mut self, height: f32) -> &mut Self

Source

pub fn clamp_width(&self, available: f32) -> f32

A largura que o controle ocupa numa faixa de available (com a max_width e a min_width; a mínima vence).

Source

pub fn clamp_height(&self, height: f32) -> f32

A altura dentro da min_height e da max_height (a mínima vence).

Source

pub fn self_align(&self) -> SelfAlign

Encaixado, estica na faixa (stretch) ou fica com o próprio tamanho no começo, no meio ou no fim: veja SelfAlign.

Source

pub fn set_self_align(&mut self, align: SelfAlign) -> &mut Self

Source

pub fn band_width(&self, available: f32) -> f32

A largura numa faixa horizontal de available (encaixado em cima ou embaixo): a faixa toda ou, com self_align, a própria width; com self_align e max_width, a faixa até a máxima (o width: 100%; max-width do CSS). Sempre dentro dos limites.

Source

pub fn band_height(&self, available: f32) -> f32

A altura numa faixa vertical de available (encaixado à esquerda ou à direita), como a band_width.

Source

pub fn band_offset(&self, available: f32, size: f32) -> f32

Onde começa um tamanho size numa faixa de available: no começo, no meio (o stretch com a largura máxima sobrando) ou no fim. Passando da faixa, no começo.

Source

pub fn auto_size(&self) -> bool

A altura sai do conteúdo, na largura que o controle tem: um Label com wrap fica da altura do texto quebrado; um contêiner, da altura dos filhos encaixados em cima e embaixo (mais o padding). Vale com align top, bottom ou none.

Source

pub fn set_auto_size(&mut self, on: bool) -> &mut Self

Source

pub fn column_span(&self) -> u32

Quantas colunas ocupa num GridLayout (pelo menos 1; numa grade com menos colunas, ocupa a linha inteira).

Source

pub fn grid_cell(&self) -> Option<(u32, u32)>

O lugar fixo na grade: (linha, coluna), ou None (segue a ordem dos filhos).

Source

pub fn set_grid_cell(&mut self, cell: Option<(u32, u32)>) -> &mut Self

Source

pub fn row_span(&self) -> u32

Quantas linhas ocupa num GridLayout (o rowspan).

Source

pub fn set_row_span(&mut self, span: u32) -> &mut Self

Source

pub fn grow(&self) -> f32

Source

pub fn set_grow(&mut self, grow: f32) -> &mut Self

Source

pub fn set_column_span(&mut self, span: u32) -> &mut Self

Source

pub fn text_scale(&self) -> f32

A escala de fonte da vista ativa do form (1 sem vista).

Source

pub fn spacing_scale(&self) -> f32

A escala de espaços da vista ativa do form (1 sem vista).

Source

pub fn tag(&self) -> i64

Source

pub fn accessible_name(&self) -> &str

O nome que o leitor de tela fala (o aria-label), no lugar do texto do controle: um botão só com ícone, um campo sem rótulo. O relatório do Tabernáculo, C29.

Source

pub fn set_accessible_name(&mut self, v: &str) -> &mut Self

Source

pub fn tag_string(&self) -> &str

Source

pub fn style(&self) -> &str

Variante de estilo do tema (“primary”, “danger”, “flat”…). Vazio = estilo da classe.

Source

pub fn theme_name(&self) -> &str

Tema próprio do controle (e dos filhos), pelo nome. Vazio = o do pai.

Source

pub fn set_theme_name(&mut self, v: impl Into<String>) -> &mut Self

Source

pub fn hint(&self) -> &str

Dica (balão) mostrada com o mouse parado sobre o controle. Vazio = a do pai.

Source

pub fn set_hint(&mut self, v: impl Into<String>) -> &mut Self

Source

pub fn state(&self) -> ControlState

Source

pub fn bounds(&self) -> RectF

Posição e tamanho reais, relativos ao pai, calculados pelo layout.

Source

pub fn scroll_offset(&self) -> PointF

Quanto o conteúdo está rolado: os filhos são deslocados por este valor.

Source

pub fn laid_out_scroll(&self) -> PointF

A rolagem com que o último layout pôs os filhos (scroll_offset muda na hora; esta, no layout): somada à posição de um filho, dá onde ele está no conteúdo.

Source

pub fn set_scroll_offset(&mut self, offset: PointF) -> &mut Self

Rola o conteúdo. Chame invalidate (ou mude por ui.control_mut) para refazer o layout.

Source

pub fn content_size(&self) -> SizeF

Tamanho ocupado pelos filhos visíveis (com margens e padding), calculado no layout. Serve para saber até onde rolar.

Source

pub fn set_left(&mut self, v: f32) -> &mut Self

Source

pub fn set_top(&mut self, v: f32) -> &mut Self

Source

pub fn set_position(&mut self, left: f32, top: f32) -> &mut Self

Source

pub fn set_width(&mut self, v: f32) -> &mut Self

Source

pub fn set_height(&mut self, v: f32) -> &mut Self

Source

pub fn set_size(&mut self, width: f32, height: f32) -> &mut Self

Source

pub fn set_rect( &mut self, left: f32, top: f32, width: f32, height: f32, ) -> &mut Self

Define posição e tamanho de uma vez.

Source

pub fn set_margins(&mut self, v: impl Into<Bounds>) -> &mut Self

Source

pub fn set_padding(&mut self, v: impl Into<Bounds>) -> &mut Self

Source

pub fn set_align(&mut self, v: Align) -> &mut Self

Source

pub fn set_anchors(&mut self, v: Anchors) -> &mut Self

Source

pub fn set_visible(&mut self, v: bool) -> &mut Self

Source

pub fn set_enabled(&mut self, v: bool) -> &mut Self

Source

pub fn set_hit_test(&mut self, v: bool) -> &mut Self

Source

pub fn set_clip_children(&mut self, v: bool) -> &mut Self

Source

pub fn set_captures_wheel(&mut self, v: bool) -> &mut Self

Source

pub fn set_captures_gesture(&mut self, v: bool) -> &mut Self

Source

pub fn set_can_focus(&mut self, v: bool) -> &mut Self

Source

pub fn set_pan_on_touch(&mut self, v: bool) -> &mut Self

Arrastar o dedo sobre o controle rola o conteúdo (vira roda para o ScrollBox ou o DataGrid de baixo). Ligado por padrão; controles que precisam do arrasto em si (um Splitter, um designer) desligam.

Source

pub fn set_tab_stop(&mut self, v: bool) -> &mut Self

Source

pub fn set_cursor(&mut self, v: CursorShape) -> &mut Self

Source

pub fn set_opacity(&mut self, v: f32) -> &mut Self

Source

pub fn translate(&self) -> PointF

Deslocamento do desenho (sem mexer no layout).

Source

pub fn set_translate(&mut self, offset: PointF) -> &mut Self

Source

pub fn set_scale(&mut self, scale: f32) -> &mut Self

A escala dele e dos filhos (1 = normal; de 0,05 a 20).

Source

pub fn set_rotation(&mut self, degrees: f32) -> &mut Self

Source

pub fn set_shadow(&mut self, shadow: Option<Shadow>) -> &mut Self

Source

pub fn set_tag(&mut self, v: i64) -> &mut Self

Source

pub fn set_tag_string(&mut self, v: &str) -> &mut Self

Source

pub fn set_style(&mut self, v: impl Into<String>) -> &mut Self

Source

pub fn state_mut(&mut self) -> &mut ControlState

Estado visual (hover, pressed…). Normalmente quem altera é o despacho de eventos; controles como CheckBox alteram checked.

Source

pub fn get_prop(&self, name: &str) -> Option<PropValue>

Source

pub fn set_prop(&mut self, name: &str, value: PropValue) -> Result<()>

Source§

impl ControlBase

Source

pub fn font(&self) -> &FontOverride

A fonte própria do controle (sem a herdada).

Source

pub fn set_font(&mut self, font: FontOverride) -> &mut Self

Trait Implementations§

Source§

impl Clone for ControlBase

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ControlBase

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ControlBase

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.