"

 COPYRIGHT (c) 1989 by Claus Gittinger

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libview' }"

"{ NameSpace: Smalltalk }"

DisplaySurface subclass:#SimpleView

	instanceVariableNames:'superView subViews components styleSheet resources border unused

		viewShape top left flagBits relativeOrigin relativeExtent

		relativeCorner originRule extentRule cornerRule insets layout

		shown hiddenOnRealize name level margin innerClipRect shadowColor

		lightColor bitGravity viewGravity controller windowGroup

		preferredExtent explicitExtent dependents layoutManager

		visibilityChannel helpKey dropTarget'

	classVariableNames:'CentPoint DefaultBorderColor DefaultBorderWidth

		DefaultFocusBorderWidth DefaultFocusColor DefaultLightColor

		DefaultShadowColor DefaultStyle DefaultViewBackgroundColor

		FlagBeingDestroyed FlagCanTab FlagCornerChanged

		FlagDoNotRequestFocusOnPointerEnter FlagExtentChanged

		FlagExtentChangedBeforeCreated FlagHasExplicitExtent

		FlagHiddenOnRealize FlagIsMDIChild FlagIsUnmappedModalBox

		FlagNativeWidget FlagOriginChanged FlagRequestFocusOnPointerEnter

		FlagTakeFocusWhenMapped Grey ReturnFocusWhenClosingModalBoxes

		StyleSheet ViewSpacing'

	poolDictionaries:''

	category:'Views-Basic'

!

SimpleView class instanceVariableNames:'ClassResources DefaultFont'

"

 No other class instance variables are inherited by this class.

"

!

ProceedingNotification subclass:#AboutToOpenBoxNotificationSignal

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:SimpleView

!

Object subclass:#ViewShape

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:SimpleView

!

ProceedingNotification subclass:#BoxClosedNotificationSignal

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:SimpleView

!

SimpleView::ViewShape subclass:#RoundViewShape

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:SimpleView

!

SimpleView::ViewShape subclass:#ArbitraryViewShape

	instanceVariableNames:'viewShapeForm borderShapeForm'

	classVariableNames:''

	poolDictionaries:''

	privateIn:SimpleView

!

!SimpleView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 by Claus Gittinger

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    this class implements functions common to all Views which do not work on / show a model.

    Previously, all of this functionality used to be in the old View class, but has been

    separated into this new SimpleView (which does not know about models) and the new View,

    which does so.

    I'd prefer to call this class View and the current View class a ModelView,

    but for backward compatibility it is better to leave things the way they are

    (there are simply too many subclasses of View around...).

    Instances of SimpleView are seldom used directly, most views in the system inherit

    from this class. However, sometimes a view is needed to create a dummy view for framing

    or layout purposes.

    [Instance variables:]

        superView               <View>                  my superview i.e. the view I am in

        subViews                <Collection>            the collection of subviews

                                                        These are the views proper.

        components              <Collection>            collection of gadgets (will be merged with subViews, soon)

                                                        These are lightweight gadgets (not seen by windows/x11).

        styleSheet              <ResourcePack>          contains widget attributes (see libview/styles/*.style)

        resources               <ResourcePack>          contains national language translations (see lib*/resources/*.rs)

        border                  <Border>                color and width of border

        unused                  <nil>                   to keep the instVar size constant

        viewShape               <Form>                  shape of view & border (if device supports it)

        top                     <Number>                actual top coordinate (pixels) in superview

        left                    <Number>                actual left coordinate (pixels) in superview

        flagBits                <Integer>               flag bits (used to be individual booleans)

            extendChanged                                   true if extend changed during setup

            originChanged                                   true if origin changed during setup

        relativeOrigin          <Number>                relative origin in percent within superview

        relativeExtent          <Number>                relative extent in percent within superview

        relativeCorner          <Number>                relative corner in percent within superview

        originRule              <Block>                 rule to compute origin if superview changes size

        extentRule              <Block>                 rule to compute extent if superview changes size

        cornerRule              <Block>                 rule to compute corner if superview changes size

        insets                  <Array>                 array with top, left, bottom & right insets (or nil)

        layout                  <LayoutObject>          not yet implemented - will replace the above layout

                                                        variables.

        shown                   <Boolean>               true if visible (false if iconified, unmapped or covered)

        hiddenOnRealize         <Boolean>               dont show automatically when superview is realized

        name                    <String>                my name (future use for resources)

        level (**)              <Number>                3D level relative to superview

        margin                  <Number>                convenient margin; that is the number of pixels

                                                        which are taken up by border plus 3D level

                                                        (i.e. borderWidth + level abs)

        innerClipRect           <Rectangle>             convenient inner clip (minus margin)

        shadowColor (**)        <Color>                 color used to draw 3D shadowed edges

        lightColor (**)         <Color>                 color used to draw 3D lighted edges

        bitGravity              <nil | Symbol>          gravity of contents (if device supports it)

        viewGravity             <nil | Symbol>          gravity of view (if device supports it)

        controller              <nil | Controller>      the controller (if any)

        windowGroup             <WindowGroup>           the windowGroup

        preferredExtent(*)      <nil | Point>           preferredExtent overWrite

                                                        if nonNil, the widget will not compute

                                                        its pref-extent, but use that value.

        explicitExtent(*)       <nil | Point>           preferredExtent overWrite

                                                        if nonNil, the widget will not compute

                                                        its pref-extent, but use that value.

        dependents              <nil | Collection>      who depends on me

        layoutManager

        visibilityChannel

        helpKey

        dropTarget

    (*) about to be changed to use preferredExtent as a cache and explicitExtent as

        an overwrite value.

    (**) We have recently started to change the system to use borders instead of separate

         borderWidth, borderColor, level, shadow- and lightColors.

         Expect more changes here in the near future..

    [Class variables:]

        Grey                    <Color>                 the color grey - its used so often

        ViewSpacing             <Number>                preferred spacing between views; 1mm

        CentPoint               <Point>                 100 @ 100 - its used so often

        StyleSheet              <ResourcePack>          contains all view-style specifics

        ReturnFocusWhenClosingModalBoxes                if true, a closing modalBox returns

                                <Boolean>               the keyboard focus to the view which was

                                                        active when the box was opened.

                                                        If false (the default), it is left to

                                                        window manager to assign a new focus.

                                                        If running on olwm/olvwm (which requires an

                                                        explicit click to reassign a focus), it is

                                                        better to turn this on in a private.rc file.

    [styleSheet parameters:]

        popupShadow             <Boolean>               if true, popupViews show a shadow below

        popupLevel              <nil | Integer>         3D level

        borderWidth             <nil | Integer>         borderWidth (ignored in 3D styles)

        borderColor             <nil | Color>           borderColor (ignored in 3D styles)

        viewBackground          <nil | Color>           views background

        shadowColor             <nil | Color>           color for shadow edges (ignored in 2D styles)

        lightColor              <nil | Color>           color for light edges (ignored in 2D styles)

        font                    <nil | Font>            font to use

    TODO:

        get rid of relativeOrigin, relativeCorner, originRule, extentRule,

        and insets; replace by a single object which defines the size

        (mhmh - ST-80 seems to call this LayoutFrame ?)

        -> be prepared for a change here in the near future and ONLY use

           access methods to get those instance variables' values

        get rid of 3D level & margin, move it to extra wrappers

        (although this will make view setup more complicated, it will remove

         complexity from the internals of view. Also, it will allow for more

         varieties of borders.)

        add components (could also call them gadgets or lightweight views)

        - views are expensive in terms of X resources. This would make all

        framing/edge and panel helper views become cheap ST objects, instead

        of views.

    [see also:]

        StandardSystemView DialogBox

        WindowGroup WindowEvent

        Layout

        ( introduction to view programming :html: programming/viewintro.html )

    [author:]

        Claus Gittinger

"

!

examples

"

    (all examples below use different viewBackgrounds,

     to make the individual subviews visible)

    a subView in a topView:

                                                                        [exBegin]

        |top v|

        top := StandardSystemView new.

        v := View new.

        v origin:0.25 @ 0.25 corner:0.75 @ 0.75.

        top addSubView:v.

        top open

                                                                        [exEnd]

    the same, a bit more compact:

                                                                        [exBegin]

        |top v|

        top := StandardSystemView new.

        v := View origin:0.25 @ 0.25 corner:0.75 @ 0.75 in:top.

        top open

                                                                        [exEnd]

    fixed position/size:

                                                                        [exBegin]

       |top v1 v2|

       top := StandardSystemView new.

       top extent:300@300.

       v1 := View origin:10@10

                  corner:50@50

                      in:top.

       v2 := View origin:60@10

                  corner:150@100

                      in:top.

       v1 viewBackground:(Color red).

       v2 viewBackground:(Color yellow).

       top open

                                                                        [exEnd]

    same, using ST-80 way of bulding up view hierarchies

    (recommended, if you plan to port applications later)

                                                                        [exBegin]

       |top v1 v2|

       top := StandardSystemView new.

       top extent:300@300.

       v1 := View new.

       v1 origin:10@10 corner:50@50.

       v2 := View new.

       v2 origin:60@10 corner:150@100.

       v1 viewBackground:(Color red).

       v2 viewBackground:(Color yellow).

       top add:v1.

       top add:v2.

       v1 viewBackground:(Color red).

       v2 viewBackground:(Color yellow).

       top open

                                                                        [exEnd]

    fixed origin, variable size:

                                                                        [exBegin]

       |top v1 v2|

       top := StandardSystemView new.

       top extent:300@300.

       v1 := View new.

       v1 origin:10@10 corner:50@0.5.

       v2 := View new.

       v2 origin:60@10 corner:150@0.5.

       v1 viewBackground:(Color red).

       v2 viewBackground:(Color yellow).

       top add:v1.

       top add:v2.

       top open

                                                                        [exEnd]

    fixed origin, variable size,

    bottomInset for constant distance from bottom:

                                                                        [exBegin]

       |top v1 v2|

       top := StandardSystemView new.

       top extent:300@300.

       v1 := View new.

       v1 origin:10@10 corner:50@1.0.

       v1 bottomInset:10.

       v2 := View new.

       v2 origin:60@10 corner:150@1.0.

       v2 bottomInset:10.

       v1 viewBackground:(Color red).

       v2 viewBackground:(Color yellow).

       top add:v1.

       top add:v2.

       top open

                                                                        [exEnd]

    variable origin, variable size,

                                                                        [exBegin]

       |top v1 v2|

       top := StandardSystemView new.

       top extent:300@300.

       v1 := View new.

       v1 origin:0.0@0.0 corner:0.5@0.5.

       v2 := View new.

       v2 origin:0.5@0.0 corner:1.0@0.5.

       v1 viewBackground:(Color red).

       v2 viewBackground:(Color yellow).

       top add:v1.

       top add:v2.

       top open

                                                                        [exEnd]

    variable origin, variable size,

    insets for some constant distance

                                                                        [exBegin]

       |top v1 v2|

       top := StandardSystemView new.

       top extent:300@300.

       v1 := View new.

       v1 origin:0.0@0.0 corner:0.5@0.5.

       v1 rightInset:5.

       v2 := View new.

       v2 origin:0.5@0.0 corner:1.0@0.5.

       v2 leftInset:5.

       v1 viewBackground:(Color red).

       v2 viewBackground:(Color yellow).

       top add:v1.

       top add:v2.

       top open

                                                                        [exEnd]

    using layout objects (ST-80 style):

    fully specifying the frame

                                                                        [exBegin]

       |top v1 v2|

       top := StandardSystemView new.

       top extent:300@300.

       v1 := View new.

       v2 := View new.

       v1 viewBackground:(Color red).

       v2 viewBackground:(Color yellow).

       top add:v1 in:(LayoutFrame new

                        leftFraction:0.25;

                        rightFraction:0.75;

                        topFraction:0.0;

                        bottomFraction:0.5).

       top add:v2 in:(LayoutFrame new

                        leftFraction:0.5;

                        rightFraction:1.0;

                        topFraction:0.5;

                        bottomFraction:0.75).

       top open

                                                                        [exEnd]

    another one, with offsets:

                                                                        [exBegin]

       |top v1 v2|

       top := StandardSystemView new.

       top extent:300@300.

       v1 := View new.

       v2 := View new.

       v1 viewBackground:(Color red).

       v2 viewBackground:(Color yellow).

       top add:v1 in:(LayoutFrame new

                        leftFraction:0.0 offset:10;

                        rightFraction:1.0 offset:-10;

                        topFraction:0.0 offset:10;

                        bottomFraction:0.5).

       top add:v2 in:(LayoutFrame new

                        leftFraction:0.0 offset:30;

                        rightFraction:1.0 offset:-30;