Struct moxie_dom::elements::forms::ButtonBuilder

#[must_use = "needs to be built"]pub struct ButtonBuilder { /* fields omitted */ }

The HTML <button> element represents a clickable button, which can be used in forms or anywhere in a document that needs simple, standard button functionality.

A type for initializing the element’s attributes before calling build.

Implementations

impl ButtonBuilder

pub fn autofocus(self, to_set: bool) -> Self

Specifies that the button should have input focus when the page loads. Only one element in a document can have this attribute.

pub fn disabled(self, to_set: bool) -> Self

Prevents the user from interacting with the button: it cannot be pressed or focused.

pub fn form(self, to_set: impl ToString) -> Self

The <form> element to associate the button with (its form owner). The value of this attribute must be the id of a <form> in the same document. (If this attribute is not set, the <button> is associated with its ancestor <form> element, if any.)

This attribute lets you associate <button> elements to <form>s anywhere in the document, not just inside a <form>. It can also override an ancestor <form> element.

pub fn formaction(self, to_set: impl ToString) -> Self

The URL that processes the information submitted by the button. Overrides the action attribute of the button’s form owner. Does nothing if there is no form owner.

pub fn formenctype(self, to_set: impl ToString) -> Self

If the button is a submit button (it’s inside/associated with a <form> and doesn’t have type=“button”), specifies how to encode the form data that is submitted. Possible values:

• application/x-www-form-urlencoded: The default if the attribute is not used.
• multipart/form-data: Use to submit <input> elements with their type attributes set to file.
• text/plain: Specified as a debugging aid; shouldn’t be used for real form submission.

If this attribute is specified, it overrides the enctype attribute of the button’s form owner.

pub fn formmethod(self, to_set: impl ToString) -> Self

If the button is a submit button (it’s inside/associated with a <form> and doesn’t have type=“button”), this attribute specifies the HTTP method used to submit the form. Possible values:

• post: The data from the form are included in the body of the HTTP request when sent to the server. Use when the form contains information that shouldn’t be public, like login credentials.
• get: The form data are appended to the form’s action URL, with a ? as a separator, and the resulting URL is sent to the server. Use this method when the form has no side effects, like search forms.

If specified, this attribute overrides the method attribute of the button’s form owner.

pub fn formnovalidate(self, to_set: bool) -> Self

If the button is a submit button, specifies that the form is not to be validated when it is submitted. If this attribute is specified, it overrides the novalidate attribute of the button’s form owner.

This attribute is also available on <input type="image"> and <input type="submit"> elements.

pub fn formtarget(self, to_set: impl ToString) -> Self

If the button is a submit button, this attribute is a author-defined name or standardized, underscore-prefixed keyword indicating where to display the response from submitting the form. This is the name of, or keyword for, a browsing context (a tab, window, or <iframe>). If this attribute is specified, it overrides the target attribute of the button’s form owner. The following keywords have special meanings:

• _self: Load the response into the same browsing context as the current one. This is the default if the attribute is not specified.
• _blank: Load the response into a new unnamed browsing context — usually a new tab or window, depending on the user’s browser settings.
• _parent: Load the response into the parent browsing context of the current one. If there is no parent, this option behaves the same way as _self.
• _top: Load the response into the top-level browsing context (that is, the browsing context that is an ancestor of the current one, and has no parent). If there is no parent, this option behaves the same way as _self.

pub fn name(self, to_set: impl ToString) -> Self

The name of the button, submitted as a pair with the button’s value as part of the form data.

pub fn type_(self, to_set: impl ToString) -> Self

The default behavior of the button. Possible values are:

• submit: The button submits the form data to the server. This is the default if the attribute is not specified for buttons associated with a <form>, or if the attribute is an empty or invalid value.
• reset: The button resets all the controls to their initial values, like <input type="reset">. (This behavior tends to annoy users.)
• button: The button has no default behavior, and does nothing when pressed by default. It can have client-side scripts listen to the element’s events, which are triggered when the events occur.

pub fn value(self, to_set: impl ToString) -> Self

Defines the value associated with the button’s name when it’s submitted with the form data. This value is passed to the server in params when the form is submitted.

Trait Implementations

impl ElementBuilder for ButtonBuilder

fn attribute(self, name: &'static str, value: impl AsRef<str>) -> Self

Declare an attribute of the element, mutating the actual element’s attribute when the passed value changes.

fn class(self, to_set: impl ToString) -> Self

Updates the element’s class.

fn id(self, to_set: impl ToString) -> Self

Updates the element’s id.

fn style(self, to_set: impl ToString) -> Self

Updates the element’s style.

impl<E> EventTarget<E> for ButtonBuilder where
    E: GlobalEvent, 

fn on(self, callback: impl FnMut(Ev) + 'static) -> Self

Declare an event handler on the element.

impl GlobalEventHandler for ButtonBuilder

fn onabort(self, callback: impl FnMut(Abort) + 'static) -> Self

Set an event handler.

fn onblur(self, callback: impl FnMut(Blur) + 'static) -> Self

Set an event handler.

fn oncancel(self, callback: impl FnMut(Cancel) + 'static) -> Self

Set an event handler.

fn oncanplay(self, callback: impl FnMut(CanPlay) + 'static) -> Self

Set an event handler.

fn oncanplaythrough(
    self,
    callback: impl FnMut(CanPlayThrough) + 'static
) -> Self

Set an event handler.

fn onchange(self, callback: impl FnMut(Change) + 'static) -> Self

Set an event handler.

fn onclick(self, callback: impl FnMut(Click) + 'static) -> Self

Set an event handler.

fn onclose(self, callback: impl FnMut(CloseWebsocket) + 'static) -> Self

Set an event handler.

fn oncontextmenu(self, callback: impl FnMut(ContextMenu) + 'static) -> Self

Set an event handler.

fn oncuechange(self, callback: impl FnMut(CueChange) + 'static) -> Self

Set an event handler.

fn ondblclick(self, callback: impl FnMut(DoubleClick) + 'static) -> Self

Set an event handler.

fn ondrag(self, callback: impl FnMut(Drag) + 'static) -> Self

Set an event handler.

fn ondragend(self, callback: impl FnMut(DragEnd) + 'static) -> Self

Set an event handler.

fn ondragenter(self, callback: impl FnMut(DragEnter) + 'static) -> Self

Set an event handler.

fn ondragexit(self, callback: impl FnMut(DragExit) + 'static) -> Self

Set an event handler.

fn ondragleave(self, callback: impl FnMut(DragLeave) + 'static) -> Self

Set an event handler.

fn ondragover(self, callback: impl FnMut(DragOver) + 'static) -> Self

Set an event handler.

fn ondragstart(self, callback: impl FnMut(DragStart) + 'static) -> Self

Set an event handler.

fn ondrop(self, callback: impl FnMut(Dropped) + 'static) -> Self

Set an event handler.

fn ondurationchange(
    self,
    callback: impl FnMut(DurationChange) + 'static
) -> Self

Set an event handler.

fn onemptied(self, callback: impl FnMut(Emptied) + 'static) -> Self

Set an event handler.

fn onended(self, callback: impl FnMut(PlaybackEnded) + 'static) -> Self

Set an event handler.

fn onerror(self, callback: impl FnMut(ErrorEvent) + 'static) -> Self

Set an event handler.

fn onfocus(self, callback: impl FnMut(Focus) + 'static) -> Self

Set an event handler.

fn ongotpointercapture(
    self,
    callback: impl FnMut(GotPointerCapture) + 'static
) -> Self

Set an event handler.

fn oninput(self, callback: impl FnMut(Input) + 'static) -> Self

Set an event handler.

fn oninvalid(self, callback: impl FnMut(Invalid) + 'static) -> Self

Set an event handler.

fn onkeydown(self, callback: impl FnMut(KeyDown) + 'static) -> Self

Set an event handler.

fn onkeypress(self, callback: impl FnMut(KeyPress) + 'static) -> Self

Set an event handler.

fn onkeyup(self, callback: impl FnMut(KeyUp) + 'static) -> Self

Set an event handler.

fn onload(self, callback: impl FnMut(ResourceLoad) + 'static) -> Self

Set an event handler.

fn onloadeddata(self, callback: impl FnMut(DataLoaded) + 'static) -> Self

Set an event handler.

fn onloadedmetadata(
    self,
    callback: impl FnMut(MetadataLoaded) + 'static
) -> Self

Set an event handler.

fn onloadend(self, callback: impl FnMut(LoadEnd) + 'static) -> Self

Set an event handler.

fn onloadstart(self, callback: impl FnMut(LoadStart) + 'static) -> Self

Set an event handler.

fn onlostpointercapture(
    self,
    callback: impl FnMut(LostPointerCapture) + 'static
) -> Self

Set an event handler.

fn onmouseenter(self, callback: impl FnMut(MouseEnter) + 'static) -> Self

Set an event handler.

fn onmouseleave(self, callback: impl FnMut(MouseLeave) + 'static) -> Self

Set an event handler.

fn onmousemove(self, callback: impl FnMut(MouseMove) + 'static) -> Self

Set an event handler.

fn onmouseout(self, callback: impl FnMut(MouseOut) + 'static) -> Self

Set an event handler.

fn onmouseover(self, callback: impl FnMut(MouseOver) + 'static) -> Self

Set an event handler.

fn onmouseup(self, callback: impl FnMut(MouseUp) + 'static) -> Self

Set an event handler.

fn onpause(self, callback: impl FnMut(Pause) + 'static) -> Self

Set an event handler.

fn onplay(self, callback: impl FnMut(Play) + 'static) -> Self

Set an event handler.

fn onplaying(self, callback: impl FnMut(Playing) + 'static) -> Self

Set an event handler.

fn onpointercancel(self, callback: impl FnMut(PointerCancel) + 'static) -> Self

Set an event handler.

fn onpointerdown(self, callback: impl FnMut(PointerDown) + 'static) -> Self

Set an event handler.

fn onpointerenter(self, callback: impl FnMut(PointerEnter) + 'static) -> Self

Set an event handler.

fn onpointerleave(self, callback: impl FnMut(PointerLeave) + 'static) -> Self

Set an event handler.

fn onpointermove(self, callback: impl FnMut(PointerMove) + 'static) -> Self

Set an event handler.

fn onpointerout(self, callback: impl FnMut(PointerOut) + 'static) -> Self

Set an event handler.

fn onpointerover(self, callback: impl FnMut(PointerOver) + 'static) -> Self

Set an event handler.

fn onpointerup(self, callback: impl FnMut(PointerUp) + 'static) -> Self

Set an event handler.

fn onprogress(self, callback: impl FnMut(Progress) + 'static) -> Self

Set an event handler.

fn onratechange(
    self,
    callback: impl FnMut(PlaybackRateChange) + 'static
) -> Self

Set an event handler.

fn onreset(self, callback: impl FnMut(FormReset) + 'static) -> Self

Set an event handler.

fn onresize(self, callback: impl FnMut(ViewResize) + 'static) -> Self

Set an event handler.

fn onscroll(self, callback: impl FnMut(Scroll) + 'static) -> Self

Set an event handler.

fn onseeked(self, callback: impl FnMut(Seeked) + 'static) -> Self

Set an event handler.

fn onseeking(self, callback: impl FnMut(Seeking) + 'static) -> Self

Set an event handler.

fn onselect(self, callback: impl FnMut(Select) + 'static) -> Self

Set an event handler.

fn onselectionchange(
    self,
    callback: impl FnMut(SelectionChange) + 'static
) -> Self

Set an event handler.

fn onselectstart(self, callback: impl FnMut(SelectionStart) + 'static) -> Self

Set an event handler.

fn onshow(self, callback: impl FnMut(ContextMenuShow) + 'static) -> Self

Set an event handler.

fn onstalled(self, callback: impl FnMut(Stalled) + 'static) -> Self

Set an event handler.

fn onsubmit(self, callback: impl FnMut(Submit) + 'static) -> Self

Set an event handler.

fn onsuspend(self, callback: impl FnMut(Suspend) + 'static) -> Self

Set an event handler.

fn ontimeupdate(self, callback: impl FnMut(TimeUpdate) + 'static) -> Self

Set an event handler.

fn onvolumechange(self, callback: impl FnMut(VolumeChange) + 'static) -> Self

Set an event handler.

fn onwaiting(self, callback: impl FnMut(Waiting) + 'static) -> Self

Set an event handler.

fn onwheel(self, callback: impl FnMut(Wheel) + 'static) -> Self

Set an event handler.

impl HtmlElementBuilder for ButtonBuilder

fn accesskey(self, to_set: impl ToString) -> Self

Keyboard shortcut to activate or add focus to the element.

fn autocapitalize(self, to_set: impl ToString) -> Self

Sets whether input is automatically capitalized when entered by user. It can have the following values:

fn contenteditable(self, to_set: bool) -> Self

A value of “true” means the element is editable and a value of “false” means it isn’t.

fn dir(self, to_set: impl ToString) -> Self

The directionality of the element. It can have the following values:

fn draggable(self, to_set: bool) -> Self

Defines whether the element can be dragged.

fn hidden(self, to_set: bool) -> Self

Indicates if the element is hidden or not.

fn inert(self, to_set: bool) -> Self

Indicates whether the user agent must act as though the given node is absent for the purposes of user interaction events, in-page text searches (“find in page”), and text selection.

fn inputmode(self, to_set: impl ToString) -> Self

Provides a hint as to the type of data that might be entered by the user while editing the element or its contents. The attribute can be used with form controls (such as the value of textarea elements), or in elements in an editing host (e.g., using contenteditable attribute).

fn lang(self, to_set: impl ToString) -> Self

The language of an element’s attributes, text, and element contents.

fn slot(self, to_set: impl ToString) -> Self

Assigns a slot in a shadow DOM shadow tree to an element.

fn spellcheck(self, to_set: impl ToString) -> Self

Indicates whether spell checking is allowed for the element.

fn tabindex(self, to_set: impl ToString) -> Self

Overrides the browser’s default tab order and follows the one specified instead.

fn title(self, to_set: impl ToString) -> Self

The text that appears in a popup box when mouse is over the element.

impl NodeBuilder for ButtonBuilder

type Output = Button

The type of the DOM node

fn build(self) -> Button

Initialize the element with all of the attributes so far.

impl NodeWrapper for ButtonBuilder

fn raw_node_that_has_sharp_edges_please_be_careful(&self) -> &Node

Retrieves access to the raw HTML element underlying the (CachedNode).

impl<Child> Parent<Child> for ButtonBuilder where
    Child: PhrasingContent, 

fn child<T: NodeBuilder<Output = C>>(self, child: T) -> Self

Add a child to this node.