Atalasoft MobileImage API Reference
Protected Types | Properties | List of all members
kfxKUICaptureMessage Class Reference

This class renders the messages on the Imagecapturecontrol. More...

#import <kfxKUICaptureMessage.h>

Inheritance diagram for kfxKUICaptureMessage:

Protected Types

enum  kfxKUIMessageOrientation { kfxKUIMessageOrientationPortrait = 1, kfxKUIMessageOrientationPortraitUpsideDown = 2, kfxKUIMessageOrientationLandscapeLeft = 3, kfxKUIMessageOrientationLandscapeRight = 4 }
 An enumeration to control the orientation of the messages. More...
 

Properties

UIColor * textColor
 The color used to display the text. More...
 
UIColor * backGroundColor
 The color used to display the background of the message. More...
 
UIFont * font
 The font used to display the text. More...
 
NSString * message
 The text of the message. More...
 
CGPoint position
 The postion (center) of the text message. More...
 
CGSize size
 The Size of the text message. More...
 
BOOL hidden
 The visibility of the message. More...
 
kfxKUIMessageOrientation orientation
 Variable to take wanted orientation. More...
 
NSArray * messageIcons
 The sequence of images for animation. More...
 
UIImage * backGround
 The background image of the message. More...
 

Detailed Description

This class renders the messages on the Imagecapturecontrol.

This class is responsible for rendering the messages on the Imagecapturecontrol. It allows the attributes of the messages to be configured and hence enhance the visual feedback to the user.

The messages are sub views of Image Capture Control. If you have custom sizes for the control and see that messages are out of the control due to the size you can configure imagecapturecontrol clipsToBounds property to YES.

Objects which present kfxKUICaptureMessage objects as properties may initialize default messages with settings different than the defaults documented here.

Member Enumeration Documentation

- (enum) kfxKUIMessageOrientation
protected

An enumeration to control the orientation of the messages.

Use one of the values of this enumeration to set the orientation of the messages displayed. Once a mode is set they stay in that mode even if the device rotates. In other words, this orientation set is sticky. If you want to handle the rotation when device rotates, orientation has to be explicitly set again on the respective message.

Enumerator
kfxKUIMessageOrientationPortrait 
kfxKUIMessageOrientationPortraitUpsideDown 
kfxKUIMessageOrientationLandscapeLeft 
kfxKUIMessageOrientationLandscapeRight 

Property Documentation

- (UIImage*) backGround
readwritenonatomicstrong

The background image of the message.

Specifies the background image that the message will be rendered with. If the value is set, it will override backGroundColor. The image will be scaled with aspect to fill the message view. The default value is nil and backGroundColor will be used instead.

- (UIColor*) backGroundColor
readwritenonatomicstrong

The color used to display the background of the message.

Specifies the color that the message's background will be rendered with. The full area specified by the size property will be filled with the background color, excluding areas clipped outside of view bounds.

If backGround is set, the backGroundColor will be ignored.

The default background color is transparent.

- (UIFont*) font
readwritenonatomicstrong

The font used to display the text.

Specifies the font and size that the message's text will be rendered with.

The default font is size 20 HelveticaNeue.

- (BOOL) hidden
readwritenonatomicassign

The visibility of the message.

Specifies whether the message is visible or not. A value of "YES" or "true" will prevent the message from appearing. A value of "NO" or "false" will show the message, if there is nothing else to prevent it from appearing.

The default value is NO. Some objects that use messages, like the capture experience objects, will automatically manage and update this state.

- (NSString*) message
readwritenonatomicstrong

The text of the message.

Specifies the text of the message.

The default message is the empty string. You must set a message for anything to be displayed.

- (NSArray*) messageIcons
readwritenonatomicstrong

The sequence of images for animation.

Specifies an array of images used to show an animation, in addition to the text message. The animation is a repeating sequence of images. By default is nil and no animation will be displayed.

- (kfxKUIMessageOrientation) orientation
readwritenonatomicassign

Variable to take wanted orientation.

Set one of the values in the enum kfxKUIMessageOrientation to set a sticky orientation. The default value would is kfxKUIMessageOrientationLandscapeLeft.

See also
kfxKUIMessageOrientation
- (CGPoint) position
readwritenonatomicassign

The postion (center) of the text message.

The message object will be overlayed on top of an Image Capture Control with the center of the message being located at this coordinate. Changes in the size of the capture control will usually require updating the position of the message as well.

The default position is (0,0), which will render most of the message outside of the view boundaries. You must set an appropriate position for your message. If no position is explicitly set, some managers of message objects may treat it as an "auto" position and dynamically pick a position suitable for the parent view. Once a position is set, this auto quality will be lost.

See also
size
- (CGSize) size
readwritenonatomicassign

The Size of the text message.

The message object will be rendered with dimensions specified by this property. Text will be contained within this boundary, and any set background color will completely cover this area.

The default size is (150, 40), appropriate for small labels. This default is somewhat arbitrary, and you should set a size appropriate for your message content and the size of the control it will be displayed over.

See also
position
backGroundColor
- (UIColor*) textColor
readwritenonatomicstrong

The color used to display the text.

Specifies the color that the message's text will be rendered with.

The default color is white.


The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.