Image Viewer Cells

General

A container, or Image Viewer, may contain a number of child windows called cells. These cells may contain images, tags or rulers. Cells are resized to fit within the "blocks" that make up the rows and columns in the container. The number of rows and columns can be altered programmatically by calling L_DispContainerSetProperties to set the container properties. The number of rows and columns can be altered dynamically by the user positioning, more "splitters" within the container.

When a container is created, it is empty. To add a cell to a container, call L_DispContainerInsertCell. This function automatically creates a window for the cell when it inserts the cell into the container. A handle to that window can be retrieved, by calling L_DispContainerGetCellWindowHandle. The number of cells that can be added to a container is limited only by the available memory. To get the current number of cells in a container, call L_DispContainerGetCellCount.

Cells are positioned within a container from left to right and top to bottom. When a cell is inserted in the container, any cells to the right of the inserted cell will be moved to the right one block, wrapping to the next row as each row is filled. The row and column position of each cell can be retrieved, by calling L_DispContainerGetCellPosition. A cell can be repositioned, based on the index, by calling L_DispContainerRepositionCell.

Each cell in the container has certain properties associated with it. The current properties for a cell can be retrieved, by calling L_DispContainerGetCellProperties. To change the properties of a single cell, or to give all cells in the container the same properties, call L_DispContainerSetCellProperties. There are certain properties that apply to all cells within a container. These properties can be retrieved and set using L_DispContainerGetProperties and L_DispContainerSetProperties.

Each cell in a container has boundaries, which are dictated by the splitters separating the rows and the columns. These boundaries cannot actually be reset programmatically, although you could change the number of rows and columns in the container. The boundaries can be obtained however, by calling L_DispContainerGetCellBounds.

Actions may be applied to the images attached to the cells in the container. For more information about the available actions and the functions associated with them, refer to Applying Actions. As the Applying Actions to a Container topic describes, actions can be assigned to mouse buttons and keystroke combinations. These actions are then applied to one or more cells when the mouse button is pressed/dragged or the keystroke combination is pressed. To prevent the mouse or keyboard from being used to apply an action to a cell, that cell can be frozen. To "freeze" a cell, call L_DispContainerFreezeCell with the bFreeze parameter set to TRUE. A frozen cell cannot be handled using the mouse or the keyboard, but it can be changed manually using either L_DispContainerSetCellProperties, or L_DispContainerSetActionProperties. To unfreeze a frozen cell, call L_DispContainerFreezeCell with the bFreeze parameter set to FALSE. To determine whether a cell is frozen, call L_DispContainerIsCellFrozen.

Cells within a container may be selected or deselected. In fact, when applying actions to cells the user has the option to apply the action on one cell, all cells, or only selected cells. To select or deselect a cell, call L_DispContainerSelectCell. When selecting cells dynamically, selecting one cell by clicking on it will deselect all other cells. To select more than one cell, hold the CTRL key while clicking on the cells. To determine whether a cell is currently selected, call L_DispContainerIsCellSelected.

What a Cell Contains

A cell can have one or more images attached to it by calling L_DispContainerSetCellBitmapList. If a bitmap list having multiple images is added, scroll bars will appear to allow scrolling through the images. To get the current list attached to a cell, call L_DispContainerGetCellBitmapList. It is best not to modify an existing bitmap list attached to a specific cell. However, if it is necessary to modify an attached bitmap list, certain steps should be taken. For more information on this procedure, refer to L_DispContainerSetCellBitmapList.

However, you can retrieve a bitmap handle from the bitmap list inside the cell using the function L_DispContainerGetBitmapHandle, once you have it, you can apply any LEADTOOLS function. And after you are done, you have to make sure that your changes are reflected in the image viewer. This is done by calling the function L_DispContainerSetBitmapHandle. This function will repaint the cell to visualize the new changes on the affected image, if user chooses not to repaint the cell right away, he can repaint it later using the function L_DispContainerRepaintCell.

Cells may also contain rulers. Horizontal and vertical rulers are used to measure the actual size of the image in centimeters. These rulers are updated automatically if the image is resized. They are displayed or hidden, depending on the cell properties set using L_DispContainerSetCellProperties. The style and colors used to draw the rulers are set for the container using L_DispContainerSetProperties.

In addition to images and rulers, cells may also contain tags. Tags are text that is spread along the sides of the cell, and provide information about the image. A cell may have no tags, one tag, or more than one tag. Each tag is added by calling L_DispContainerSetCellTag.

There are three types of tags:

Built-in tags (hot tags): internally written tags that contain information about the image, such as the scale. These tags change immediately, if the image properties associated with the tag change. Therefore, if the image is scaled to 300, the scale tag changes to 300.

User tags: tags that contain text entered by the user.

Owner tags: tags that are handled through the DISPCONTAINERTAGCALLBACK callback function. Each time a cell is drawn that contains an owner tag, this callback function is called, if it has been set using L_DispContainerSetTagCallBack. To determine the current callback function used to handle these tags, call L_DispContainerGetTagCallBack.

Sub-Cells

Cells can sometimes act like mini containers. They can be divided into equivalent blocks based on the number of rows and columns set using the L_DispContainerSetCellProperties function. Splitters are not used to separate rows and columns in cells. Therefore, the number of cells and the size of each cell is set when L_DispContainerSetCellProperties is called. Each block within the cell contains one page of the bitmap list attached to the cell. Scrolling is also supported within the cell, although it is a little different from the container scrolling. In cell scrolling, the pages shift up by one page. Therefore, if the cell has pages 0, 1, 2, and 3, and the pages are scrolled down by one page 0 will disappear and page 1 will take its place.

There is very little independence for sub-cells. For most actions, such as scaling, if one sub-cell is scaled, all sub cells are scaled. However, the window leveling and alpha actions can be applied to individual sub-cells, without being applied to all sub-cells.

While sub-cells can be selected, only one-sub cell per cell can be selected at a time.

Dynamically, left double clicking on a sub-cell causes the cell to enter an "exploded" mode in which the sub-cell expands to cover the entire cell. Left double-clicking the cell a second time returns the sub-cell to its regular state.

Sub-Cells may contain title bars. Title bars are docked at the top of every cell or sub-cell inside the image viewer, this title bar contains a small icons that the user can check / uncheck either manually or programmatically. The title bar is not visible by default; the user needs to show the title bar by calling the function L_DispContainerShowTitlebar. Also he can check whether the title bar is shown or not by calling the function L_DispContainerIsTitlebarEnabled.

The user can obtain or change the title bar properties. To obtain the title bar properties, call the L_DispContainerGetTitlebarProperties function. To change the title bar properties, call the L_DispContainerSetTitlebarProperties function.

The icons within the title bar can be check / uncheck programmatically by calling the function L_DispContainerCheckTitlebarIcon, you can also retrieve the current state of a specific title bar icon whether it is checked or unchecked by calling the function L_DispContainerIsTitleBarIconChecked.

The user can obtain or change the title bar icon properties. To obtain the title bar icon properties, call the L_DispContainerGetIconProperties function. To change the title bar icon properties, call the L_DispContainerSetIconProperties function.

Painting a Cell

Painting is completely controlled by the user.

When the user updates the image attached with a cell or sub-cell by calling the L_DispContainerSetBitmapHandle function, he controls the repainting action of the cell by specifying the value of bRepaint parameter. If the user has set this parameter value to FALSE, then the user should call the L_DispContainerRepaintCell function after the image been updated to repaint the cell.

During the cell painting, the DISPCONTAINERPAINTCALLBACK callback function will be called if it was previously set by calling the L_DispContainerSetPaintCallBack function. To determine the current callback being used to handle painting, call the L_DispContainerGetPaintCallBack function.

Removing a Cell

When a cell is no longer needed in a container it can be removed by calling L_DispContainerRemoveCell. If a cell is removed, any cells to the right of the removed cell will be shifted left. Cells will wrap to the preceding row as needed. All cells in a container can be removed by calling L_DispContainerRemoveCell with the nCellIndex parameter set to –1.