home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / X / mit / doc / Xaw / SmeBSB < prev    next >
Encoding:
Text File  |  1989-12-21  |  3.8 KB  |  124 lines
  1. .NH 2
  2. SmeBSB Object
  3. .LP
  4. .XS
  5.     SmeBSB Object
  6. .XE
  7. .IN "SmeBSB object" "" "@DEF@"
  8. .Ds 0
  9. .TA 2.0i
  10. .ta 2.0i
  11. .sp
  12. Application Header file    <X11/Xaw/SmeBSB.h>
  13. .IN "SmeBSB.h" ""
  14. Class Header file    <X11/Xaw/SmeBSBP.h>
  15. .IN "SmeBSBP.h" ""
  16. Class        smeBSBObjectClass
  17. .IN "smeBSBObjectClass" ""
  18. Class Name    SmeBSB
  19. .IN "SmeBSB object" "class name"
  20. Superclass    Sme
  21. .sp
  22. .De
  23. .LP
  24. The SmeBSB object is used to create a menu entry that contains a string,
  25. and optional bitmaps in its left and right margins.  Since each menu
  26. entry is an independent object, the application is able to change the
  27. font, color, height, and other attributes of the menu entries, on an
  28. entry by entry basis.
  29. .NH 3
  30. Resources
  31. .IN "SmeBSB object" "resources"
  32. .LP
  33. The resources associated with the SmeBSB object are defined in this section,
  34. and affect only the single menu entry specified by this object.
  35. .ps 9
  36. .nr PS 9
  37. .vs 11
  38. .nr VS 11
  39. .TS H
  40. lw(1i) lw(1i) lw(1i) lw(.5i) lw(2i).
  41. _
  42. .sp 3p
  43. .TB
  44. Name    Class    Type    Notes    Default Value
  45. .sp 3p
  46. _
  47. .TH
  48. .R
  49. .sp 3p
  50. ancestorSensitive    AncestorSensitive    Boolean    D    True
  51. callback    Callback    Callback        NULL
  52. destroyCallback    Callback    XtCallbackList        NULL
  53. font    Font    FontStruct        XtDefaultFont
  54. foreground    Foreground    Pixel        XtDefaultForeground
  55. height    Height    Dimension    A    Font height + \fBvertSpace\fP
  56. justify    Justify    Justify        XtjustifyLeft
  57. label    Label    String        NULL
  58. leftBitmap    LeftBitmap    Pixmap        XtUnspecifiedPixmap
  59. leftMargin    leftMargin    Dimension        4
  60. rightBitmap    RightBitmap    Pixmap        XtUnspecifiedPixmap
  61. rightMargin    rightMargin    Dimension        4
  62. sensitive    Sensitive    Boolean        True
  63. vertSpace    VertSpace    int        25
  64. width    Width    Dimension    A    TextWidth + margins
  65. .sp 3p
  66. _
  67. .TE
  68. .ps 11
  69. .nr PS 11
  70. .vs 13
  71. .nr VS 13
  72. .As
  73. .IP \fBcallback\fP 1.5i
  74. All callback functions on this list are called when the SimpleMenu
  75. \fInotifies\fP this entry that the user has selected it.
  76. .Dc
  77. .IP \fBfont\fP 1.5i
  78. The font used to display the text label.
  79. .IP \fBforeground\fP 1.5i
  80. A pixel value which indexes the SimpleMenu's colormap to derive the
  81. foreground color of the menu entry's window.  This color is also 
  82. used to render all 1's in the left and right \fBbitmaps\fP.
  83. .Hw
  84. Keep in mind that the SimpleMenu widget will force the width of all
  85. menu entries to be the width of the longest entry.
  86. .IP \fBjustify\fP 1.5i
  87. How the label is to be rendered between the left and right margins when
  88. the space is wider than the actual text.  This resource may be
  89. specified with the values \fBXtJustifyLeft\fP, \fBXtJustifyCenter\fP,
  90. or \fBXtJustifyRight\fP.  When specifying the justification from a
  91. resource file the values \fBleft\fP, \fBcenter\fP, or \fBright\fP may be
  92. used.
  93. .IP \fBlabel\fP 1.5i
  94. This is a the string that will be displayed in the menu entry.  The
  95. exact location of this string within the bounds of the menu entry is
  96. controlled by the \fBleftMargin\fP, \fBrightMargin\fP, \fBvertSpace\fP,
  97. and \fBjustify\fP resources.
  98. .IP \fBleftBitmap\fP 1.5i
  99. .br
  100. .ns
  101. .IP \fBrightBitmap\fP 1.5i
  102. This is a name of a bitmap to display in the left or right margin of the
  103. menu entry.  All 1's in the bitmap will be rendered in the foreground
  104. color, and all 0's will be drawn in the background color of the
  105. SimpleMenu widget.  It is the
  106. programmers responsibility to make sure that the menu entry is tall
  107. enough, and the appropriate margin wide enough to accept the bitmap.
  108. If care is not taken the bitmap may extend into another menu entry, or
  109. into this entry's label.
  110. .IP \fBleftMargin\fP 1.5i
  111. .br
  112. .ns
  113. .IP \fBrightMargin\fP 1.5i
  114. This is the amount of space (in pixels) that will be left between the
  115. edge of the menu entry and the label string.
  116. .Se
  117. .IP \fBvertSpace\fP 1.5i
  118. This is the amount of vertical padding, expressed as a percentage of
  119. the height of the font, that is to be placed around the label of a
  120. menu entry.. The label and bitmaps are always centered vertically
  121. within the menu.  The default value for this
  122. resource (25) causes the default height to be 125% of the height of the
  123. font.
  124.