# The "ImageDisplay" Widget

This widget allows you to create an image display application with minimal work. Many other widgets are created by this.

Library: karmawidgets
Link With: -lkarmawidgets

#### Tables

ImageDisplay_ResourceNames | List of resource names for ImageDisplay widget
ImageDisplay_Resources | List of resources for ImageDisplay widget

#### Functions

XkwImageDisplayRefresh | Refresh the active display canvas for an ImageDisplay widget.
XkwImageDisplayGetWindow | Get/create the KDisplayDataWindow for an ImageDisplay widget.
XkwImageDisplaySetSmoothCallback | Ktoggle callback for double buffering for an ImageDisplay widget.

## Tables

ImageDisplay_ResourceNames List of resource names for ImageDisplay widget

Name | Purpose
XkwNpseudoColourCanvas | The PseudoColour world canvas
XkwNdirectColourCanvas | The DirectColour world canvas
XkwNtrueColourCanvas | The TrueColour world canvas
XkwNpseudoColourLeftCanvas | The PseudoColour left world canvas
XkwNpseudoColourRightCanvas | The PseudoColour right world canvas
XkwNdirectColourLeftCanvas | The DirectColour left world canvas
XkwNdirectColourRightCanvas | The DirectColour right world canvas
XkwNtrueColourLeftCanvas | The TrueColour left world canvas
XkwNtrueColourRightCanvas | The TrueColour right world canvas
XkwNvisibleCanvas | The visible world canvas
XkwNmagnifier | The magnifier popup
XkwNimageName | The name of the image being shown
XkwNenableAnimation | If TRUE the AnimateControl widget is created
XkwNshowAnimateButton | If TRUE the "Movie" button is created
XkwNshowQuitButton | If TRUE the "Quit" button is created
XkwNcmapSize | The size of the PseudoColour colourmap
XkwNcmapMaster | The location of a colourmap master (server)
XkwNfullscreen | If TRUE the main window should be fullscreen
XkwNnumTrackLabels | The number of track labels
XkwNview2Datasets | If TRUE the View2Datasets widget is created
XkwNnumDatasets | The number of datasets
XkwNmainRealisedCallback | Callbacks when all main canvases are realised
XkwNafterMainRealisedCallback | Callbacks after XkwNmainRealisedCallback called
XkwNdatasetNames | The names of each dataset
XkwNnewVisibleCanvasCallback | Callbacks for when the visible canvas changes
XkwNpanner | The panner popup
XkwNverbose | If TRUE verbose output is generated

ImageDisplay_Resources List of resources for ImageDisplay widget

Name | Class | Rep. Type | Default
XkwNpseudoColourCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNdirectColourCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNtrueColourCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNpseudoColourLeftCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNpseudoColourRightCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNdirectColourLeftCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNdirectColourRightCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNtrueColourLeftCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNtrueColourRightCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNvisibleCanvas | XkwCWorldCanvas | XtRPointer | NULL
XkwNcanvasList | XkwCWorldCanvas | XtRPointer | NULL
XkwNmagnifier | XtCWidget | XtRWidget | NULL
XkwNimageName | XkwCImageName | XtRString | NULL
XkwNcreateFilepopup | XkwCCreateFilepopup | XtRBool | True
XkwNenableAnimation | XkwCEnableAnimation | XtRBool | False
XkwNshowQuitButton | XkwCShowQuitButton | XtRBool | True
XkwNcmapSize | XkwCCmapSize | XtRInt | 200
XkwNcmapMaster | XkwCCmapMaster | XtRString | NULL
XkwNfullscreen | XkwCFullscreen | XtRBool | False
XkwNnumTrackLabels | XkwCNumTrackLabels | XtRInt | 0
XkwNviewDatasets | XkwCViewDatasets | XtRBool | False
XkwNnumDatasets | XkwCNumDatasets | XtRInt | 1
XkwNmainRealisedCallback | XtCCallback | XtRCallback | NULL
XkwNafterMainRealisedCallback | XtCCallback | XtRCallback | NULL
XkwNdatasetNames | XkwCDatasetNames | XtRPointer | NULL
XkwNnewVisibleCanvasCallback | XtCCallback | XtRCallback | NULL
XkwNpanner | XtCWidget | XtRWidget | NULL
XkwNfastPanner | XkwCFastPanner | XtRBool | True
XkwNupdateTrackLabels | XkwCUpdateTrackLabels | XtRBool | False
XkwNnewEditorContextCallback | XtCCallback | XtRCallback | NULL
XkwNmultiCanvas | XtCWidget | XtRWidget | NULL
XkwNpseudoCmap | XkwCColourmap | XtRPointer | NULL
XkwNrenzoPseudoCmap | XkwCColourmap | XtRPointer | NULL
XkwNrenzoTrueCmap | XkwCColourmap | XtRPointer | NULL
XkwNhueIntensityCmap | XkwCColourmap | XtRPointer | NULL
XkwNrequestMask | XkwCMask | XtRInt | ~0
XkwNallowedMask | XkwCMask | XtRInt | ~0
XkwNpseudoXColourMap | XtCColormap | XtRColormap | None
XkwNverbose | XkwCVerbose | XtRBool | False

## Functions

#### EXPERIMENTAL FUNCTION: subject to change without notice

void XkwImageDisplayRefresh (Widget W, flag clear)

This routine will refresh the active display canvas for the ImageDisplay widget. If the active canvas is a stereo canvas both the left and right canvases are refreshed.

Parameters:

- W : The widget.
- clear : If TRUE, the canvas is cleared prior to refresh.

Returns: Nothing.
Multithreading Level: Unsafe

#### EXPERIMENTAL FUNCTION: subject to change without notice

KDisplayDataWindow XkwImageDisplayGetWindow (Widget W)

Get/create the KDisplayDataWindow for an ImageDisplay widget.

Parameters:

- W : The widget.

Returns: The KDisplayDataWindow object.
Multithreading Level: Unsafe
Note:

- The widget must be realised before calling this function.

#### EXPERIMENTAL FUNCTION: subject to change without notice

void XkwImageDisplaySetSmoothCallback (Widget w, XtPointer client_data, XtPointer call_data)

Ktoggle callback for double buffering for an ImageDisplay widget.

Parameters:

- w : The widget the event occurred on.
- client_data : Client data. This must point to the ImageDisplay widget.
- call_data : Call data. This must point to the toggle state data.

Returns: Nothing.
Multithreading Level: Unsafe
Note:

- The ImageDisplay widget must be realised before calling this function.

Back to Karma Home Page