Mobile API Reference  MicroStrategy 2019
AnnotationContext.h
Go to the documentation of this file.
1 //
2 // AnnotationContext.h
3 // MicroStrategyMobile
4 //
5 // Created by Han Sun on 12/12/11.
6 // Copyright (c) 2011 MicroStrategy Inc. All rights reserved.
7 
8 #import <Foundation/Foundation.h>
9 
10 // The maximum number of comment box on iPad and iPhone. Defined in AnnotationCanvasViewer.mm
11 extern const int ANNOTATION_MAXIMUM_COMMENT_IPAD;
12 extern const int ANNOTATION_MAXIMUM_COMMENT_IPHONE;
13 
14 // Represent the current annotation mode. yzeng
15 typedef enum AnnotationMode {
16  AnnotationModeUnspecified = -1,// initial value
17  AnnotationModeDraw = 0, // draw mode
18  AnnotationModeComment = 1, // comment mode
19  AnnotationModeLockDrawing = 2, // a mode that user can move his finger on the screen but will not trigger drawing.
21 
22 // Represent the current chose shape. yzeng
23 typedef enum AnnotationShape {
24  AnnotationShapeUnspecified = -1, // initial value
25  AnnotationShapeAdHocStroke = 0, // free drawing
26  AnnotationShapeHandWritingOval = 1, // a fancy hand-writing oval
27  AnnotationShapeOval = 2, // oval
28  AnnotationShapeRectangle = 3, // rectangle
32 
33 // Represent the stroke style. yzeng
34 typedef enum AnnotationStrokeStyle {
35  AnnotationStrokeStyleNoAngle = 0, // a stroke always with the same width
36  AnnotationStrokeStyleAngled = 1, // a stroke considering angle like a pen
38 
39 // Represent the current used spec. This is just a temporary enum, and should not used in product. yzeng
40 typedef enum AnnotationSpec {
45 
46 @interface AnnotationContext : NSObject <NSCopying, NSCoding>{
48 
49  // For draw (shape)
51  UIColor* mStrokeColor;
52  CGFloat mStrokeWidth;
54 
55  // For comment box
56  UIColor* mTextColor;
57  CGFloat mFontSize;
58  NSString* mFontName;
60 
62 }
63 
64 @property (nonatomic) AnnotationMode annotationMode;
65 @property (nonatomic) AnnotationShape annotationShape;
66 @property (nonatomic, strong) UIColor* strokeColor;
67 @property (nonatomic) CGFloat strokeWidth;
68 @property (nonatomic) AnnotationStrokeStyle strokeStyle;
69 @property (nonatomic, strong) UIColor* textColor;
70 @property (nonatomic) CGFloat fontSize;
71 @property (nonatomic, strong) NSString* fontName;
72 @property (nonatomic, strong) UIColor* commentBoxBackgroundColor;
73 @property (nonatomic) AnnotationSpec annotationSpec;
74 
75 + (UIColor*)getItemsTintColor;
76 @end
Definition: AnnotationContext.h:26
Definition: AnnotationContext.h:28
UIColor * mStrokeColor
Definition: AnnotationContext.h:51
const int ANNOTATION_MAXIMUM_COMMENT_IPAD
Definition: AnnotationContext.h:41
AnnotationMode mAnnotationMode
Definition: AnnotationContext.h:47
AnnotationSpec mAnnotationSpec
Definition: AnnotationContext.h:61
Definition: AnnotationContext.h:24
Definition: AnnotationContext.h:27
Definition: AnnotationContext.h:30
Definition: AnnotationContext.h:18
AnnotationStrokeStyle
Definition: AnnotationContext.h:34
Definition: AnnotationContext.h:16
Definition: AnnotationContext.h:35
Definition: AnnotationContext.h:42
AnnotationStrokeStyle mStrokeStyle
Definition: AnnotationContext.h:53
AnnotationSpec
Definition: AnnotationContext.h:40
CGFloat mFontSize
Definition: AnnotationContext.h:57
Definition: AnnotationContext.h:36
Definition: AnnotationContext.h:46
NSString * mFontName
Definition: AnnotationContext.h:58
const int ANNOTATION_MAXIMUM_COMMENT_IPHONE
Definition: AnnotationContext.h:17
Definition: AnnotationContext.h:19
Definition: AnnotationContext.h:29
Definition: AnnotationContext.h:43
UIColor * mCommentBoxBackgroundColor
Definition: AnnotationContext.h:59
AnnotationMode
Definition: AnnotationContext.h:15
UIColor * mTextColor
Definition: AnnotationContext.h:56
AnnotationShape mAnnotationShape
Definition: AnnotationContext.h:50
CGFloat mStrokeWidth
Definition: AnnotationContext.h:52
AnnotationShape
Definition: AnnotationContext.h:23
Definition: AnnotationContext.h:25