DcsUIImageEditorView

Description

The image editor view.

Members

PropertyBOOL showRotateLeftToolItemGets or sets whether to show the RotateLeft tool item. The default value is "YES".

Member Type Member Name Description
Property var nextViewAfterCancel:DcsViewEnum Gets or sets the view to navigate to when the cancel tool item is tapped. The default value is DEV_IMAGEGALLERYVIEW.
Property var nextViewAfterOK:DcsViewEnum Gets or sets the view to navigate to when the OK tool item is tapped. The default value is DVE_IMAGEGALLERYVIEW.
Property var showRotateRightToolItem:Bool Gets or sets whether to show the RotateRight tool item. The default value is "YES".
Property var showFlipToolItem:Bool Gets or sets whether to show the Flip tool item. The default value is "YES".
Property var showMirrorToolItem:Bool Gets or sets whether to show the Mirror tool item. The default value is "YES".
Property var showBrightnessToolItem:Bool Gets or sets whether to show the Brightness tool item. The default value is "YES".
Property var showContrastToolItem:Bool Gets or sets whether to show the Contrast tool item. The default value is "YES".
Property var showCropToolItem:Bool Gets or sets whether to show the Crop tool item. The default value is "YES".
Property var rotateIcon:UIImage Gets or sets the icon showed on Rotate tool item on the image editor viewer.
Property var rotateLeftIcon:UIImage Gets or sets the icon showed on RotateLeft tool item on the image editor viewer.
Property var rotateRightIcon:UIImage Gets or sets the icon showed on RotateRight tool item on the image editor viewer.
Property var flipIcon:UIImage Gets or sets the icon showed on Flip tool item on the image editor viewer.
Property var mirrorIconUIImage Gets or sets the icon showed on Mirror tool item on the image editor viewer.
Property var cropIcon:UIImage Gets or sets the icon showed on Crop tool item on the image editor viewer.
Property var cropCancelIconUIImage Gets or sets the icon showed on Cancel tool item of the Crop view after tapping the Crop tool item.
Property var cropOKIcon:UIImage Gets or sets the icon showed on OK tool item of the Crop view after tapping the Crop tool item.
Property var brightnessContrastIcon:UIImage Gets or sets the icon showed on the Brightness and Contrast tool item on the image editor viewer.
Property var brightnessText:String Gets or sets the text showed on the Brightness tool item on the image editor viewer. The default value is "Brightness".
Property var contrastText:String Gets or sets the text showed on the Contrast tool item on the image editor viewer. The default value is "Contrast".
Property var cancelText:String Gets or sets the text showed on the Cancel tool item on the image editor viewer. The default value is "OK".
Property var okText:String Gets or sets the text showed on the OK tool item on the image editor viewer. The default value is "OK".
delegate func onCancelTapped(sender:Any) -> Void The event is fired when the cancel tool item is clicked.
delegate func onOkTapped(sender:Any) -> Void The event is fired when the OK tool item is clicked.
Function func adjustContrast(contrast:Int) -> Void Adjusts the contrast of the image.
Function func adjustBrightness(brightness:Int) -> Void Adjusts the brightness of the image.
Function func rotateLeft() -> Void Rotates the image in the editor by 90 degrees counter-clockwise.
Function func rotateRight() -> Void Rotates the image in the editor by 90 degrees clockwise.
Function func flip() -> Void Flips the image in the editor vertically (as opposed to mirror).
Function func mirror() -> Void Mirrors the image in the editor.
Function func cut(x1:Int, y1:Int, x2:Int, y2:Int) -> Void Cuts an area of the image. The remaining area is left as white once cut.
Function func crop(x1:Int, y1:Int, x2:Int, y2:Int) -> Void Crops an image in the editor.
Function func save() -> Void Saves the changes made to the image.
Function func discard() -> Void Discards the changes made to the image.

enum DcsViewEnum

DVE_VIDEOVIEW=0x0010 Video view
DVE_IMAGEGALLERYVIEW Image gallery view
DVE_EDITORVIEW Edit view. When the data you operate with is a document, it displays the document editor. If it's an image, then it displays the image editor.
nextViewAfterCancel:DcsViewEnum
Description Gets or sets the view to navigate to when the cancel tool item is tapped. The default value is DEV_IMAGEGALLERYVIEW.
Remarks If it's set to DVE_VIDEOVIEW, when the cancel button is clicked, the current page redirects to the video view.

If it's set to DVE_IMAGEGALLERYVIEW, when the cancel button on the video view page is clicked, the current page redirects to the image gallery view.

If it's set to DVE_EDITORVIEW, when the cancel button is clicked, the current page remains no change.

If it's not set to DVE_EDITORVIEW or DVE_VIDEOVIEW, the exception DcsValueOutOfRangeException will be thrown.

If the value equals nil, it means the set fails, the exception DcsValueNotValidException will be thrown.

nextViewAfterOK:DcsViewEnum
Description Gets or sets the view to navigate to when the OK tool item is tapped. The default value is DEV_IMAGEGALLERYVIEW.
Remarks If it's set to DVE_VIDEOVIEW, when the OK button is clicked, the current page redirects to the video viewer.

If it's set to DVE_IMAGEGALLERYVIEW, when the capture button on the video view page is clicked, the current page redirects to the image gallery view.

If it's set to DVE_EDITORVIEW, when the OK button is clicked, the current page remains no change.

If it's not set to DVE_EDITORVIEW or DVE_VIDEOVIEW, the exception DcsValueOutOfRangeException will be thrown.

If the value equals nil, it means the set fails, the exception DcsValueNotValidException will be thrown.

rotateIcon:UIImage
Description Gets or sets the icon showed on Rotate tool item on the image editor viewer.
Remarks If it is set to nil, no icon will be showed on the Rotate tool item on the image editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

rotateLeftIcon:UIImage
Description Gets or sets the icon showed on RotateLeft tool item on the image editor viewer.
Remarks If it is set to nil, no icon will be showed on the RotateLeft tool item on the image editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

rotateRightIcon:UIImage
Description Gets or sets the icon showed on RotateRight tool item on the image editor viewer.
Remarks If it is set to nil, no icon will be showed on the RotateRight tool item on the image editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

flipIcon:UIImage
Description Gets or sets the icon showed on Flip tool item on the image editor viewer.
Remarks If it is set to nil, no icon will be showed on the Flip tool item on the image editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

mirrorIcon:UIImage
Description Gets or sets the icon showed on Mirror tool item on the image editor viewer.
Remarks If it is set to nil, no icon will be showed on the Mirror tool item on the image editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

cropIcon:UIImage
Description Gets or sets the icon showed on Crop tool item on the image editor viewer.
Remarks If it is set to nil, no icon will be showed on the Crop tool item on the image editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

cropCancelIcon:UIImage
Description Gets or sets the icon showed on the Cancel tool item of the Crop view after tapping the Crop tool item.
Remarks If it is set to nil, no icon will be showed on the Cancel tool item.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

cropOKIcon:UIImage
Description Gets or sets the icon showed on the OK tool item of the Crop view after tapping the Crop tool item.
Remarks If it is set to nil, no icon will be showed on the OK tool item.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

brightnessContrastIcon:UIImage
Description Gets or sets the icon showed on Brightness and Contrast tool item on the image editor viewer.
Remarks If it is set to nil, no icon will be showed on the Brightness and Contrast tool item on the image editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

brightnessText:String
Description Gets or sets the text showed on the Brightness tool item on the image editor viewer. The default value is "Brightness".
Remarks If it is set to nil, no text will be showed on the Brightness tool item on the image editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

contrastText:String
Description Gets or sets the text showed on the Contrast tool item on the image editor viewer. The default value is "Contrast".
Remarks If it is set to nil, no text will be showed on the Contrast tool item on the image editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

cancelText:String
Description Gets or sets the text showed on the Cancel tool item on the document editor viewer. The default value is "Cancel".
Remarks If it is set to nil, no text will be showed on the Cancel tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

okText:String
Description Gets or sets the text showed on the OK tool item on the document editor viewer. The default value is "OK".
Remarks If it is set to nil, no text will be showed on the OK tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.