specs/Simple.xml

   1 <sect1 id="Simple_Widget">
   2 <title>Simple Widget</title>
   3 <!-- .XS -->
   4 <!--    Simple Widget -->
   5 <!-- .XE -->
   6 <!-- .IN "Simple widget" "" "@DEF@" -->
   7 <literallayout class="monospaced">
   8 <!-- .TA 2.0i -->
   9 <!-- .ta 2.0i -->
  10 <!-- .sp -->
  11 Application Header file &lt;Xaw/Simple.h&gt;
  12 <!-- .IN "Simple.h" "" -->
  13 Class Header file       &lt;Xaw/SimpleP.h&gt;
  14 <!-- .IN "SimpleP.h" "" -->
  15 Class           simpleWidgetClass
  16 <!-- .IN "simpleWidgetClass" -->
  17 Class Name      Simple
  18 <!-- .IN "Simple widget" "class name" -->
  19 Superclass      Core
  20 <!-- .sp -->
  21 </literallayout>
  22 <para>
  23 <!-- .LP -->
  24 The Simple widget is not very useful by itself, as it has no semantics
  25 of its own.  It main purpose is to be used as a common superclass for
  26 the other <emphasis remap='I'>simple</emphasis> Athena widgets.  This widget adds six resources
  27 to the resource list provided by the Core widget and its superclasses.
  28 </para>
  29 <sect2 id='Simple::Resources'>
  30 <title>Resources</title>
  31 <para>
  32 <!-- .LP -->
  33 When creating a Simple widget instance, the following resources are
  34 retrieved from the argument list or from the resource database:
  35 </para>
  36 <para>
  37 <!-- .LP -->
  38 <!-- .IN "Simple widget" "resources" -->
  39 <informaltable>
  40   <tgroup cols='5' align='center'>
  41   <colspec colname='c1'/>
  42   <colspec colname='c2'/>
  43   <colspec colname='c3'/>
  44   <colspec colname='c4'/>
  45   <colspec colname='c5'/>
  46   <thead>
  47     <row>
  48       <entry>Name</entry>
  49       <entry>Class</entry>
  50       <entry>Type</entry>
  51       <entry>Notes</entry>
  52       <entry>Default Value</entry>
  53     </row>
  54   </thead>
  55   <tbody>
  56     <row>
  57       <entry>accelerators</entry>
  58       <entry>Accelerators</entry>
  59       <entry>AcceleratorTable</entry>
  60       <entry></entry>
  61       <entry>NULL</entry>
  62     </row>
  63     <row>
  64       <entry>ancestorSensitive</entry>
  65       <entry>AncestorSensitive</entry>
  66       <entry>Boolean</entry>
  67       <entry>D</entry>
  68       <entry>True</entry>
  69     </row>
  70     <row>
  71       <entry>background</entry>
  72       <entry>Background</entry>
  73       <entry>Pixel</entry>
  74       <entry></entry>
  75       <entry>XtDefaultBackground</entry>
  76     </row>
  77     <row>
  78       <entry>backgroundPixmap</entry>
  79       <entry>Pixmap</entry>
  80       <entry>Pixmap</entry>
  81       <entry></entry>
  82       <entry>XtUnspecifiedPixmap</entry>
  83     </row>
  84     <row>
  85       <entry>borderColor</entry>
  86       <entry>BorderColor</entry>
  87       <entry>Pixel</entry>
  88       <entry></entry>
  89       <entry>XtDefaultForeground</entry>
  90     </row>
  91     <row>
  92       <entry>borderPixmap</entry>
  93       <entry>Pixmap</entry>
  94       <entry>Pixmap</entry>
  95       <entry></entry>
  96       <entry>XtUnspecifiedPixmap</entry>
  97     </row>
  98     <row>
  99       <entry>borderWidth</entry>
 100       <entry>BorderWidth</entry>
 101       <entry>Dimension</entry>
 102       <entry></entry>
 103       <entry>1</entry>
 104     </row>
 105     <row>
 106       <entry>colormap</entry>
 107       <entry>Colormap</entry>
 108       <entry>Colormap</entry>
 109       <entry></entry>
 110       <entry>Parent's Colormap</entry>
 111     </row>
 112     <row>
 113       <entry>cursor</entry>
 114       <entry>Cursor</entry>
 115       <entry>Cursor</entry>
 116       <entry></entry>
 117       <entry>None</entry>
 118     </row>
 119     <row>
 120       <entry>cursorName</entry>
 121       <entry>Cursor</entry>
 122       <entry>String</entry>
 123       <entry></entry>
 124       <entry>NULL</entry>
 125     </row>
 126     <row>
 127       <entry>depth</entry>
 128       <entry>Depth</entry>
 129       <entry>int</entry>
 130       <entry>C</entry>
 131       <entry>Parent's Depth</entry>
 132     </row>
 133     <row>
 134       <entry>destroyCallback</entry>
 135       <entry>Callback</entry>
 136       <entry>XtCallbackList</entry>
 137       <entry></entry>
 138       <entry>NULL</entry>
 139     </row>
 140     <row>
 141       <entry>height</entry>
 142       <entry>Height</entry>
 143       <entry>Dimension</entry>
 144       <entry></entry>
 145       <entry>0</entry>
 146     </row>
 147     <row>
 148       <entry>insensitiveBorder</entry>
 149       <entry>Insensitive</entry>
 150       <entry>Pixmap</entry>
 151       <entry></entry>
 152       <entry>GreyPixmap</entry>
 153     </row>
 154     <row>
 155       <entry>international</entry>
 156       <entry>International</entry>
 157       <entry>Boolean</entry>
 158       <entry>C</entry>
 159       <entry>False</entry>
 160     </row>
 161     <row>
 162       <entry>mappedWhenManaged</entry>
 163       <entry>MappedWhenManaged</entry>
 164       <entry>Boolean</entry>
 165       <entry></entry>
 166       <entry>True</entry>
 167     </row>
 168     <row>
 169       <entry>pointerColor</entry>
 170       <entry>Foreground</entry>
 171       <entry>Pixel</entry>
 172       <entry></entry>
 173       <entry>XtDefaultForeground</entry>
 174     </row>
 175     <row>
 176       <entry>pointerColorBackground</entry>
 177       <entry>Background</entry>
 178       <entry>Pixel</entry>
 179       <entry></entry>
 180       <entry>XtDefaultBackground</entry>
 181     </row>
 182     <row>
 183       <entry>screen</entry>
 184       <entry>Screen</entry>
 185       <entry>Screen</entry>
 186       <entry>R</entry>
 187       <entry>Parent's Screen</entry>
 188     </row>
 189     <row>
 190       <entry>sensitive</entry>
 191       <entry>Sensitive</entry>
 192       <entry>Boolean</entry>
 193       <entry></entry>
 194       <entry>True</entry>
 195     </row>
 196     <row>
 197       <entry>translations</entry>
 198       <entry>Translations</entry>
 199       <entry>TranslationTable</entry>
 200       <entry></entry>
 201       <entry>NULL</entry>
 202     </row>
 203     <row>
 204       <entry>width</entry>
 205       <entry>Width</entry>
 206       <entry>Dimension</entry>
 207       <entry></entry>
 208       <entry>0</entry>
 209     </row>
 210     <row>
 211       <entry>x</entry>
 212       <entry>Position</entry>
 213       <entry>Position</entry>
 214       <entry></entry>
 215       <entry>0</entry>
 216     </row>
 217     <row>
 218       <entry>y</entry>
 219       <entry>Position</entry>
 220       <entry>Position</entry>
 221       <entry></entry>
 222       <entry>0</entry>
 223     </row>
 224   </tbody>
 225   </tgroup>
 226 </informaltable>
 227 <!-- .Ac -->
 228 <!-- .As -->
 229 <!-- .Bg -->
 230 <!-- .Gp -->
 231 <!-- .Bc -->
 232 <!-- .Bp -->
 233 <!-- .Bw -->
 234 <!-- .Cm -->
 235 <!-- .Cu Bold -->
 236 <!-- .Cn Bold -->
 237 <!-- .Dp -->
 238 <!-- .Dc -->
 239 <!-- .Hw -->
 240 <!-- .Ib Bold -->
 241 <!-- .Ix Bold -->
 242 <!-- .Mm -->
 243 <!-- .Pf Bold -->
 244 <!-- .Pb Bold -->
 245 <!-- .Sc -->
 246 <!-- .Se -->
 247 <!-- .Tr -->
 248 <!-- .Xy -->
 249
 250 </para>
 251 </sect2>
 252 </sect1>