%3 ::nx::Object ::nx::Object ::xowiki::Mode ::xowiki::Mode get mode_name set toggle ::xowiki::Mode->::nx::Object

Class ::xowiki::Mode

::xowiki::Mode[i] create ...

Mode handler to set for the current session some application specific mode (like e.g. admin-mode, developer-mode, student-mode, training-mode, ...) Interface: - method get: obtain the current value (maybe default) - method set: force the mode to the provided value - method toggle: toggle current value
Defined in packages/xowiki/tcl/xowiki-mode-procs.tcl

Class Relations

  • class: ::nx::Class[i]
  • superclass: ::nx::Object[i]

Methods (to be applied on instances)

  • get (scripted, public)

     <instance of xowiki::Mode[i]> get

    Get the current mode, which might be set by the user or which might be obtained from the default method.

    Partial Call Graph (max 5 caller/called nodes):
    %3 ad_get_client_property ad_get_client_property (public) ad_set_client_property ad_set_client_property (public) xowiki::Mode instproc get xowiki::Mode instproc get xowiki::Mode instproc get->ad_get_client_property xowiki::Mode instproc get->ad_set_client_property

    Testcases:
    No testcase defined.
  • set (scripted, public)

     <instance of xowiki::Mode[i]> set value

    Set the mode to the specified value

    Parameters:
    value

    Partial Call Graph (max 5 caller/called nodes):
    %3 ad_set_client_property ad_set_client_property (public) xowiki::Mode instproc set xowiki::Mode instproc set xowiki::Mode instproc set->ad_set_client_property

    Testcases:
    No testcase defined.
  • toggle (scripted, public)

     <instance of xowiki::Mode[i]> toggle

    Switch state of the toggle

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.