"{ Encoding: utf8 }"

"

 COPYRIGHT (c) 1993 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:libwidg2' }"

"{ NameSpace: Smalltalk }"

View subclass:#ImageView

	instanceVariableNames:'image magnifiedImage adjust magnificationFactor tileMode

		tileOffset lastMousePoint adjustHolder imageEditAction'

	classVariableNames:'DoNotMagnifyQuery'

	poolDictionaries:''

	category:'Views-Misc'

!

!ImageView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1993 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 View knows how to display a (bitmap-)image (or form).

    You can display an image with:

        ImageView openOn:anImageFileName

    or:

        ImageView openOnImage:anImage

    or:

        ImageView new image:anImage

    i.e.

        ImageView openOn:'../../goodies/bitmaps/gifImages/garfield.gif'

        ImageView openOn:'../../goodies/bitmaps/SBrowser.xbm'

        ImageView openOnImage:(Image fromFile:'../../goodies/bitmaps/gifImages/garfield.gif')

        ImageView openOnImage:(Image fromFile:'../../goodies/bitmaps/SBrowser.xbm')

    adjust:

        controls how images are displayed;

        can be one of:

            #topLeft    - image is displayed as usual

            #center     - image is shown centered

            #fitBig     - big images are shrunk to make it fit the view

            #fitSmall   - small images are magnified to make it fit the view,

            #fit        - all images are magnified to fit the view

    [author:]

        Claus Gittinger

    [see also:]

        Image Form

"

!

examples

"

    |top imgView scrView|

    top := StandardSystemView new.

    top extent:300@300.

    imgView := ImageView new.

    imgView image:(Image fromFile:'../../goodies/bitmaps/gifImages/garfield.gif').

    scrView := HVScrollableView forView:imgView.

    scrView origin:0@0 corner:1.0@1.0.

    top add:scrView.

    top open.

"

! !

!ImageView class methodsFor:'initialization'!

initialize

    DoNotMagnifyQuery isNil ifTrue:[

        DoNotMagnifyQuery := QuerySignal new defaultAnswer:false.

    ].

! !

!ImageView class methodsFor:'menu specs'!

middleButtonMenu

    "This resource specification was automatically generated

     by the MenuEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the MenuEditor may not be able to read the specification."

    "

     MenuEditor new openOnClass:ImageView andSelector:#middleButtonMenu

     (Menu new fromLiteralArrayEncoding:(ImageView middleButtonMenu)) startUp

    "

    <resource: #menu>

    ^ 

     #(Menu

        (

         (MenuItem

            label: 'Size to Fit'

            choice: adjustHolder

            choiceValue: fitBig

          )

         (MenuItem

            label: 'Original Size'

            choice: adjustHolder

            choiceValue: #topLeft

          )

         (MenuItem

            label: '-'

            isVisible: selfIsNotImageEitor

          )

         (MenuItem

            label: 'Edit'

            itemValue: editImage

            isVisible: selfIsNotImageEditor

          )

         )

        nil

        nil

      )

    "Modified: / 16-02-2017 / 18:59:23 / cg"

! !

!ImageView class methodsFor:'queries-plugin'!

aspectSelectors

    ^ #( imageChannel )

    "Created: / 11.2.2000 / 00:37:33 / cg"

! !

!ImageView class methodsFor:'startup'!

openOn:anImageOrFileName

    "startup an image viewer on an image or

     an image read from a file.

     Return the imageView (not the topView)"

    anImageOrFileName isImage ifTrue:[

        ^ self openOnImage:anImageOrFileName

    ].

    ^ self openOnFile:anImageOrFileName

    "

     ImageView openOn:'bitmaps/gifImages/garfield.gif'

     ImageView openOn:'bitmaps/xpmBitmaps/misc_icons/BOOK.xpm'

    "

    "Modified: / 31-10-1997 / 16:17:52 / cg"

    "Modified (comment): / 13-02-2017 / 10:13:13 / cg"

!

openOnFile:aFileName

    "startup an image viewer on an image read from a file.

     Return the imageView (not the topView)"

    |fn imageView img e|

    fn := aFileName asFilename.

    img := Image fromFile:fn.

    img isNil ifTrue:[

        fn exists ifTrue:[

            e := 'Unknown or unsupported image format.'

        ] ifFalse:[

            e := 'No such image file.'.

        ].

        self warn:(self resources string:e).

        ^ nil

    ].

    imageView := self openOnImage:img.

    imageView topView label:(fn pathName) iconLabel:(fn baseName).

    ^ imageView

    "

     ImageView openOnFile:'../../goodies/bitmaps/gifImages/garfield.gif'

     ImageView openOnFile:'../../goodies/bitmaps/xpmBitmaps/misc_icons/BOOK.xpm'

    "

    "Modified: / 31-10-1997 / 16:17:52 / cg"

    "Modified (comment): / 13-02-2017 / 10:12:53 / cg"

!

openOnImage:anImage

    "startup an image viewer on an image.

     Return the imageView (not the topView)"

    |lbl|

    anImage isImage ifTrue:[

        lbl := anImage fileName ? 'an Image'

    ] ifFalse:[

        anImage isNil ifTrue:[

            lbl := 'an Image'

        ] ifFalse:[

            lbl := 'a Form'

        ]

    ].

    ^ self openOnImage:anImage title:lbl

    "

     ImageView openOnImage:(Image fromFile:'bitmaps/gifImages/garfield.gif') title:'garfield'

     ImageView openOnImage:(Image fromFile:'../../libtool/bitmaps/SBrowser.xbm') title:'old browser icon'

    "

    "Modified (comment): / 13-02-2017 / 10:12:43 / cg"

!

openOnImage:anImage title:aString

    "startup an image viewer on an image.

     Return the imageView (not the topView)"

    |top v imageView icnW icnH iconView magX magY mag imgWidth imgHeight|

    top := StandardSystemView label:aString.

    v := HVScrollableView for:self in:top.

    v origin:0@0 extent:1.0@1.0.

    imageView := v scrolledView.

    anImage notNil ifTrue:[

        imageView image:anImage.

        "define an icon view showing a little version of image.

         Since some window managers cannot handle this correctly (twm),

         this is only done when running on an IRIS"

        (true "(OperatingSystem getSystemType = 'iris')"

        and:[StyleSheet name == #iris]) ifTrue:[

            iconView := ImageView new.

            "for now; should somehow get access to preferred iconview extent ..."

            icnW := 86.

            icnH := 68.

            imgWidth := anImage width.

            imgHeight := anImage height.

            ((imgWidth <= icnW) and:[imgHeight <= icnH]) ifTrue:[

                iconView extent:(imgWidth @ imgHeight).

                mag := 1 @ 1

            ] ifFalse:[

                magX := icnW / imgWidth.

                magY := icnH / imgHeight.

                "scale image"

"

                mag := magX @ magY.

"

                "preserve ratio"

"

                mag := (magX min:magY) asPoint.

"

                mag := (magX max:magY) asPoint.

                iconView extent:((anImage width @ anImage height) * mag) rounded.

            ].

            top iconView:iconView.

        ].

    ].

    top open.

    iconView notNil ifTrue:[

        top windowGroup addView:iconView.

        [

            iconView image:(anImage magnifiedBy:mag).

        ] forkAt:4

    ].

    ^ imageView

    "

     ImageView openOnImage:(Image fromFile:'../../goodies/bitmaps/gifImages/garfield.gif') title:'garfield'

     ImageView openOnImage:(Image fromFile:'../../libtool/bitmaps/SBrowser.xbm')

    "

    "Modified: / 01-06-2010 / 18:31:14 / cg"

    "Modified (comment): / 13-02-2017 / 10:12:35 / cg"

! !

!ImageView methodsFor:'accessing'!

adjust

    "get the adjust (how the image is displayed);

     currently, only support #topLeft, #center, #fitBig, #fitSmall and #fit:

            #topLeft    - image is displayed as usual

            #center     - image is shown centered

            #fitBig     - big images are shrunk to make it fit the view

            #fitSmall   - small images are magnified to make it fit the view,

            #fit        - all images are magnified to fit the view

    "

    ^ adjust ? #topLeft

!

adjust:layoutSymbol

    "set the adjust (how the image is displayed);

     currently, only support #topLeft, #center, #fitBig, #fitSmall and #fit:

            #topLeft    - image is displayed as usual

            #center     - image is shown centered

            #fitBig     - big images are shrunk to make it fit the view

            #fitSmall   - small images are magnified to make it fit the view,

            #fit        - all images are magnified to fit the view

            #topLeftNoZoom    - image is displayed as usual, and magnification is reset

    "

    |layoutUsed|

    layoutUsed := layoutSymbol.

    layoutUsed == #topLeftNoZoom ifTrue:[

        layoutUsed := #topLeft

    ].

    self magnificationFactor ~= 1 ifTrue:[

        self magnificationFactor:1

    ].

    adjust ~= layoutUsed ifTrue:[

        adjust := layoutUsed.

        adjustHolder notNil ifTrue:[

            adjustHolder value:layoutUsed withoutNotifying:self

        ].    

        magnifiedImage := nil.

        shown ifTrue:[

            image notNil ifTrue:[

                self magnificationFactor ~= 1 ifTrue:[

                    self generateMagnifiedImage.

                ].    

                self clear.

                self scrollToTopLeft.

                self invalidate.

                self contentsChanged.

            ]

        ].

    ].

!

adjustHolder

    "get a valeHolder for the adjust (how the image is displayed);

     currently, only support #topLeft, #center, #fitBig, #fitSmall and #fit:

            #topLeft    - image is displayed as usual

            #center     - image is shown centered

            #fitBig     - big images are shrunk to make it fit the view

            #fitSmall   - small images are magnified to make it fit the view,

            #fit        - all images are magnified to fit the view

    "

    adjustHolder isNil ifTrue:[

        adjustHolder := self adjust asValue.

        adjustHolder 

            onChangeEvaluate:[

                self adjust:(adjustHolder value).

            ]

    ].        

    ^ adjustHolder

!

image

    "return the image"

    ^ image

!

image:anImage

    "set the image scrolls as set by adjust

     - may show a wait cursor, if image dithering may take a while"

    self image:anImage scroll:true

!

image:anImage scroll:doScroll

    "set the image possibly scroll as set by adjust

     - may show a wait cursor, if image dithering may take a while"

    self setImage:anImage scroll:doScroll

!

image:anImage scroll:doScroll invalidate:doInvalidate

    "set the image possibly scroll as set by adjust

     - may show a wait cursor, if image dithering may take a while"

    self setImage:anImage scroll:doScroll invalidate:doInvalidate

!

imageEditAction:aOneArgBlockOrNil

    "if nonNil, aOneArgBlockOrNil will be called to open

     the image editor (as by the 'Edit Image' menu action).

     If never set, the default ImageEditor is opened."

    imageEditAction := aOneArgBlockOrNil.

    "Created: / 19-02-2017 / 22:58:14 / cg"

!

magnification

    magnifiedImage isNil ifTrue:[^ 1@1].

    ^ magnifiedImage extent / image extent

!

magnificationFactor

    ^ magnificationFactor ? 1

!

magnificationFactor:aNumber

    magnificationFactor ~= aNumber ifTrue:[

        magnificationFactor := aNumber.

        "/    magnificationFactor fractionPart < 0.1 ifTrue:[

        "/        "magnifying by integer factor is faster"

        "/        magnificationFactor := magnificationFactor truncated.

        "/    ].

        magnifiedImage := nil.

        magnificationFactor = 1 ifTrue:[

            self contentsChanged.

        ].    

        self invalidate.

    ].

!

model:aValueHolder

    super model:aValueHolder.

    self updateFromModel.

    "Created: / 25-07-2011 / 15:32:10 / cg"

!

setImage:anImage

    "set the image - show a wait cursor, since image dithering may take a while"

    self setImage:anImage scroll:true invalidate:true

    "Modified: / 10.2.2000 / 23:25:51 / cg"

!

setImage:anImage scroll:doScroll

    "set the image - may show a wait cursor, if image dithering may take a while"

    self setImage:anImage scroll:doScroll invalidate:true

!

setImage:anImage scroll:doScroll invalidate:doInvalidate

    "set the image - may show a wait cursor, if image dithering may take a while"

    |oldSize newSize newImageIsSmaller|

    oldSize := image isNil ifTrue:[0@0] ifFalse:[image extent].

    image := anImage.

    magnifiedImage := nil.

    self generateMagnifiedImage.

    newSize := image isNil ifTrue:[0@0] ifFalse:[(magnifiedImage ? image) extent].

    newImageIsSmaller := ((oldSize x > newSize x) or:[oldSize y > newSize y]).

    (newImageIsSmaller and:[ doInvalidate ]) ifTrue:[ self invalidate ].

    doScroll ifTrue:[ self scrollToTopLeft ].