home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / X / mit / doc / Xaw / Porthole < prev    next >
Encoding:
Text File  |  1991-07-29  |  3.1 KB  |  132 lines
  1. .NH 2
  2. Porthole Widget
  3. .LP
  4. .XS
  5.     Porthole Widget
  6. .XE
  7. .IN "Porthole widget" "" "@DEF@"
  8. .Ds 0
  9. .TA 2.0i
  10. .ta 2.0i
  11. .sp
  12. Application Header file    <X11/Xaw/Porthole.h>
  13. .IN "Porthole.h" ""
  14. Class Header file    <X11/Xaw/PortholeP.h>
  15. .IN "PortholeP.h" ""
  16. Class        portholeWidgetClass
  17. .IN "portholeWidgetClass" ""
  18. Class Name    Porthole
  19. .IN "Porthole widget" "class name"
  20. Superclass    Composite
  21. .sp
  22. .De
  23. .LP
  24. The Porthole widget provides geometry management of a list of arbitrary
  25. widgets, only one of which may be managed at any particular time.
  26. The managed child widget is reparented within the porthole and is moved around
  27. by the application (typically under the control of a Panner widget).
  28. .NH 3
  29. Resources
  30. .LP
  31. When creating a Porthole widget instance, the following resources are
  32. retrieved from the argument list or from the resource database:
  33. .LP
  34. .IN "Porthole widget" "resources"
  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. accelerators    Accelerators    AcceleratorTable        NULL
  51. ancestorSensitive    AncestorSensitive    Boolean    D    True
  52. background    Background    Pixel        XtDefaultBackground
  53. backgroundPixmap    Pixmap    Pixmap        XtUnspecifiedPixmap
  54. borderColor    BorderColor    Pixel        XtDefaultForeground
  55. borderPixmap    Pixmap    Pixmap        XtUnspecifiedPixmap
  56. borderWidth    BorderWidth    Dimension        1
  57. children    ReadOnly    WidgetList    R    NULL
  58. colormap    Colormap    Colormap        Parent's Colormap
  59. depth    Depth    int    C    Parent's Depth
  60. destroyCallback    Callback    XtCallbackList        NULL
  61. height    Height    Dimension    A    see \fBLayout Semantics\fP
  62. mappedWhenManaged    MappedWhenManaged    Boolean        True
  63. numChildren    ReadOnly    Cardinal    R    0
  64. reportCallback    ReportCallback    Callback        NULL
  65. screen    Screen    Screen    R    Parent's Screen
  66. sensitive    Sensitive    Boolean        True
  67. translations    Translations    TranslationTable        NULL
  68. width    Width    Dimension    A    see \fBLayout Semantics\fP
  69. x    Position    Position        0
  70. y    Position    Position        0
  71. .sp 3p
  72. _
  73. .TE
  74. .ps 11
  75. .nr PS 11
  76. .vs 13
  77. .nr VS 13
  78. .Ac
  79. .As
  80. .Bg
  81. .Gp
  82. .Bc
  83. .Bp
  84. .Bw
  85. .Ch
  86. .Cm
  87. .Dp
  88. .Dc
  89. .Hw
  90. .Mm
  91. .Nc
  92. .IP \fBreportCallback\fP 1.5i
  93. A list of functions to invoke whenever the managed child widget changes 
  94. size or position.
  95. .Sc
  96. .Se
  97. .Tr
  98. .Xy
  99. .NH 3
  100. Layout Semantics
  101. .IN "Porthole widget" "layout semantics"
  102. .LP
  103. The Porthole widget allows its managed child to request any size
  104. that is as large
  105. or larger than the Porthole itself and any location so long as the child
  106. still obscures all of the Porthole.  This widget typically is used with a
  107. Panner widget.
  108. .NH 3
  109. Porthole Callbacks
  110. .IN "Porthole widget" "callbacks"
  111. .LP
  112. The functions registered on the \fBreportCallback\fP list are invoked whenever
  113. the managed child changes size or position:
  114. .IN "ReportProc" "" "@DEF@"
  115. .FD 0
  116. void ReportProc(\fIporthole\fP, \fIclient_data\fP, \fIreport\fP)
  117. .br
  118.     Widget \fIporthole\fP;
  119. .br
  120.     XtPointer \fIclient_data\fP;
  121. .br
  122.     XtPointer \fIreport\fP;    /* (XawPannerReport *) */
  123. .FN
  124. .IP \fIporthole\fP 1i
  125. Specifies the Porthole widget.
  126. .IP \fIclient_data\fP 1i
  127. Specifies the client data.
  128. .IP \fIreport\fP 1i
  129. Specifies a pointer to an \fBXawPannerReport\fP structure containing
  130. the location and size of the slider and the size of the canvas.
  131.  
  132.