DcsUIImageEditorView

Description

A class for the image editor view.

Members

Member Type Member Name Description
Property DcsViewEnum nextViewAfterCancel Gets or sets the view to navigate to when the cancel tool item is tapped. The default value is DEV_IMAGEGALLERYVIEW.
Property DcsViewEnum nextViewAfterOK Gets or sets the view to navigate to when the OK tool item is tapped. The default value is DVE_IMAGEGALLERYVIEW.
Property BOOL showRotateLeftToolItem Gets or sets whether to show the RotateLeft tool item. The default value is "YES".
Property BOOL showRotateRightToolItem Gets or sets whether to show the RotateRight tool item. The default value is "YES".
Property BOOL showFlipToolItem Gets or sets whether to show the Flip tool item. The default value is "YES".
Property BOOL showMirrorToolItem Gets or sets whether to show the Mirror tool item. The default value is "YES".
Property BOOL showBrightnessToolItem Gets or sets whether to show the Brightness tool item. The default value is "YES".
Property BOOL showContrastToolItem Gets or sets whether to show the Contrast tool item. The default value is "YES".
Property BOOL showCropToolItem Gets or sets whether to show the Crop tool item. The default value is "YES".
Property UIImage * rotateIcon Gets or sets the icon showed on Rotate tool item on the image editor view.
Property UIImage * rotateLeftIcon Gets or sets the icon showed on RotateLeft tool item on the image editor view.
Property UIImage * rotateRightIcon Gets or sets the icon showed on RotateRight tool item on the image editor view.
Property UIImage * flipIcon Gets or sets the icon showed on Flip tool item on the image editor view.
Property UIImage * mirrorIcon Gets or sets the icon showed on Mirror tool item on the image editor view.
Property UIImage * cropIcon Gets or sets the icon showed on Crop tool item on the image editor view.
Property UIImage * cropCancelIcon Gets or sets the icon showed on Cancel tool item of the Crop view after tapping the Crop tool item.
Property UIImage * cropOKIcon Gets or sets the icon showed on OK tool item of the Crop view after tapping the Crop tool item.
Property UIImage * brightnessContrastIcon Gets or sets the icon showed on the Brightness and Contrast tool item on the image editor view.
Property NSString* brightnessText Gets or sets the text showed on the Brightness tool item on the image editor view. The default value is "Brightness".
Property NSString* contrastText Gets or sets the text showed on the Contrast tool item on the image editor view. The default value is "Contrast".
Property NSString * cancelText Gets or sets the text showed on the Cancel tool item on the image editor view. The default value is "OK".
Property NSString * okText Gets or sets the text showed on the OK tool item on the image editor view. The default value is "OK".
delegate (void) onCancelTapped: (id) sender The event is fired when the cancel tool item is clicked.
delegate (void) onOkTapped: (id) sender The event is fired when the OK tool item is clicked.
Method (void) adjustContrast:
(NSInteger) contrast
Adjusts the contrast of the image.
Method (void) adjustBrightness:
(NSInteger) brightness
Adjusts the brightness of the image.
Method (void) rotateLeft Rotates the image in the editor by 90 degrees counter-clockwise.
Method (void) rotateRight Rotates the image in the editor by 90 degrees clockwise.
Method (void) flip Flips the image in the editor vertically (as opposed to mirror).
Method (void) mirror Mirrors the image in the editor.
Method (void) cut: (NSInteger) x1
top: (NSInteger) y1 right: (NSInteger) x2 bottom: (NSInteger) y2
Cuts an area of the image. The remaining area is left as white once cut.
Method (void) crop: (NSInteger) x1
top: (NSInteger) y1 right: (NSInteger) x2 bottom: (NSInteger) y2
Crops an image in the editor.
Method (void) save Saves the changes made to the image.
Method (void) discard Discards the changes made to the image.
typedef 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.
(nonatomic, assign) DcsViewEnum nextViewAfterCancel
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 view redirects to the video view.

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

If it's set to DVE_EDITORVIEW, when the cancel button is clicked, the current view remains the same.

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

(nonatomic, assign) DcsViewEnum nextViewAfterOK
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 view redirects to the video view.

If it's set to DVE_IMAGEGALLERYVIEW, when the OK button is clicked, the current view redirects to the image gallery view.

If it's set to DVE_EDITORVIEW, when the OK button is clicked, the current view remains the same.

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

(nonatomic, strong) UIImage * rotateIcon
Description Gets or sets the icon showed on Rotate tool item on the image editor view.
Remarks

If it is set to nil, no icon will be showed on the Rotate tool item on the image editor view.

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

(nonatomic, strong) UIImage * rotateLeftIcon
Description Gets or sets the icon showed on RotateLeft tool item on the image editor view.
Remarks

If it is set to nil, no icon will be showed on the RotateLeft tool item on the image editor view.

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

(nonatomic, strong) UIImage * rotateRightIcon
Description Gets or sets the icon showed on RotateRight tool item on the image editor view.
Remarks

If it is set to nil, no icon will be showed on the RotateRight tool item on the image editor view.

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

(nonatomic, strong) UIImage * flipIcon
Description Gets or sets the icon showed on Flip tool item on the image editor view.
Remarks

If it is set to nil, no icon will be showed on the Flip tool item on the image editor view.

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

(nonatomic, strong) UIImage * mirrorIcon
Description Gets or sets the icon showed on Mirror tool item on the image editor view.
Remarks

If it is set to nil, no icon will be showed on the Mirror tool item on the image editor view.

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

(nonatomic, strong) UIImage * cropIcon
Description Gets or sets the icon showed on Crop tool item on the image editor view.
Remarks

If it is set to nil, no icon will be showed on the Crop tool item on the image editor view.

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

(nonatomic, strong) UIImage * cropCancelIcon
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.

(nonatomic, strong) UIImage * cropOKIcon
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.

(nonatomic, strong) UIImage * brightnessContrastIcon
Description Gets or sets the icon showed on Brightness and Contrast tool item on the image editor view.
Remarks

If it is set to nil, no icon will be showed on the Brightness and Contrast tool item on the image editor view.

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

(nonatomic, strong) NSString * brightnessText
Description Gets or sets the text showed on the Brightness tool item on the image editor view. 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 view.

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

(nonatomic, strong) NSString * contrastText
Description Gets or sets the text showed on the Contrast tool item on the image editor view. 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 view.

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

(nonatomic, strong) NSString * cancelText
Description Gets or sets the text showed on the Cancel tool item on the document editor view. 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 view.

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

(nonatomic, strong) NSString * okText
Description Gets or sets the text showed on the OK tool item on the document editor view. 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 view.

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