lib/layouts/pdfform.module

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