lib/layouts/pdfform.module

   1 #\DeclareLyXModule{PDF Form}
   2 #DescriptionBegin
   3 #Provides fields and buttons for PDF forms. The module uses
   4 #the LaTeX package hyperref. Please consult the LyX example file PDF-form.lyx
   5 #and the documentation of hyperref for details.
   6 #DescriptionEnd
   7 # Author: Uwe Stöhr <uwestoehr@lyx.org>
   8
   9 Format 54
  10
  11 #
  12 # the form environment
  13 #
  14
  15 Style "Begin PDF Form"
  16         Margin                          Dynamic
  17         LatexType                       Command
  18         LatexName                       begin{Form}
  19         Category                        "PDF form"
  20         KeepEmpty                       1
  21         ParSkip                         0.4
  22         Align                           Block
  23         LabelSep                        xx
  24         LabelType                       Static
  25         LabelString                     "Begin PDF Form"
  26         Argument 1
  27                 MenuString              "PDF form parameters"
  28                 LabelString             "Params"
  29                 Tooltip                 "Insert PDF form parameters here"
  30         EndArgument
  31         LabelFont
  32           Series                        Bold
  33           Color                         Green
  34         EndFont
  35         Requires            hyperref
  36 End
  37
  38 Style "End PDF Form"
  39         CopyStyle                       "Begin PDF Form"
  40         LatexName                       end{Form}
  41         LabelString                     "End PDF Form"
  42 End
  43
  44 #
  45 # form fields
  46 #
  47
  48 InsetLayout Flex:TextField
  49         LyXType                         custom
  50         LatexType                       command
  51         Decoration                      classic
  52         LatexName                       TextField
  53         LabelString                     "TextField"
  54         Argument 1
  55                 MenuString              "PDF form parameters"
  56                 LabelString             "Params"
  57                 Tooltip                 "Insert PDF form parameters here"
  58         EndArgument
  59         PassThru                        1
  60         LabelFont
  61           Color                         magenta
  62           Size                          Small
  63         EndFont
  64         Requires            hyperref
  65 End
  66
  67 InsetLayout Flex:CheckBox
  68         CopyStyle                       Flex:TextField
  69         LatexName                       CheckBox
  70         LabelString                     "CheckBox"
  71 End
  72
  73 InsetLayout Flex:ChoiceMenu
  74         CopyStyle                       Flex:TextField
  75         LatexName                       ChoiceMenu
  76         LabelString                     "ChoiceMenu"
  77         Argument 2
  78                 LabelString             "Label"
  79                 Mandatory               1
  80                 AutoInsert              1
  81                 ToolTip                 "Insert the label here"
  82         EndArgument
  83 End
  84
  85 InsetLayout Flex:PushButton
  86         CopyStyle                       Flex:TextField
  87         LatexName                       PushButton
  88         LabelString                     "PushButton"
  89 End
  90
  91 InsetLayout Flex:SubmitButton
  92         CopyStyle                       Flex:TextField
  93         LatexName                       Submit
  94         LabelString                     "SubmitButton"
  95 End
  96
  97 InsetLayout Flex:ResetButton
  98         CopyStyle                       Flex:TextField
  99         LatexName                       Reset
 100         LabelString                     "ResetButton"
 101 End
 102
 103 #
 104 # PDF viewer-specific insets
 105 #
 106
 107 InsetLayout Flex:PDFAction
 108         CopyStyle                       Flex:TextField
 109         LatexName                       Acrobatmenu
 110         LabelString                     "PDFAction"
 111         Argument 1
 112                 LabelString             "Action"
 113                 Mandatory               1
 114                 AutoInsert              1
 115                 ToolTip                 "the name of the PDF action"
 116         EndArgument
 117 End
 118
 119 #
 120 # Form style layouts
 121 #
 122
 123 Style "Text Field Style"
 124         CopyStyle                       "Begin PDF Form"
 125         LatexName                       renewcommand*{\DefaultOptionsofText}
 126         LabelString                     "Default text field style"
 127         PassThru                        1
 128 End
 129
 130 Style "Submit Button Style"
 131         CopyStyle                       "Text Field Style"
 132         LatexName                       renewcommand*{\DefaultOptionsofSubmit}
 133         LabelString                     "Default submit button style"
 134 End
 135
 136 Style "Push Button Style"
 137         CopyStyle                       "Text Field Style"
 138         LatexName                       renewcommand*{\DefaultOptionsofPushButton}
 139         LabelString                     "Default push button style"
 140 End
 141
 142 Style "Check Box Style"
 143         CopyStyle                       "Text Field Style"
 144         LatexName                       renewcommand*{\DefaultOptionsofCheckBox}
 145         LabelString                     "Default check box style"
 146 End
 147
 148 Style "Reset Button Style"
 149         CopyStyle                       "Text Field Style"
 150         LatexName                       renewcommand*{\DefaultOptionsofReset}
 151         LabelString                     "Default reset button style"
 152 End
 153
 154 Style "List Box Style"
 155         CopyStyle                       "Text Field Style"
 156         LatexName                       renewcommand*{\DefaultOptionsofListBox}
 157         LabelString                     "Default list box style"
 158 End
 159
 160 Style "Combo Box Style"
 161         CopyStyle                       "Text Field Style"
 162         LatexName                       renewcommand*{\DefaultOptionsofComboBox}
 163         LabelString                     "Default combo box style"
 164 End
 165
 166 Style "Popdown Box Style"
 167         CopyStyle                       "Text Field Style"
 168         LatexName                       renewcommand*{\DefaultOptionsofPopdownBox}
 169         LabelString                     "Default popdown box style"
 170 End
 171
 172 Style "Radio Box Style"
 173         CopyStyle                       "Text Field Style"
 174         LatexName                       renewcommand*{\DefaultOptionsofRadio}
 175         LabelString                     "Default radio box style"
 176 End