"

 COPYRIGHT (c) 1989 by Claus Gittinger

 COPYRIGHT (c) 2015 Jan Vrany

 COPYRIGHT (c) 2017 Jan Vrany

	      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 }"

TopView subclass:#StandardSystemView

	instanceVariableNames:'label icon iconView iconLabel minExtent maxExtent sizeFixed

		application windowEventsForApplication deviceIcon labelChannel'

	classVariableNames:'DefaultExtent DefaultIcon DefaultMinExtent IncludeHostNameInLabel

		TimedRaiseAction WindowLabelFormat'

	poolDictionaries:''

	category:'Views-Basic'

!

!StandardSystemView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 by Claus Gittinger

 COPYRIGHT (c) 2015 Jan Vrany

 COPYRIGHT (c) 2017 Jan Vrany

	      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

"

    I represent standard application topViews

    i.e. those views which have a title-label, an icon etc.

    The name `StandardSystemView' is probably misleading and

    results from ST-80 (rel2.x) compatibility reasons.

    Think of it as an ApplicationWindow.

    In ST/X, StandardSystemViews were subclassed for special views

    in the past (for example: FileBrowser, ChangesBrowser etc.).

    Although this worked, it may lead to the following

    problems and inconveniences:

        - applications inherit a big number of methods through the

          SimpleView->View->TopView->StandardSystemView hierarchy.

          There is quite a danger that by accident, some method gets

          redefined which is required by one of those classes.

          (typical candidates are: terminate, destroy, open ...)

          This may lead to strange effects, which may not be obvious to

          non experts ...

        - applications with multiple topViews are difficult to implement

          and manage.

        - use of a windowBuilder is difficult.

    For all those reasons, we HIGHLY recommend to NOT define applications

    as subclasses of StandardSystemView, but instead base them on

    ApplicationModel, and reference the topView(s) as instance variables of

    if (if at all).

    [instance variables:]

        label                   <String>    the label in the windows title

        icon                    <Form>      the icon

                                            [ignored if the display does not

                                             support icons]

        iconView                <View>      an optional icon-view (for animated icons)

                                            [ignored if the display does not

                                             supports this]

        iconLabel               <String>    the label in the icon

                                            [ignored if the display does not

                                             support label-tabs with icons]

        minExtent               <Point>     the minimum size

                                            No limit, if nil

                                            [the window manager may have its own

                                             limit; typically some small area]

        maxExtent               <Point>     the maximum size

                                            No limit, if nil.

                                            [the window manager may have its own

                                             limit; typically the screen size]

        sizeFixed               <Boolean>   prevents the view from resizing itself

                                            (especially to freeze a dialogs size)

        application             <AppModel>  if nonNil, that's the application

                                            Many requests (such as open/close etc.

                                            are forwarded to it, if present.

     [class variables:]

        DefaultIcon             <Form>      cached default icon

        TakeFocusWhenMapped     <Boolean>   if true, views grab the keyboard

                                            focus (convenient with some stupid

                                            windowManagers)

        IncludeHostNameInLabel  <Boolean>   if true, the windows title shall

                                            include the hostname.

                                            (convenient if you have many remote

                                            views open simultaneously)

        WindowLabelFormat       <Boolean>   specifies the format for windowLabels

    [author:]

        Claus Gittinger

    [see also:]

        WindowGroup

        ApplicationModel

"

!

examples

"

    simple, empty topView:

									[exBegin]

	|topView|

	topView := StandardSystemView new.

	topView label:'my first view'.

	topView extent:200 @ 200.

	topView open.

									[exEnd]

    with an icon & iconLabel:

									[exBegin]

	|topView|

	topView := StandardSystemView extent:200 @ 200.

	topView label:'Hello world'.

	topView icon:(Image fromFile:'hello_world.icon').

	topView open.

									[exEnd]

    with an animated iconView [not supported on all display devices]:

									[exBegin]

	|iconView topView|

	iconView := ClockView new.

	topView := StandardSystemView extent:200 @ 200.

	topView label:'Hello world'.

	topView iconView:iconView.

	topView open.

									[exEnd]

    placing a subView into it:

									[exBegin]

	|topView button|

	topView := StandardSystemView new.

	topView label:'my second view'.

	topView extent:200 @ 200.

	button := Button label:'close' in:topView.

	button action:[topView destroy].

	topView open.

									[exEnd]

    same, relative sized subview:

									[exBegin]

	|topView button|

	topView := StandardSystemView new.

	topView label:'my second view'.

	topView extent:200 @ 200.

	button := Button label:'close' in:topView.

	button action:[topView destroy].

	button origin:0.25 @ 0.25 corner:0.75 @ 0.75.

	topView open.

									[exEnd]

    multiple buttons in a panel in a topView:

									[exBegin]

	|topView panel button1 button2 button3|

	topView := StandardSystemView new.

	topView label:'my second view'.

	topView extent:200 @ 200.

	panel := HorizontalPanelView origin:0.0@0.0 corner:1.0@1.0 in:topView.

	panel inset:10.

	panel level:-1.

	button1 := Button label:'one' in:panel.

	button1 action:[Transcript showCR:'one pressed'].

	button2 := Button label:'two' in:panel.

	button2 action:[Transcript showCR:'two pressed'].

	button3 := Button label:'three' in:panel.

	button3 action:[Transcript showCR:'three pressed'].

	topView open.

									[exEnd]

"

! !

!StandardSystemView class methodsFor:'instance creation'!

extent:anExtent label:aLabel icon:aForm

    "create a new topView and define its extent, label and icon"

    ^ self origin:nil extent:anExtent

	   label:aLabel icon:aForm

	   minExtent:nil maxExtent:nil

!

extent:anExtent label:aLabel icon:aForm minExtent:minExtent

    ^ self origin:nil extent:anExtent

	   label:aLabel icon:aForm

	   minExtent:minExtent maxExtent:nil

!

extent:anExtent label:aLabel icon:aForm minExtent:minExtent maxExtent:maxExtent

    ^ self origin:nil extent:anExtent

	   label:aLabel icon:aForm

	   minExtent:minExtent maxExtent:maxExtent

!

extent:anExtent label:aLabel minExtent:minExtent

    "create a new topView and define its extent, label and minumum extent"

    ^ self origin:nil extent:anExtent

	   label:aLabel icon:nil

	   minExtent:minExtent maxExtent:nil

!

label:aLabel

    "create a new topView and define its label"

    ^ self origin:nil extent:nil

	   label:aLabel icon:nil

	   minExtent:nil maxExtent:nil

!

label:aLabel icon:aForm

    "create a new topView and define its label and icon"

    ^ self origin:nil extent:nil

	   label:aLabel icon:aForm

	   minExtent:nil maxExtent:nil

!

label:aLabel icon:aForm minExtent:anExtent

    "create a new topView and define its label, icon and minumum extent"

    ^ self origin:nil extent:nil

	   label:aLabel icon:aForm

	   minExtent:anExtent maxExtent:nil

!

label:aLabel icon:aForm minExtent:minExtent maxExtent:maxExtent

    "create a new topView and define its label, icon, min and max extents"

    ^ self origin:nil extent:nil

	   label:aLabel icon:aForm

	   minExtent:minExtent maxExtent:maxExtent

!

label:aLabel minExtent:anExtent

    "create a new topView and define its label and minimum extent"

    ^ self origin:nil extent:nil

	   label:aLabel icon:nil

	   minExtent:anExtent maxExtent:nil

!

model:aModel label:aLabel minimumSize:minExtent

    "ST80-style instance creation"

    |newView|

    newView := self origin:nil

		    extent:minExtent

		     label:aLabel

		      icon:nil

		 minExtent:minExtent

		 maxExtent:nil.

    newView model:aModel.

"/    newView controller:(self defaultControllerClass new view:newView).

    ^ newView

!

origin:anOrigin extent:anExtent label:aLabel

    "create a new topView and define its origin, extent and label"

    ^ self origin:anOrigin extent:anExtent

	   label:aLabel icon:nil

	   minExtent:nil maxExtent:nil

!

origin:anOrigin label:aLabel icon:aForm

		minExtent:minExtent maxExtent:maxExtent

    "create a new topView and define its origin, extent, label, icon

     and extent-boundaries."

    ^ self origin:anOrigin extent:nil

	   label:aLabel icon:aForm

	   minExtent:minExtent maxExtent:maxExtent

! !

!StandardSystemView class methodsFor:'Compatibility-VW'!

promptForOpen:aBoolean

    "not implemented here"

! !

!StandardSystemView class methodsFor:'class initialization'!

initialize

    IncludeHostNameInLabel := false.

    WindowLabelFormat := self defaultWindowLabelFormat.

    TakeFocusWhenMapped := (Screen notNil and:[Screen isWindowsPlatform]).

    "Created: / 20.8.1997 / 14:16:32 / cg"

    "Modified: / 24.8.1998 / 17:16:33 / cg"

! !

!StandardSystemView class methodsFor:'defaults'!

defaultExtent

    "return a standardSystemViews default window extent"

    DefaultExtent notNil ifTrue:[

	^ DefaultExtent

    ].

    ^ super defaultExtent

    "Created: 15.8.1997 / 01:36:21 / cg"

!

defaultIcon

    "return a topViews default window icon"

    <resource: #programImage>

    <resource: #style (#ICON #ICON_FILE)>

    |n nm i|

    (i := DefaultIcon) isNil ifTrue:[

	i := self classResources at:'ICON' default:nil.

	i isNil ifTrue:[

"/            OperatingSystem platformName == #win32 ifTrue:[

"/                n := 'stx_16x16.xpm'.

"/            ] ifFalse:[

"/                n := 'SmalltalkX.xbm'.

"/            ].

	    nm := ClassResources at:'ICON_FILE' default:n.

	    nm notNil ifTrue:[

		i := Smalltalk imageFromFileNamed:nm inPackage:'stx:libtool'.

	    ].

	    i isNil ifTrue:[

		i := self defaultSTXIcon

	    ].

	].

	i notNil ifTrue:[

	    DefaultIcon := i := i onDevice:Display

	]

    ].

    ^ i

    "

     DefaultIcon := nil.

     self defaultIcon inspect

    "

    "Modified: / 17-09-2007 / 11:36:25 / cg"

!

defaultIconForAboutBox

    ^ self defaultIcon

!

defaultLabel

    "return the default label for views of my kind.

     This can be redefined in subclasses or overwritten in

     initialize methods."

    ^ self nameWithoutPrefix. "/ 'aView'

    "Modified: / 27.9.1999 / 11:38:57 / cg"

!

defaultWindowLabelFormat

    "%2 is the hostName;

     %1 is the actual window label."

    "/ ^ '%2:%1'.    "/ the old format

    "/ ^ '%1 @ %2'.

    ^ '%1 (%5@%2)'.

!

includeHostNameInLabel

    "return the flag which controls if a views label should

     include the hostname.

     This flag is usually set/cleared in your private.rc file;

     the default is false."

    ^ IncludeHostNameInLabel

    "Created: 10.9.1995 / 19:21:16 / claus"

!

includeHostNameInLabel:aBoolean

    "set/clear the flag which controls if a views label should

     include the hostname - this is highly useful if you have

     multiple smalltalks open simultaneously ...

     This flag is usually set/cleared in your private.rc file;

     the default is false."

    IncludeHostNameInLabel := aBoolean

    "Modified: 24.4.1996 / 09:09:21 / cg"

!

takeFocusWhenMapped

    ^ TakeFocusWhenMapped

    "

     StandardSystemView takeFocusWhenMapped

    "

!

updateStyleCache

    "extract values from the styleSheet and cache them in class variables"

    <resource: #style (#'standardSystemView.defaultExtent')>

    DefaultExtent := StyleSheet at:'standardSystemView.defaultExtent' default:nil.

    "

     self updateStyleCache

    "

    "Modified: 31.8.1995 / 03:01:14 / claus"

    "Created: 15.8.1997 / 01:34:37 / cg"

    "Modified: 20.10.1997 / 15:13:50 / cg"

!

windowLabelFormat

    ^ WindowLabelFormat

!

windowLabelFormat:aFormatString

    WindowLabelFormat := aFormatString

! !

!StandardSystemView class methodsFor:'image specs'!

defaultSTXIcon

    <resource: #programImage>

    ^ Icon stxIcon.

! !

!StandardSystemView class methodsFor:'startup'!

cancelAutoRaise

    "cancel any schedule autoraise action"