Home /Modules/user-interface/SLButton.sleela

SLButton.sleela

lib/user-interface/SLButton.sleela · 113 line(s) · sleela

<< lib/user-interface/SLButton.sleela
   SLeeLa Standard Library Definition.
   Definition: Defines SLButton — a SleelaUI push button: a rounded surface with
     centred text, a 1px hairline, a hover/active tint, and an accent focus ring
     when keyboard-focused. Mark it suggested() to make it the one accent action
     in its group, or destructive() to turn it red on hover. The constructor
     bottoms out in the `uiButton` built-in (SleelaUI C ABI slui_button());
     clicks (and Enter/Space while focused) raise an activate event the host
     polls through the application's event loop.
   
   An SLButton IS an SLWidget and is keyboard-focusable.
   
   Family: user-interface. Native VM/UI work crosses the explicit `ui*` SLVM
   bridge. >>
#sleela 2.5
material;
class SLButton extends SLWidget {
  < ---- Descriptive metadata (version 1.11 nested-friendly accessors) ---- >
  << Eleven catalogued attributes with getter/setter pairs, so a GUI, loader,
     or catalog can read and (where appropriate) override this record.
     Values are faithful to the subject's real origin where publicly known. >>
  String metaVersion = "1.0.0";
  int metaId = 11412;
  String metaAuthor = "Kiro Agent";
  String metaDate = "2026-10-20";
  String metaCopyright = "SLeeLa project";
  String metaTrademark = "none";
  String metaCorporation = "none";
  < metaOrigin: National | <nation> | International | Galactic >
  String metaOrigin = "International";
  String metaBirthDate = "2026-10-07";
  < metaScienceRating: maturity/robustness on a 1..10 scale >
  int metaScienceRating = 9;
  < metaNationalSchedule: a real, citable instrument or "none" >
  String metaNationalSchedule = "none";

  String getMetaVersion() { return metaVersion; }
  void setMetaVersion(String v) { metaVersion = v; }
  int getMetaId() { return metaId; }
  void setMetaId(int v) { metaId = v; }
  String getAuthor() { return metaAuthor; }
  void setAuthor(String v) { metaAuthor = v; }
  String getDate() { return metaDate; }
  void setDate(String v) { metaDate = v; }
  String getCopyright() { return metaCopyright; }
  void setCopyright(String v) { metaCopyright = v; }
  String getTrademark() { return metaTrademark; }
  void setTrademark(String v) { metaTrademark = v; }
  String getCorporation() { return metaCorporation; }
  void setCorporation(String v) { metaCorporation = v; }
  String getOrigin() { return metaOrigin; }
  void setOrigin(String v) { metaOrigin = v; }
  String getBirthDate() { return metaBirthDate; }
  void setBirthDate(String v) { metaBirthDate = v; }
  int getScienceRating() { return metaScienceRating; }
  void setScienceRating(int v) { metaScienceRating = v; }
  String getNationalSchedule() { return metaNationalSchedule; }
  void setNationalSchedule(String v) { metaNationalSchedule = v; }
  < Create a button inside `parent` with a label. >
  void createIn(SLWidget parent, String label) {
    widget = uiButton(parent.handle(), label);
  }
  void createInHandle(int parentHandle, String label) {
    widget = uiButton(parentHandle, label);
  }

  < Create a labelled button and attach an icon descriptor in one operation. >
  void createInWithIcon(SLWidget parent, String label, SLIcon icon) {
    createIn(parent, label);
    setIcon(icon);
  }
  void createInHandleWithIcon(int parentHandle, String label, SLIcon icon) {
    createInHandle(parentHandle, label);
    setIcon(icon);
  }

  < Attach a JPEG icon plus a named fallback symbol (for example, Wifi). >
  void setIcon(SLIcon icon) {
    if (widget >= 0 && icon != null) {
      uiWidgetSetIcon(widget, icon.assetPath(), icon.symbolName());
    }
  }
  void setIconPath(String assetPath, String symbolName) {
    if (widget >= 0) { uiWidgetSetIcon(widget, assetPath, symbolName); }
  }

  < True if this button has an activation pending since the last check; the >
  < VM clears the latch on read, so each click is observed exactly once. >
  boolean clicked() {
    if (widget < 0) { return false; }
    return uiWidgetTakeActivated(widget) == 1;
  }

  < True while the pointer is over the button. >
  boolean hovered() {
    return widget >= 0 && uiWidgetIsHovered(widget) == 1;
  }

  < One-shot pointer press/release and hover transition events. >
  boolean takePressed() {
    return widget >= 0 && uiWidgetTakePressed(widget) == 1;
  }
  boolean takeReleased() {
    return widget >= 0 && uiWidgetTakeReleased(widget) == 1;
  }
  boolean takeHoverEntered() {
    return widget >= 0 && uiWidgetTakeHoverEntered(widget) == 1;
  }
  boolean takeHoverLeft() {
    return widget >= 0 && uiWidgetTakeHoverLeft(widget) == 1;
  }
}