IOSUiSettings class
A helper class provides properties that can be used to customize the cropper view on iOS.
The properties is mapped to properties of TOCropViewController
class in
TOCropViewController library.
- Inheritance
-
- Object
- PlatformUiSettings
- IOSUiSettings
Constructors
- IOSUiSettings({double? minimumAspectRatio, double? rectX, double? rectY, double? rectWidth, double? rectHeight, bool? showActivitySheetOnDone, bool showCancelConfirmationDialog = false, bool rotateClockwiseButtonHidden = false, bool rotateButtonsHidden = false, bool resetButtonHidden = false, bool aspectRatioPickerButtonHidden = false, bool resetAspectRatioEnabled = true, bool aspectRatioLockDimensionSwapEnabled = false, bool aspectRatioLockEnabled = false, String? title, String? doneButtonTitle, String? cancelButtonTitle})
Properties
- aspectRatioLockDimensionSwapEnabled → bool
-
If true, a custom aspect ratio is set, and the aspectRatioLockEnabled is set to true, the crop box
will swap it's dimensions depending on portrait or landscape sized images.
This value also controls whether the dimensions can swap when the image is rotated.
final
- aspectRatioLockEnabled → bool
-
If true, while it can still be resized, the crop box will be locked to its current aspect ratio.
final
- aspectRatioPickerButtonHidden → bool
-
When enabled, hides the 'Aspect Ratio Picker' button on the toolbar.
(default is false)
final
- cancelButtonTitle → String?
-
Title for the 'Cancel' button.
Setting this will override the Default which is a localized string for "Cancel".
final
- doneButtonTitle → String?
-
Title for the 'Done' button.
Setting this will override the Default which is a localized string for "Done".
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
If this controller is embedded in UINavigationController its navigation bar
is hidden by default. Set this property to false to show the navigation bar.
This must be set before this controller is presented.
final
- minimumAspectRatio → double?
-
The minimum croping aspect ratio. If set, user is prevented from setting
cropping rectangle to lower aspect ratio than defined by the parameter.
final
- rectHeight → double?
-
final
- rectWidth → double?
-
final
- rectX → double?
-
The initial rect of cropping.
final
- rectY → double?
-
final
- resetAspectRatioEnabled → bool
-
If true, tapping the reset button will also reset the aspect ratio back to the image
default ratio. Otherwise, the reset will just zoom out to the current aspect ratio.
final
- resetButtonHidden → bool
-
When enabled, hides the 'Reset' button on the toolbar.
(default is false)
final
- rotateButtonsHidden → bool
-
When enabled, hides the rotation button, as well as the alternative rotation
button visible when
showClockwiseRotationButton
is set to YES. (default is false)final - rotateClockwiseButtonHidden → bool
-
When disabled, an additional rotation button that rotates the canvas in
90-degree segments in a clockwise direction is shown in the toolbar.
(default is false)
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showActivitySheetOnDone → bool?
-
If true, when the user hits 'Done', a UIActivityController will appear
before the view controller ends.
final
- showCancelConfirmationDialog → bool
-
Shows a confirmation dialog when the user hits 'Cancel' and there are pending changes.
(default is false)
final
- title → String?
-
Title text that appears at the top of the view controller.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited