diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 8a812a9..0000000 Binary files a/.DS_Store and /dev/null differ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2e41246 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +# OS generated files # +###################### +.DS_Store +*~ +*.bak + +# XCODE generated files # +######################### +project.xcworkspace/ +xcuserdata/ + +# DOXYGEN generated files # +######################### +html/ diff --git a/ADVProgressBar.xcodeproj/project.pbxproj b/ADVProgressBar.xcodeproj/project.pbxproj index 1653879..258ef0f 100644 --- a/ADVProgressBar.xcodeproj/project.pbxproj +++ b/ADVProgressBar.xcodeproj/project.pbxproj @@ -7,6 +7,18 @@ objects = { /* Begin PBXBuildFile section */ + 923367A916D7227500F899BA /* Default-568h@2x.png in Resources */ = {isa = PBXBuildFile; fileRef = 923367A816D7227500F899BA /* Default-568h@2x.png */; }; + 924FC2C816D4930100D3F305 /* storyboard3.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 924FC2C616D4930100D3F305 /* storyboard3.jpg */; }; + 924FC2C916D4930100D3F305 /* storyboard4.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 924FC2C716D4930100D3F305 /* storyboard4.jpg */; }; + 92972F3216D0ACD8009F08AA /* storyboard0.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 92972F2F16D0ACD8009F08AA /* storyboard0.jpg */; }; + 92972F3316D0ACD8009F08AA /* storyboard1.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 92972F3016D0ACD8009F08AA /* storyboard1.jpg */; }; + 92972F3416D0ACD8009F08AA /* storyboard2.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 92972F3116D0ACD8009F08AA /* storyboard2.jpg */; }; + 92E4108116CFC53D00137E40 /* screenshot.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 92E4108016CFC53D00137E40 /* screenshot.jpg */; }; + 92EC8ECD16C0BBC20087B43B /* mainpage.dox in Resources */ = {isa = PBXBuildFile; fileRef = 92EC8ECC16C0BBC20087B43B /* mainpage.dox */; }; + 92ED54B116AC27F0006A1C73 /* LICENSE.txt in Resources */ = {isa = PBXBuildFile; fileRef = 92ED54AF16AC27F0006A1C73 /* LICENSE.txt */; }; + 92ED54B216AC27F0006A1C73 /* README.md in Resources */ = {isa = PBXBuildFile; fileRef = 92ED54B016AC27F0006A1C73 /* README.md */; }; + 92EE065B16D33F9100D3A01D /* editorMenu.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 92EE065A16D33F9100D3A01D /* editorMenu.jpg */; }; + 92EEEEDB16BF57DA007610B9 /* Doxyfile in Resources */ = {isa = PBXBuildFile; fileRef = 92EEEE7C16BF57DA007610B9 /* Doxyfile */; }; ECE9A478150A435E0076F0C5 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = ECE9A477150A435E0076F0C5 /* UIKit.framework */; }; ECE9A47A150A435E0076F0C5 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = ECE9A479150A435E0076F0C5 /* Foundation.framework */; }; ECE9A47C150A435E0076F0C5 /* CoreGraphics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = ECE9A47B150A435E0076F0C5 /* CoreGraphics.framework */; }; @@ -31,6 +43,18 @@ /* End PBXBuildFile section */ /* Begin PBXFileReference section */ + 923367A816D7227500F899BA /* Default-568h@2x.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; name = "Default-568h@2x.png"; path = "../../Default-568h@2x.png"; sourceTree = ""; }; + 924FC2C616D4930100D3F305 /* storyboard3.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = storyboard3.jpg; sourceTree = ""; }; + 924FC2C716D4930100D3F305 /* storyboard4.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = storyboard4.jpg; sourceTree = ""; }; + 92972F2F16D0ACD8009F08AA /* storyboard0.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = storyboard0.jpg; sourceTree = ""; }; + 92972F3016D0ACD8009F08AA /* storyboard1.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = storyboard1.jpg; sourceTree = ""; }; + 92972F3116D0ACD8009F08AA /* storyboard2.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = storyboard2.jpg; sourceTree = ""; }; + 92E4108016CFC53D00137E40 /* screenshot.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = screenshot.jpg; sourceTree = ""; }; + 92EC8ECC16C0BBC20087B43B /* mainpage.dox */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = mainpage.dox; sourceTree = ""; }; + 92ED54AF16AC27F0006A1C73 /* LICENSE.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = LICENSE.txt; sourceTree = ""; }; + 92ED54B016AC27F0006A1C73 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = README.md; sourceTree = ""; }; + 92EE065A16D33F9100D3A01D /* editorMenu.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = editorMenu.jpg; sourceTree = ""; }; + 92EEEE7C16BF57DA007610B9 /* Doxyfile */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = Doxyfile; sourceTree = ""; }; ECE9A473150A435E0076F0C5 /* ADVProgressBar.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = ADVProgressBar.app; sourceTree = BUILT_PRODUCTS_DIR; }; ECE9A477150A435E0076F0C5 /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = System/Library/Frameworks/UIKit.framework; sourceTree = SDKROOT; }; ECE9A479150A435E0076F0C5 /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = System/Library/Frameworks/Foundation.framework; sourceTree = SDKROOT; }; @@ -74,14 +98,41 @@ /* End PBXFrameworksBuildPhase section */ /* Begin PBXGroup section */ + 92EC8ECF16C0C92C0087B43B /* Resources */ = { + isa = PBXGroup; + children = ( + 924FC2C616D4930100D3F305 /* storyboard3.jpg */, + 924FC2C716D4930100D3F305 /* storyboard4.jpg */, + 92EE065A16D33F9100D3A01D /* editorMenu.jpg */, + 92972F2F16D0ACD8009F08AA /* storyboard0.jpg */, + 92972F3016D0ACD8009F08AA /* storyboard1.jpg */, + 92972F3116D0ACD8009F08AA /* storyboard2.jpg */, + 92E4108016CFC53D00137E40 /* screenshot.jpg */, + ); + path = Resources; + sourceTree = ""; + }; + 92EEEE7B16BF57DA007610B9 /* DoxyDoc */ = { + isa = PBXGroup; + children = ( + 92EC8ECF16C0C92C0087B43B /* Resources */, + 92EC8ECC16C0BBC20087B43B /* mainpage.dox */, + 92EEEE7C16BF57DA007610B9 /* Doxyfile */, + ); + path = DoxyDoc; + sourceTree = ""; + }; ECE9A468150A435E0076F0C5 = { isa = PBXGroup; children = ( - ECE9A4B5150A48240076F0C5 /* Classes */, - ECE9A498150A446C0076F0C5 /* Resources */, + 92ED54B016AC27F0006A1C73 /* README.md */, + 92ED54AF16AC27F0006A1C73 /* LICENSE.txt */, ECE9A47D150A435E0076F0C5 /* ADVProgressBar */, + ECE9A4B5150A48240076F0C5 /* Classes */, + 92EEEE7B16BF57DA007610B9 /* DoxyDoc */, ECE9A476150A435E0076F0C5 /* Frameworks */, ECE9A474150A435E0076F0C5 /* Products */, + ECE9A498150A446C0076F0C5 /* Resources */, ); sourceTree = ""; }; @@ -130,6 +181,7 @@ ECE9A498150A446C0076F0C5 /* Resources */ = { isa = PBXGroup; children = ( + 923367A816D7227500F899BA /* Default-568h@2x.png */, ECE9A499150A446C0076F0C5 /* progress-count.png */, ECE9A49A150A446C0076F0C5 /* progress-count@2x.png */, ECE9A49B150A446C0076F0C5 /* progress-fill-blue.png */, @@ -220,6 +272,18 @@ ECE9A4AE150A446C0076F0C5 /* progress-fill-red@2x.png in Resources */, ECE9A4AF150A446C0076F0C5 /* progress-track.png in Resources */, ECE9A4B0150A446C0076F0C5 /* progress-track@2x.png in Resources */, + 92ED54B116AC27F0006A1C73 /* LICENSE.txt in Resources */, + 92ED54B216AC27F0006A1C73 /* README.md in Resources */, + 92EEEEDB16BF57DA007610B9 /* Doxyfile in Resources */, + 92EC8ECD16C0BBC20087B43B /* mainpage.dox in Resources */, + 92E4108116CFC53D00137E40 /* screenshot.jpg in Resources */, + 92972F3216D0ACD8009F08AA /* storyboard0.jpg in Resources */, + 92972F3316D0ACD8009F08AA /* storyboard1.jpg in Resources */, + 92972F3416D0ACD8009F08AA /* storyboard2.jpg in Resources */, + 92EE065B16D33F9100D3A01D /* editorMenu.jpg in Resources */, + 924FC2C816D4930100D3F305 /* storyboard3.jpg in Resources */, + 924FC2C916D4930100D3F305 /* storyboard4.jpg in Resources */, + 923367A916D7227500F899BA /* Default-568h@2x.png in Resources */, ); runOnlyForDeploymentPostprocessing = 0; }; diff --git a/ADVProgressBar.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/ADVProgressBar.xcodeproj/project.xcworkspace/contents.xcworkspacedata deleted file mode 100644 index 3dd860c..0000000 --- a/ADVProgressBar.xcodeproj/project.xcworkspace/contents.xcworkspacedata +++ /dev/null @@ -1,7 +0,0 @@ - - - - - diff --git a/ADVProgressBar.xcodeproj/project.xcworkspace/xcuserdata/tope.xcuserdatad/UserInterfaceState.xcuserstate b/ADVProgressBar.xcodeproj/project.xcworkspace/xcuserdata/tope.xcuserdatad/UserInterfaceState.xcuserstate deleted file mode 100644 index c4517bc..0000000 Binary files a/ADVProgressBar.xcodeproj/project.xcworkspace/xcuserdata/tope.xcuserdatad/UserInterfaceState.xcuserstate and /dev/null differ diff --git a/ADVProgressBar.xcodeproj/xcuserdata/tope.xcuserdatad/xcschemes/ADVProgressBar.xcscheme b/ADVProgressBar.xcodeproj/xcuserdata/tope.xcuserdatad/xcschemes/ADVProgressBar.xcscheme deleted file mode 100644 index b836eaa..0000000 --- a/ADVProgressBar.xcodeproj/xcuserdata/tope.xcuserdatad/xcschemes/ADVProgressBar.xcscheme +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ADVProgressBar.xcodeproj/xcuserdata/tope.xcuserdatad/xcschemes/xcschememanagement.plist b/ADVProgressBar.xcodeproj/xcuserdata/tope.xcuserdatad/xcschemes/xcschememanagement.plist deleted file mode 100644 index dc9cf58..0000000 --- a/ADVProgressBar.xcodeproj/xcuserdata/tope.xcuserdatad/xcschemes/xcschememanagement.plist +++ /dev/null @@ -1,22 +0,0 @@ - - - - - SchemeUserState - - ADVProgressBar.xcscheme - - orderHint - 0 - - - SuppressBuildableAutocreation - - ECE9A472150A435E0076F0C5 - - primary - - - - - diff --git a/ADVProgressBar/.DS_Store b/ADVProgressBar/.DS_Store deleted file mode 100644 index aaddb57..0000000 Binary files a/ADVProgressBar/.DS_Store and /dev/null differ diff --git a/ADVProgressBar/ADVProgressBar-Info.plist b/ADVProgressBar/ADVProgressBar-Info.plist index 8e00dd4..5e69368 100644 --- a/ADVProgressBar/ADVProgressBar-Info.plist +++ b/ADVProgressBar/ADVProgressBar-Info.plist @@ -11,7 +11,7 @@ CFBundleIconFiles CFBundleIdentifier - com.appdesign.${PRODUCT_NAME:rfc1034identifier} + com.github.corerd.${PRODUCT_NAME:rfc1034identifier} CFBundleInfoDictionaryVersion 6.0 CFBundleName diff --git a/ADVProgressBar/ADVViewController.h b/ADVProgressBar/ADVViewController.h index 6cb1873..1a83a14 100644 --- a/ADVProgressBar/ADVViewController.h +++ b/ADVProgressBar/ADVViewController.h @@ -6,8 +6,11 @@ /* The MIT License - Copyright (c) 2011 Tope Abayomi - http://www.appdesignvault.com/ + Original work Copyright (c) 2011 Tope Abayomi + http://www.appdesignvault.com/ + + Modified work Copyright (c) 2013 Corrado Ubezio + https://github.com/corerd/ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -28,13 +31,40 @@ THE SOFTWARE. */ +/*! + ADVPercentProgressBar demo. + + Demonstrate how to create and instantiate a bunch of ADVPercentProgressBar + custom views. + They are added to the View Controller in the two ways: + - programmatically; + - from a nib or storyboard. + */ + #import +#import "ADVPercentProgressBar.h" + +@interface ADVViewController : UIViewController -@interface ADVViewController : UIViewController +/// An ADVPercentProgressBar showing the integral value. +@property (weak, nonatomic) IBOutlet ADVPercentProgressBar *pbRangeValue; +/// An ADVPercentProgressBar showing the percentage of the value. +@property (weak, nonatomic) IBOutlet ADVPercentProgressBar *pbRangePercent; -@property (nonatomic, strong) NSArray* progressBars; --(IBAction)sliderValueChanged:(UISlider*)sender; +/*! + Action on sliding. + + Get the value changed sliding along the track. + + The value is returned in the range 0.0 - 1.0 and is used to animate the + ADVPercentProgressBar views. + + @param sender + Slider that is sending the action message. + */ +- (IBAction)sliderValueChanged:(UISlider *)sender; + @end diff --git a/ADVProgressBar/ADVViewController.m b/ADVProgressBar/ADVViewController.m index ba33e13..6b343ed 100644 --- a/ADVProgressBar/ADVViewController.m +++ b/ADVProgressBar/ADVViewController.m @@ -6,9 +6,12 @@ /* The MIT License - Copyright (c) 2011 Tope Abayomi + Original work Copyright (c) 2011 Tope Abayomi http://www.appdesignvault.com/ + Modified work Copyright (c) 2013 Corrado Ubezio + https://github.com/corerd/ + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights @@ -29,12 +32,14 @@ of this software and associated documentation files (the "Software"), to deal */ #import "ADVViewController.h" -#import "ADVPercentProgressBar.h" @implementation ADVViewController +{ + NSArray* percentProgressBars; + NSArray* integralProgressBars; +} -@synthesize progressBars; - (void)didReceiveMemoryWarning { @@ -47,91 +52,101 @@ - (void)didReceiveMemoryWarning - (void)viewDidLoad { - ADVPercentProgressBar *blueprogressBar = [[ADVPercentProgressBar alloc] initWithFrame:CGRectMake(10, 30, 292, 28) andProgressBarColor:ADVProgressBarBlue]; + ADVPercentProgressBar *blueprogressBar = + [[ADVPercentProgressBar alloc] initWithFrame:CGRectMake(10, 30, 292, 56) + andProgressBarColor:ADVProgressBarBlue]; - [blueprogressBar setProgress:0.5]; + [blueprogressBar setShowPercent:NO]; + [blueprogressBar setMinProgressValue:0]; + [blueprogressBar setMaxProgressValue:500]; + [blueprogressBar setProgress:[blueprogressBar minProgressValue] + + ([blueprogressBar maxProgressValue] - + [blueprogressBar minProgressValue])/2 + ]; [self.view addSubview:blueprogressBar]; - - ADVPercentProgressBar *greenprogressBar = [[ADVPercentProgressBar alloc] initWithFrame:CGRectMake(10, 80, 292, 28) andProgressBarColor:ADVProgressBarGreen]; - + ADVPercentProgressBar *greenprogressBar = + [[ADVPercentProgressBar alloc] initWithFrame:CGRectMake(10, 90, 292, 28) + andProgressBarColor:ADVProgressBarGreen]; [greenprogressBar setProgress:0.5]; [self.view addSubview:greenprogressBar]; - ADVPercentProgressBar *redProgressBar = [[ADVPercentProgressBar alloc] initWithFrame:CGRectMake(10, 130, 292, 28) andProgressBarColor:ADVProgressBarRed]; + ADVPercentProgressBar *redProgressBar = + [[ADVPercentProgressBar alloc] initWithFrame:CGRectMake(10, 125, 292, 56) + andProgressBarColor:ADVProgressBarRed]; - [redProgressBar setProgress:0.5]; + [redProgressBar setShowPercent:NO]; + [redProgressBar setMinProgressValue:200]; + [redProgressBar setMaxProgressValue:400]; + [redProgressBar setProgress:[redProgressBar minProgressValue] + + ([redProgressBar maxProgressValue] - + [redProgressBar minProgressValue])/2 + ]; [self.view addSubview:redProgressBar]; - ADVPercentProgressBar *brownProgressPar = [[ADVPercentProgressBar alloc] initWithFrame:CGRectMake(10, 180, 292, 28) andProgressBarColor:ADVProgressBarBrown]; - + ADVPercentProgressBar *brownProgressPar = + [[ADVPercentProgressBar alloc] initWithFrame:CGRectMake(10, 185, 292, 28) + andProgressBarColor:ADVProgressBarBrown]; [brownProgressPar setProgress:0.5]; [self.view addSubview:brownProgressPar]; - progressBars = [NSArray arrayWithObjects:blueprogressBar, redProgressBar, greenprogressBar, brownProgressPar, nil]; - - - UISlider* slider = [[UISlider alloc] initWithFrame:CGRectMake(10, 230, 292, 28)]; - - [slider setMaximumValue:1.0]; - [slider setMinimumValue:0.0]; - [slider setValue:0.5]; - [slider addTarget:self action:@selector(sliderValueChanged:) forControlEvents:UIControlEventValueChanged]; - - - [self.view addSubview:slider]; - - UILabel *label = [[UILabel alloc] initWithFrame:CGRectMake(10, 280, 292, 28)]; - [label setText:@"Move the slider to see the Progress bars in action"]; - [label setBackgroundColor:[UIColor clearColor]]; - [label setFont:[UIFont systemFontOfSize:12]]; + [self.view setBackgroundColor:[UIColor colorWithHue:0.0 + saturation:0.0 + brightness:0.93 + alpha:1.0] + ]; - [self.view addSubview:label]; - UIWebView *webView = [[UIWebView alloc] initWithFrame:CGRectMake(0, 420, 320, 40)]; - - [webView setBackgroundColor:[UIColor clearColor]]; - [webView setOpaque:NO]; - [webView setDelegate:self]; - [webView loadHTMLString:@"http://www.appdesignvault.com" baseURL:nil]; - - [self.view addSubview:webView]; + [super viewDidLoad]; + // Do any additional setup after loading the view, typically from a nib. - [self.view setBackgroundColor:[UIColor colorWithHue:0.0 saturation:0.0 brightness:0.93 alpha:1.0]]; + // ADVPercentProgressBar views loaded from storyboard + // properties MUST be set here... - [super viewDidLoad]; - // Do any additional setup after loading the view, typically from a nib. -} + [self.pbRangeValue setShowPercent:NO]; + [self.pbRangeValue setMinProgressValue:300]; + [self.pbRangeValue setMaxProgressValue:600]; + [self.pbRangeValue setProgressBarColor:ADVProgressBarRed]; + [self.pbRangeValue setProgress:[self.pbRangeValue minProgressValue] + + ([self.pbRangeValue maxProgressValue]-[self.pbRangeValue minProgressValue])/2]; --(BOOL) webView:(UIWebView *)inWeb shouldStartLoadWithRequest:(NSURLRequest *)inRequest navigationType:(UIWebViewNavigationType)inType { - if ( inType == UIWebViewNavigationTypeLinkClicked ) { - [[UIApplication sharedApplication] openURL:[inRequest URL]]; - return NO; - } + self.pbRangePercent.progress = 0.5; + + integralProgressBars = [NSArray arrayWithObjects:blueprogressBar, + redProgressBar, self.pbRangeValue, nil]; - return YES; + percentProgressBars = [NSArray arrayWithObjects:greenprogressBar, + brownProgressPar, self.pbRangePercent, nil]; } - -(IBAction)sliderValueChanged:(UISlider*)sender { - for (ADVPercentProgressBar * progressBar in progressBars) + for (ADVPercentProgressBar * valueProgressBar in integralProgressBars) + { + [valueProgressBar setProgress:[valueProgressBar minProgressValue] + + ([valueProgressBar maxProgressValue] - + [valueProgressBar minProgressValue]) * sender.value + ]; + } + for (ADVPercentProgressBar * percentProgressBar in percentProgressBars) { - [progressBar setProgress:sender.value]; + [percentProgressBar setProgress:sender.value]; } } - (void)viewDidUnload { + [self setPbRangeValue:nil]; + [self setPbRangePercent:nil]; [super viewDidUnload]; // Release any retained subviews of the main view. // e.g. self.myOutlet = nil; diff --git a/ADVProgressBar/Classes/ADVPercentProgressBar.h b/ADVProgressBar/Classes/ADVPercentProgressBar.h index e97f8a5..3657650 100644 --- a/ADVProgressBar/Classes/ADVPercentProgressBar.h +++ b/ADVProgressBar/Classes/ADVPercentProgressBar.h @@ -6,9 +6,12 @@ /* The MIT License - Copyright (c) 2011 Tope Abayomi + Original work Copyright (c) 2011 Tope Abayomi http://www.appdesignvault.com/ + Modified work Copyright (c) 2013 Corrado Ubezio + https://github.com/corerd/ + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights @@ -28,32 +31,121 @@ THE SOFTWARE. */ +/*! + Define a Custom UIView to depict the progress of a task over time. + + The amount of **progress** is displayed by a horizontal bar, + called **progressImageView**, that represents a range of values. + This range is controlled by the **minProgressValue** and the **maxProgressValue** + properties, whose default values are 0.0 and 1.0 respectively. + + The user can customize the appearance of the **progressImageView** horizontal bar + selecting its color in the **ADVProgressBarColor** set. + + The current **progress** is represented by a floating-point value (default 0.0) + between **minProgressValue** and **maxProgressValue**, inclusive; + values less or greater are pinned to those limits. + + The current **progress** is shown by the position of a cursor, coupled with + the **progressImageView** and called **percentView**; within its bounds, it is + shown a textual indication of the amount of the task that has completed. + The way this indication is displayed, is controlled by the **showPercent** + property: by default its value is `YES` and the current **progress** is + formatted as a percent complete respect the range of values. + + The user can set to `NO` the **showPercent** property to display the integral + amount of the task that has completed. + Since the width of the **progressImageView** cursor is fixed to 3 textual + characters wide, if **maxProgressValue** is greater than 999, then the current + **progress** is formatted as a percent even if the **showPercent** property + is set to `NO`. + + The **showPercent** property isn't taken in account also when the + **maxProgressValue** is less or equal to 1.0: the current **progress** will be + always formatted as a percent. + + This Custom UIView can be created and instantiated both in-code + (programmatically) or via a nib (storyboard). + For this reason, are supported both `initWithFrame:andProgressBarColor:` and + `initWithCoder:` methods respectively. + + CREDITS + + [How is view initialized when loaded via a storyboard] + (http://stackoverflow.com/questions/8373176/how-is-view-initialized-when-loaded-via-a-storyboard) + + [iPhone : Getting the size of an image after AspectFt] + (http://stackoverflow.com/questions/6856879/iphone-getting-the-size-of-an-image-after-aspectft) + */ + #import + +@interface ADVPercentProgressBar : UIView + +// Types + +/// Set of **progressImageView** horizontal bar colors. typedef enum -{ +{ ADVProgressBarGreen, ADVProgressBarRed, ADVProgressBarBrown, ADVProgressBarBlue } ADVProgressBarColor; -@interface ADVPercentProgressBar : UIView { -@private - - UIView* percentView; - - UIImageView *bgImageView; - - UIImageView *progressImageView; - - UIImage *progressFillImage; -} +// Properties +/// The current amount of the task that has completed (default 0.0). @property (nonatomic, readwrite, assign) CGFloat progress; -- (id)initWithFrame:(CGRect)frame andProgressBarColor:(ADVProgressBarColor)barColor; +/// The **progressImageView** horizontal bar color in the **ADVProgressBarColor** set +/// (default ADVProgressBarBlue). +@property (nonatomic, readwrite, assign) ADVProgressBarColor progressBarColor; + +/// Minimum in the range of **progress** values (default 0.0). +@property (nonatomic, readwrite, assign) CGFloat minProgressValue; + +/// Maximum in the range of **progress** values (default 1.0). +@property (nonatomic, readwrite, assign) CGFloat maxProgressValue; + +/// Toggle between percent or integral view of current **progress** +/// (default `YES` = percent) +@property (nonatomic, readwrite, assign) BOOL showPercent; --(NSString*)getImageNameFromBarDefinition:(ADVProgressBarColor)barDef; +// Methods + +/*! + Override `initWithFrame` if the view is added programmatically. + + Initializes and returns a newly allocated `ADVPercentProgressBar` view object. + The view is allocated with the specified frame rectangle and + the **progressImageView** horizontal bar color. + + @param frame + The frame rectangle for the view, measured in points. + The origin of the frame is relative to the superview in which you plan to add it. + + @param barColor + The **progressImageView** horizontal bar color in the **ADVProgressBarColor** set. + + @return + An initialized `ADVPercentProgressBar` view object + or nil if the object couldn't be created. + */ +- (id)initWithFrame:(CGRect)frame +andProgressBarColor:(ADVProgressBarColor)barColor; + + +/*! + Override `initWithCoder` if the view is loaded from a nib or storyboard. + + @param coder + A nib or storyboard object. + + @return + An `ADVPercentProgressBar` initialized from a nib or storyboard. + */ +- (id)initWithCoder:(NSCoder *)coder; @end diff --git a/ADVProgressBar/Classes/ADVPercentProgressBar.m b/ADVProgressBar/Classes/ADVPercentProgressBar.m index c756fc5..bcd1515 100644 --- a/ADVProgressBar/Classes/ADVPercentProgressBar.m +++ b/ADVProgressBar/Classes/ADVPercentProgressBar.m @@ -6,9 +6,12 @@ /* The MIT License - Copyright (c) 2011 Tope Abayomi + Original work Copyright (c) 2011 Tope Abayomi http://www.appdesignvault.com/ + Modified work Copyright (c) 2013 Corrado Ubezio + https://github.com/corerd/ + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights @@ -28,95 +31,249 @@ of this software and associated documentation files (the "Software"), to deal THE SOFTWARE. */ -#define LEFT_PADDING 5.0f -#define RIGHT_PADDING 3.0f #import "ADVPercentProgressBar.h" + +#define PERCENT_VIEW_WIDTH 32.0f +#define PERCENT_VIEW_MIN_HEIGHT 14.0f +#define TOP_PADDING 7.0f +#define LEFT_PADDING 5.0f +#define RIGHT_PADDING 3.0f + @implementation ADVPercentProgressBar +{ + UIView* percentView; + UIImageView *bgImageView; + UIImageView *progressImageView; + UIImage *progressFillImage; + + BOOL customViewFromNIB; + +} + @synthesize progress; +@synthesize progressBarColor; +// Override initWithFrame: if you add the view programmatically. - (id)initWithFrame:(CGRect)frame andProgressBarColor:(ADVProgressBarColor)barColor { - if (self = [super initWithFrame:frame]) + if (self = [super initWithFrame:frame]) { - - NSString* progressFillStr = [self getImageNameFromBarDefinition:barColor]; - - progressFillImage = [UIImage imageNamed:progressFillStr]; - - bgImageView = [[UIImageView alloc] initWithFrame:CGRectMake(0, 0, frame.size.width, frame.size.height)]; - - [bgImageView setImage:[UIImage imageNamed:@"progress-track.png"]]; - - [self addSubview:bgImageView]; - - progressImageView = [[UIImageView alloc] initWithFrame:CGRectMake(1, 0, 0, frame.size.height)]; - - [self addSubview:progressImageView]; - - percentView = [[UIView alloc] initWithFrame:CGRectMake(LEFT_PADDING, 6, 32, 17)]; - - UIImageView* percentImageView = [[UIImageView alloc] initWithFrame:CGRectMake(0, 0, 32, 17)]; - - [percentImageView setImage:[UIImage imageNamed:@"progress-count.png"]]; - - UILabel* percentLabel = [[UILabel alloc] initWithFrame:CGRectMake(0, 0, 32, 17)]; - - [percentLabel setTag:1]; - [percentLabel setText:@"0%"]; - [percentLabel setBackgroundColor:[UIColor clearColor]]; - [percentLabel setFont:[UIFont boldSystemFontOfSize:13]]; - [percentLabel setTextAlignment:UITextAlignmentCenter]; - [percentLabel setAdjustsFontSizeToFitWidth:YES]; - - [percentView addSubview:percentImageView]; - [percentView addSubview:percentLabel]; - - [self addSubview:percentView]; - - self.progress = 0.0f; + customViewFromNIB = NO; + [self ADVProgressBarDraw:frame withProgressBarColor:barColor]; } return self; } +// Override initWithCoder: if you're loading it from a nib or storyboard. +- (id)initWithCoder:(NSCoder *)coder +{ + self = [super initWithCoder:coder]; + if (self) { + customViewFromNIB = YES; + [self ADVProgressBarDraw:self.frame + withProgressBarColor:ADVProgressBarBlue]; + } + + return self; +} -- (void)setProgress:(CGFloat)theProgress { +// Override layoutSubviews: it gets called whenever the frame of the view changes. +- (void)layoutSubviews +{ + [super layoutSubviews]; - if (self.progress != theProgress) { - - if (theProgress >= 0 && theProgress <= 1) { - - progress = theProgress; - - progressImageView.image = progressFillImage; - - CGRect frame = progressImageView.frame; - - frame.origin.x = 2; - frame.origin.y = 2; - frame.size.height = bgImageView.frame.size.height - 4; - - frame.size.width = (bgImageView.frame.size.width - 4) * progress; - - progressImageView.frame = frame; - - CGRect percentFrame = percentView.frame; - - float percentViewWidth = percentView.frame.size.width; - float leftEdge = (progressImageView.frame.size.width - percentViewWidth) - RIGHT_PADDING; - - percentFrame.origin.x = (leftEdge < LEFT_PADDING) ? LEFT_PADDING : leftEdge; - percentView.frame = percentFrame; - - UILabel* percentLabel = (UILabel*)[percentView viewWithTag:1]; - [percentLabel setText:[NSString stringWithFormat:@"%d%%", (int)(progress*100)]]; - + if (customViewFromNIB != YES) { + return; + } + [self progressImageDraw]; +} + +- (void)setProgress:(CGFloat)theProgress +{ + if (self.progress == theProgress) { + return; + } + + // check range and pin to its limits if required + if (theProgress < self.minProgressValue) { + theProgress = self.minProgressValue; + } + if (theProgress > self.maxProgressValue) { + theProgress = self.maxProgressValue; + } + + progress = theProgress; + + [self progressImageDraw]; +} + +- (void)setProgressBarColor:(ADVProgressBarColor)theColor +{ + NSString* progressFillStr = [self getImageNameFromBarDefinition:theColor]; + progressFillImage = [UIImage imageNamed:progressFillStr]; +} + +- (void)ADVProgressBarDraw:(CGRect)frame withProgressBarColor:(ADVProgressBarColor)barColor +{ + if ( (frame.size.width - LEFT_PADDING - RIGHT_PADDING) < PERCENT_VIEW_WIDTH ) { + NSLog(@"ADVProgressBarDraw: Frame width is too small to draw PercentView"); + return; + } + + self.progressBarColor = barColor; + + bgImageView = [[UIImageView alloc] initWithFrame: + CGRectMake( + 0, + 0, + frame.size.width, + frame.size.height ) + ]; + + [bgImageView setImage:[UIImage imageNamed:@"progress-track.png"]]; + + [self addSubview:bgImageView]; + + progressImageView = [[UIImageView alloc] initWithFrame: + CGRectMake( + 1, + 0, + 0, + frame.size.height ) + ]; + + [self addSubview:progressImageView]; + + CGSize bgImageScale; + if (customViewFromNIB == YES) { + bgImageScale = [self getScale:bgImageView.image.size + fitInSize:bgImageView.frame.size + withMode:self.contentMode + ]; + } + else { + bgImageScale = [self getScale:bgImageView.frame.size + fitInSize:bgImageView.image.size + withMode:self.contentMode + ]; + } + + CGFloat topPadding = TOP_PADDING; + if (bgImageScale.height > 1) { + topPadding *= bgImageScale.height; + } + + CGFloat bgImageHeight = bgImageView.frame.size.height; + if (bgImageScale.height < 1) { + bgImageHeight -= (bgImageView.frame.size.height - topPadding) * bgImageScale.height; + } + + CGFloat centerY = bgImageView.center.y; + CGFloat percentViewY = topPadding + centerY - bgImageHeight / 2; + CGFloat percentViewHeight = (centerY - percentViewY)*2; + + if (percentViewHeight < PERCENT_VIEW_MIN_HEIGHT) { + NSLog(@"ADVProgressBarDraw: Frame heigh is too small to draw PercentView"); + return; + } + + percentView = [[UIView alloc] initWithFrame: + CGRectMake( + LEFT_PADDING, + percentViewY, + PERCENT_VIEW_WIDTH, + percentViewHeight ) + ]; + + UIImageView* percentImageView = [[UIImageView alloc] initWithFrame: + CGRectMake( + 0, + 0, + PERCENT_VIEW_WIDTH, + percentViewHeight ) + ]; + + [percentImageView setImage:[UIImage imageNamed:@"progress-count.png"]]; + + UILabel* percentLabel = [[UILabel alloc] initWithFrame: + CGRectMake( + 0, + 0, + PERCENT_VIEW_WIDTH, + percentViewHeight ) + ]; + + [percentLabel setTag:1]; + [percentLabel setText:@"0"]; + [percentLabel setBackgroundColor:[UIColor clearColor]]; + [percentLabel setFont:[UIFont boldSystemFontOfSize:13]]; + [percentLabel setTextAlignment:UITextAlignmentCenter]; + [percentLabel setAdjustsFontSizeToFitWidth:YES]; + + [percentView addSubview:percentImageView]; + [percentView addSubview:percentLabel]; + + [self addSubview:percentView]; + + self.showPercent = YES; + self.minProgressValue = 0.0f; + self.maxProgressValue = 1.0f; + self.progress = 0.0f; +} + +- (void)progressImageDraw +{ + BOOL showPercent; + if (self.maxProgressValue <= 1.0 || self.maxProgressValue >= 1000.0) { + showPercent = YES; + } + else { + showPercent = self.showPercent; + } + + CGFloat percentProgress = (progress - self.minProgressValue) / + (self.maxProgressValue - self.minProgressValue); + + progressImageView.image = progressFillImage; + + CGRect frame = progressImageView.frame; + + frame.origin.x = 2; + frame.origin.y = 2; + frame.size.height = bgImageView.frame.size.height - 4; + + frame.size.width = (bgImageView.frame.size.width - 4) * percentProgress; + + progressImageView.frame = frame; + + CGRect percentFrame = percentView.frame; + + float percentViewWidth = percentView.frame.size.width; + float leftEdge = (progressImageView.frame.size.width - percentViewWidth) - RIGHT_PADDING; + + percentFrame.origin.x = (leftEdge < LEFT_PADDING) ? LEFT_PADDING : leftEdge; + percentView.frame = percentFrame; + + UILabel* percentLabel = (UILabel*)[percentView viewWithTag:1]; + if (showPercent == YES) { + // show percent + if (percentProgress > 0) { + [percentLabel setText: + [NSString stringWithFormat:@"%d%%", (int)(percentProgress*100)]]; } + else { + [percentLabel setText:@"0"]; + } + } + else { + // show integral + [percentLabel setText:[NSString stringWithFormat:@"%d", (int)progress]]; } } @@ -145,8 +302,32 @@ -(NSString*)getImageNameFromBarDefinition:(ADVProgressBarColor)barDef return imageName; } - - +// Thanks to Cyrille +// http://stackoverflow.com/questions/6856879/iphone-getting-the-size-of-an-image-after-aspectft +- (CGSize)getScale:(CGSize)originalSize fitInSize:(CGSize)boxSize withMode:(UIViewContentMode)mode +{ + CGFloat sx = boxSize.width/originalSize.width; + CGFloat sy = boxSize.height/originalSize.height; + CGFloat s = 1.0; + + switch (self.contentMode) { + case UIViewContentModeScaleAspectFit: + s = fminf(sx, sy); + return CGSizeMake(s, s); + break; + + case UIViewContentModeScaleAspectFill: + s = fmaxf(sx, sy); + return CGSizeMake(s, s); + break; + + case UIViewContentModeScaleToFill: + return CGSizeMake(sx, sy); + + default: + return CGSizeMake(s, s); + } +} @end diff --git a/ADVProgressBar/Resources/.DS_Store b/ADVProgressBar/Resources/.DS_Store deleted file mode 100644 index 5008ddf..0000000 Binary files a/ADVProgressBar/Resources/.DS_Store and /dev/null differ diff --git a/ADVProgressBar/en.lproj/MainStoryboard.storyboard b/ADVProgressBar/en.lproj/MainStoryboard.storyboard index e378f5b..c7a4420 100644 --- a/ADVProgressBar/en.lproj/MainStoryboard.storyboard +++ b/ADVProgressBar/en.lproj/MainStoryboard.storyboard @@ -1,24 +1,87 @@ - + - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Default-568h@2x.png b/Default-568h@2x.png new file mode 100644 index 0000000..0891b7a Binary files /dev/null and b/Default-568h@2x.png differ diff --git a/DoxyDoc/Doxyfile b/DoxyDoc/Doxyfile new file mode 100644 index 0000000..a9b8b30 --- /dev/null +++ b/DoxyDoc/Doxyfile @@ -0,0 +1,1846 @@ +# Doxyfile 1.8.2 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = "ADVProgressBar for iOS" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "iPhone widget" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, +# and language is one of the parsers supported by doxygen: IDL, Java, +# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, +# C++. For instance to make doxygen treat .inc files as Fortran files (default +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented classes, +# or namespaces to their corresponding documentation. Such a link can be +# prevented in individual cases by by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES (the +# default) will make doxygen replace the get and set methods by a property in +# the documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +SYMBOL_CACHE_SIZE = 0 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ../ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.idl \ + *.odl \ + *.cs \ + *.php \ + *.php3 \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = Resources + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C, C++ and Fortran comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely +# identify the documentation publisher. This should be a reverse domain-name +# style string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/DoxyDoc/Resources/editorMenu.jpg b/DoxyDoc/Resources/editorMenu.jpg new file mode 100644 index 0000000..ece8712 Binary files /dev/null and b/DoxyDoc/Resources/editorMenu.jpg differ diff --git a/DoxyDoc/Resources/screenshot.jpg b/DoxyDoc/Resources/screenshot.jpg new file mode 100644 index 0000000..ece7eb3 Binary files /dev/null and b/DoxyDoc/Resources/screenshot.jpg differ diff --git a/DoxyDoc/Resources/storyboard0.jpg b/DoxyDoc/Resources/storyboard0.jpg new file mode 100644 index 0000000..bad6f11 Binary files /dev/null and b/DoxyDoc/Resources/storyboard0.jpg differ diff --git a/DoxyDoc/Resources/storyboard1.jpg b/DoxyDoc/Resources/storyboard1.jpg new file mode 100644 index 0000000..404829c Binary files /dev/null and b/DoxyDoc/Resources/storyboard1.jpg differ diff --git a/DoxyDoc/Resources/storyboard2.jpg b/DoxyDoc/Resources/storyboard2.jpg new file mode 100644 index 0000000..71275f2 Binary files /dev/null and b/DoxyDoc/Resources/storyboard2.jpg differ diff --git a/DoxyDoc/Resources/storyboard3.jpg b/DoxyDoc/Resources/storyboard3.jpg new file mode 100644 index 0000000..0e72f5a Binary files /dev/null and b/DoxyDoc/Resources/storyboard3.jpg differ diff --git a/DoxyDoc/Resources/storyboard4.jpg b/DoxyDoc/Resources/storyboard4.jpg new file mode 100644 index 0000000..ac8746e Binary files /dev/null and b/DoxyDoc/Resources/storyboard4.jpg differ diff --git a/DoxyDoc/mainpage.dox b/DoxyDoc/mainpage.dox new file mode 100644 index 0000000..3db7897 --- /dev/null +++ b/DoxyDoc/mainpage.dox @@ -0,0 +1,179 @@ +// +// mainpage.dox +// ADVProgressBar +// +// +/* + The MIT License + + Copyright (c) 2013 Corrado Ubezio + https://github.com/corerd/ + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. +*/ + +/*! + @mainpage Design documentation + + Define the `ADVPercentProgressBar` class, that is a Custom UIView to depict + the progress of a task over time. + + The amount of **progress** is displayed by a multiple colors horizontal bar + that represents a range of values. + + The current **progress** is shown by the position of a cursor with the textual + indication of the amount of the task that has completed. The amount can be + displayed as integral value or a percentage of it. + + The `ADVPercentProgressBar` class can be created and instantiated both in-code + (programmatically) or via a nib (storyboard). + + It is also deployed a demo app to show how to use this class in various + scenarios. The source code can be found in the `ADVViewController.h` and + `ADVViewController.m` files. + + The custom UIView class and the demo app have been developed as an Xcode 4.5.2 + project for iPhone devices targeting iOS 5.0. + + Using the `ADVPercentProgressBar` Custom UIView + =============================================== + The demo app looks like this: + @image html screenshot.jpg + + To achieve the same yourself, open Xcode and create a new project + with the `iOS\Application\Single View Application` template and + name it `ADVProgressBar`. + Enter ADV as Class Prefix; make sure the Device Family is set to iPhone, + `Use Storyboard` and `Use Automatic Reference Counting` are checked. + + Add `ADVPercentProgressBar.h` and `ADVPercentProgressBar.m` to your project. + + Open `MainStoryboard.storyboard` and go to `Editor\Canvas\Show Bounds Rectangles` + (this will make it easier to see what we’re doing). + @image html editorMenu.jpg + + Configuring the View + -------------------- + Drag a `UIView` from the `Object Library` into the view controller. + @image html storyboard0.jpg + + Then click on the UIView you added and go to the Identity Inspector. + Set the class to `ADVPercentProgressBar`: + @image html storyboard1.jpg + + You won't be able to see what the `ADVPercentProgressBar` custom subview + actually looks like in the storyboard canvas, you'll see just its bounds. + + Now connect the custom subview to outlets. + + Bring up the Assistant editor and make sure that the view controller’s header + file `ADVViewController.h` is displayed. + + Add an `#import` directive to include the `ADVPercentProgressBar.h` header. + + On the canvas, Control-drag from the `ADVPercentProgressBar` UIView + to the method declaration area in `ADVPercentProgressBar.h` (that is, between + the \@interface statement and the \@end statement). + + Connect it to an Outlet and named it `pbRangeValue`. + @image html storyboard2.jpg + + At this point `ADVViewController.h` should look like the following: +\code +#import +#import "ADVPercentProgressBar.h" + +@interface ADVViewController : UIViewController + +@property (weak, nonatomic) IBOutlet ADVPercentProgressBar *pbRangeValue; + +@end +\endcode + + Repeat this for an other `ADVPercentProgressBar` UIView, but connect it + to an outlet called `pbRangePercent`. + + Finally, drag a `Slider` from the `Object Library` into the view controller. + + This `Slider` will be used to animate our progress bars, then we have + to configure an action connection for it. + + Control-drag from the `Slider` in the view to the method declaration area + in the header file. + + In the Connection pop-up menu, choose `Action`. + + In the Name field, enter `sliderValueChanged:`. + + Make sure that the Type field contains `UISlider`. + + Make sure that the Event pop-up menu contains `Value Changed`. + You specify the Value Changed event because you want the message to be sent + when the user slides the thumb along the track. + + Make sure that the Arguments pop-up menu contains `Sender`. + @image html storyboard3.jpg + + At the end, `ADVViewController.h` should look like the following: +\code +#import +#import "ADVPercentProgressBar.h" + +@interface ADVViewController : UIViewController + +@property (weak, nonatomic) IBOutlet ADVPercentProgressBar *pbRangeValue; +@property (weak, nonatomic) IBOutlet ADVPercentProgressBar *pbRangePercent; + +- (IBAction)sliderValueChanged:(UISlider *)sender; + +@end +\endcode + + Now, resize the views, add four Labels and move them around to look like + the following: + @image html storyboard4.jpg + + Implementing the View Controller + -------------------------------- + Select `ADVViewController.m` in the project navigator and find the `viewDidLoad` + stub implementation that Xcode added for you. + + Before the `[super viewDidLoad];` statement, create and instantiate + programmatically a bunch of `ADVPercentProgressBar` custom views. + + As you can see in the provided `ADVViewController.m` file, this follows the + pattern: +\code + ADVPercentProgressBar *progressBar = + [[ADVPercentProgressBar alloc] initWithFrame:CGRectMake(X, Y, hDim, vDim) + andProgressBarColor:someADVProgressBarColor]; + + // set ADVPercentProgressBar instance properties +\endcode + + After the `[super viewDidLoad];` statement, set the properties of the + `ADVPercentProgressBar` views loaded from storyboard. In this case they are not + required the origin point and the size of the views because they have been + implicitly set when drown. + + Finally, complete the stub implementation of the `sliderValueChanged:` method + to animate the progress bars when the user slides the thumb along the track. + I have used the `percentProgressBars` and `integralProgressBars` arrays + to keep track of the `ADVPercentProgressBar` views. +*/ diff --git a/LICENSE.txt b/LICENSE.txt index 0dfb755..0ec6890 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,7 @@ The MIT License - Copyright (c) 2011 Tope Abayomi + Original work Copyright (c) 2011 Tope Abayomi + Modified work Copyright (c) 2013 Corrado Ubezio Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md new file mode 100644 index 0000000..c6d1d1e --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +ADVProgressBar for iOS +====================== + +Define the `ADVPercentProgressBar` class, that is a custom progress bar +that comes in multiple colors. +It shows a display above the bar that depicts the amount of the task that has +completed. This indication may be displayed as the whole value or its percentage. + +The `ADVPercentProgressBar` class is deployed together a demo app to show +various use case scenarios. They have been developed as an Xcode 4.5.2 project +targeting iOS 5.0. + +This work has been derived from +https://github.com/appdesignvault/ADVProgressBar. + +Changes relate to the following topics: +- Let configure the range of the values represented by the progress bar. +- Choose the way the amount of completed task is displayed: percentage or integral. +- Allow variable size. +- Add support to `initWithFrame` and `initWithCoder` so that the view controller + can add `ADVPercentProgressBar` class via a nib (storyboard) or programatically. +- Annotate source code files an according to Doxygen in order to auto generate + design documentation. +- A tutorial has been added. + + +DOCUMENTATION +------------- + +The design documentation can be found [here](http://corerd.github.com/ADVProgressBar). + +The Doxygen configuration file Doxyfile is also provided. The Doxygen output +html pages can be found under the **gh-pages** branch. Otherwise, you can self +generate them following these steps: + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +cd /path/to/ADVProgressBar/DoxyDoc +doxygen Doxyfile +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +CREDITS +------- + +[ADVProgressBar on Cocoa Controls] +(http://www.cocoacontrols.com/controls/advprogressbar) + +[How To Make a Custom UIView] +(http://www.raywenderlich.com/1768/how-to-make-a-custom-uiview-a-5-star-rating-view) + + +The MIT License +--------------- + +Original work Copyright (c) 2011 Tope Abayomi + +Modified work Copyright (c) 2013 Corrado Ubezio + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +