Alterator/form

Материал из ALT Linux Wiki

Модуль (alterator lookout form)

В этом модуле сделана попытка упростить работу со стандартными диалогами, практически убрав необходимость адресовать виджеты с помощью document:id. Описание относится к alterator-lookout-1.3-alt7

Пусть интересующие нас поля ввода (и подписи к ним) имеют атрибуты "name", значение которых совпадает с названиями соответствующих параметров при общении с бакендом. В этом случае можно использовать следующие функции:

  • (form-get-elements-by-name name) -- получить список виджетов с указанным именем.
  • (form-get-label-by-name name) -- получить первый виджет типа "label" с указанным именем.
  • (form-read url . args-n-names) -- прочитать из бакенда (action read) указанные параметры и заполнить соответствующие поля
  • (form-write url . args-n-names) -- отправить в бакенд (action write) значения полей с указанными именами
  • (form-get name) -- получить значение поля с именем name
  • (form-set! name val) -- записать значение в поле с именем name
  • (form-apply name . args) -- применить args ко всем элементам с именем name и вернуть список результатов.

Кроме того, в /std/base определены обертки, перехватывающие исключения при общении с бакендом и выводящие окно предупреждения.

  • (form-read/message url . args-n-names)
  • (form-write/message url . args-n-names)

Аргументы args-n-names функций form-read/write обрабатываются довольно хитрым способом. Если первый аргумент -- список, то это -- параметры, передаваемые бакенду. Все остальные аргументы -- имена виджетов, значения которых надо читать или заполнять. Если имена виджетов не указаны - заполняются все виджеты.

То есть можно писать, например, так:

  • (form-read "/url") -- Чтение информации из бакенда, заполнение всех элементов формы
  • (form-read "/url" '(par1 "val1")) -- то же, но бакенду передается параметр par1=val1
  • (form-read "/url" "name1" "name2" "name3")
  • (form-read "/url" '(par1 "val1") "name1" "name2" "name3") -- то же, но заполняются только указанные поля

Пример использования

Было:

(document:surround "/std/base")
 
(define (write-to-backend) 
  (catch/message (lambda() 
    (woo-write "/test" 
      'par1 (mypar1-id value) 
      'par2 (mypar2-id value) 
      'par3 (mypar3-id value) 
      'par4 (mypar4-id value) )))) 
 
(define (read-from-backend) 
  (catch/message (lambda() 
    (let ((data (woo-read-first "/test"))) 
      (mypar1-id value (woo-get-option data 'par1)) 
      (mypar2-id value (woo-get-option data 'par2)) 
      (mypar3-id value (woo-get-option data 'par3)) 
      (mypar4-id value (woo-get-option data 'par4)) )))) 

(gridbox columns "0;100"
  (spacer)
  (document:id mypar1-id (checkbox text (_ "my parameter - 1")))

  (label text (_ "my parameter - 2:") align "right")
  (document:id mypar2-id (edit))

  (label text (_ "m.p. - 3:") align "right")
  (document:id mypar3-id (edit))

  (label text (_ "m.p. - 4:") align "right")
  (document:id mypar4-id (combobox enumref "/test/par4values"))

  (spacer)
  (gridbox columns "0;100"
    (button text (_ "Apply") (when clicked (write-to-backend)))
    (button text (_ "Reset") (when clicked (read-from-backend))) )
)

(document:root (when loaded (read-from-backend)))

Стало:

(document:surround "/std/base")

(define (write-to-backend) (form-write/message "/test" "par1" "par2" "par3" "par4")) 
      
(define (read-from-backend) (form-read/message "/test" "par1" "par2" "par3" "par4"))

(gridbox columns "0;100"
  (spacer)
  (checkbox text (_ "my parameter - 1") name "par1"))

  (label text (_ "my parameter - 2:") align "right")
  (edit name "par2")

  (label text (_ "m.p. - 3:") align "right")
  (edit name "par3")

  (label text (_ "m.p. - 4:") align "right")
  (combobox enumref "/test/par4values" name "par4")

  (spacer)
  (gridbox columns "0;100"
    (button text (_ "Apply") (when clicked (write-to-backend)))
    (button text (_ "Reset") (when clicked (read-from-backend))) )
)

(document:root (when loaded (read-from-backend)))


Неочевидное

  • form-read заполняет только интерактивные элементы формы. Если хочется заполнить label - приходится, например, делать скрытый виджет типа edit, заполнять его, а затем вручную переносить значение:
(label name "lable-name")
(edit name "label"
...
(form-read "/url" ... "label")
(form-apply "label-name" (form-get "label")
  • поля ищутся в документе, который определяется ячейкой (cell) form:document. В /std/base ячейка устанавливается на document:root. Непонятно, можно ли использовать это для чего-то полезного (по отдельности работать с двумя формами в одном документе, например).

TODO

  • Включить в модуль и в это описание работу с эффектами?