Skip to content

Commit 2b1e62d

Browse files
ipodishimaipodishima
committed
Doc and readme update
1 parent 26f728f commit 2b1e62d

File tree

10 files changed

+77
-19
lines changed

10 files changed

+77
-19
lines changed

‎Documentation/html/Categories/UIView+PPRevealSideViewController.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ <h4 class="method-subtitle">Declared In</h4>
197197
<div id="footer">
198198
<hr />
199199
<div class="footer-copyright">
200-
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-21)</span><br />
200+
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-22)</span><br />
201201

202202
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 759)</a>.</span></p>
203203

‎Documentation/html/Categories/UIViewController+PPRevealSideViewController.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ <h4 class="method-subtitle">Declared In</h4>
197197
<div id="footer">
198198
<hr />
199199
<div class="footer-copyright">
200-
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-21)</span><br />
200+
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-22)</span><br />
201201

202202
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 759)</a>.</span></p>
203203

‎Documentation/html/Classes/PPRevealSideViewController.html‎

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,18 @@ <h1>Popping</h1>
256256
<pre><code>MainViewController *c = [[MainViewController alloc] initWithNibName:@"MainViewController" bundle:nil];
257257
UINavigationController *n = [[UINavigationController alloc] initWithRootViewController:c];
258258
[self.revealSideViewController popViewControllerWithNewCenterController:n animated:YES];
259+
</code></pre>
260+
261+
<h1>Pushing from a side</h1>
262+
263+
<p>If you are for example on the up side, and you want to push a controller on the left, you could call a method on your center controller asking him to display a left controller. But I thought it would be more convenient to provide a way to push an old controller directly. So, using the following will do the trick</p>
264+
265+
<pre><code>[self.revealSideViewController pushOldViewControllerOnDirection:PPRevealSideDirectionLeft animated:YES];
266+
</code></pre>
267+
268+
<p>If you are on top, and you want to push a new controller on top (why not), the default behavior of the controller would be to close the top side since it&rsquo;s open. But you can force it to pop push :</p>
269+
270+
<pre><code>[self.revealSideViewController pushViewController:c onDirection:PPRevealSideDirectionTop animated:YES forceToPopPush:YES];
259271
</code></pre>
260272
</div>
261273

@@ -282,7 +294,7 @@ <h3 class="subsubtitle task-title">Other Methods</h3>
282294
</li><li>
283295
<span class="tooltip">
284296
<code><a href="#//api/name/options">&nbsp;&nbsp;options</a></code>
285-
<span class="tooltip"><p>Disable or enable the shadows. Enabled by default Decide if the animations are boucing or not. By default, they are Decide if we close completely the old direction, for the new one or not. Set to YES by default Keep the same offset when rotating. By default, set to no Resize the side view. If set to yes, this disabled the bouncing stuff since the view behind is not large enough to show bouncing correctly. Set to NO by default</p></span>
297+
<span class="tooltip"><p>The Reveal <a href="#//api/name/options">options</a>. Possible values are :</p></span>
286298
</span>
287299
<span class="task-item-suffix">property</span>
288300

@@ -553,7 +565,7 @@ <h3 class="subsubtitle method-title">options</h3>
553565

554566

555567
<div class="method-subsection brief-description">
556-
<p>Disable or enable the shadows. Enabled by default Decide if the animations are boucing or not. By default, they are Decide if we close completely the old direction, for the new one or not. Set to YES by default Keep the same offset when rotating. By default, set to no Resize the side view. If set to yes, this disabled the bouncing stuff since the view behind is not large enough to show bouncing correctly. Set to NO by default</p>
568+
<p>The Reveal <a href="#//api/name/options">options</a>. Possible values are :</p>
557569
</div>
558570

559571

@@ -566,6 +578,24 @@ <h3 class="subsubtitle method-title">options</h3>
566578

567579

568580

581+
<div class="method-subsection discussion-section">
582+
<h4 class="method-subtitle">Discussion</h4>
583+
<ul>
584+
<li>PPRevealSideOptionsNone = 0</li>
585+
<li>PPRevealSideOptionsShowShadows = 1 &lt;&lt; 1
586+
Disable or enable the shadows. Enabled by default</li>
587+
<li>PPRevealSideOptionsBounceAnimations = 1 &lt;&lt; 2
588+
Decide if the animations are boucing or not. By default, they are</li>
589+
<li>PPRevealSideOptionsCloseCompletlyBeforeOpeningNewDirection = 1 &lt;&lt; 3
590+
Decide if we close completely the old direction, for the new one or not. Set to YES by default</li>
591+
<li>PPRevealSideOptionsKeepOffsetOnRotation = 1 &lt;&lt; 4
592+
Keep the same offset when rotating. By default, set to no</li>
593+
<li>PPRevealSideOptionsResizeSideView = 1 &lt;&lt; 5
594+
Resize the side view. If set to yes, this disabled the bouncing stuff since the view behind is not large enough to show bouncing correctly. Set to NO by default</li>
595+
</ul>
596+
597+
</div>
598+
569599

570600

571601

@@ -1663,7 +1693,7 @@ <h4 class="method-subtitle">Declared In</h4>
16631693
<div id="footer">
16641694
<hr />
16651695
<div class="footer-copyright">
1666-
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-21)</span><br />
1696+
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-22)</span><br />
16671697

16681698
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 759)</a>.</span></p>
16691699

‎Documentation/html/Protocols/PPRevealSideViewControllerDelegate.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ <h4 class="method-subtitle">Declared In</h4>
520520
<div id="footer">
521521
<hr />
522522
<div class="footer-copyright">
523-
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-21)</span><br />
523+
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-22)</span><br />
524524

525525
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 759)</a>.</span></p>
526526

‎Documentation/html/hierarchy.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h2 class="index-title">Category References</h2>
7878
<div id="footer">
7979
<hr />
8080
<div class="footer-copyright">
81-
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-21)</span><br />
81+
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-22)</span><br />
8282

8383
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 759)</a>.</span></p>
8484

‎Documentation/html/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h2 class="index-title">Category References</h2>
7272
<div id="footer">
7373
<hr />
7474
<div class="footer-copyright">
75-
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-21)</span><br />
75+
<p><span class="copyright">&copy; 2012 Marian PAUL - iPuP SARL. All rights reserved. (Last updated: 2012-02-22)</span><br />
7676

7777
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 759)</a>.</span></p>
7878

‎PPRevealSideViewController.xcodeproj/project.xcworkspace/xcuserdata/marianpaul.xcuserdatad/UserInterfaceState.xcuserstate‎

921 Bytes
Binary file not shown.

‎PPRevealSideViewController/PPRevealSideviewController/PPRevealSideViewController.h‎

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,16 @@ typedef NSUInteger PPRevealSideOptions;
120120
MainViewController *c = [[MainViewController alloc] initWithNibName:@"MainViewController" bundle:nil];
121121
UINavigationController *n = [[UINavigationController alloc] initWithRootViewController:c];
122122
[self.revealSideViewController popViewControllerWithNewCenterController:n animated:YES];
123-
123+
124+
# Pushing from a side
125+
If you are for example on the up side, and you want to push a controller on the left, you could call a method on your center controller asking him to display a left controller. But I thought it would be more convenient to provide a way to push an old controller directly. So, using the following will do the trick
126+
127+
[self.revealSideViewController pushOldViewControllerOnDirection:PPRevealSideDirectionLeft animated:YES];
128+
129+
If you are on top, and you want to push a new controller on top (why not), the default behavior of the controller would be to close the top side since it's open. But you can force it to pop push :
130+
131+
[self.revealSideViewController pushViewController:c onDirection:PPRevealSideDirectionTop animated:YES forceToPopPush:YES];
132+
124133
*/
125134

126135
@interface PPRevealSideViewController : UIViewController <UIGestureRecognizerDelegate>
@@ -141,20 +150,24 @@ typedef NSUInteger PPRevealSideOptions;
141150

142151
/**
143152
Getter for the rootViewController
144-
145153
*/
146154
@property (nonatomic, readonly, retain) UIViewController *rootViewController;
147155

148156
/**
149157
The Reveal options. Possible values are :
150158
151-
* PPRevealSideOptionsNone = 0,
152-
* PPRevealSideOptionsShowShadows = 1 << 1, /// Disable or enable the shadows. Enabled by default
153-
* PPRevealSideOptionsBounceAnimations = 1 << 2, /// Decide if the animations are boucing or not. By default, they are
154-
* PPRevealSideOptionsCloseCompletlyBeforeOpeningNewDirection = 1 << 3, /// Decide if we close completely the old direction, for the new one or not. Set to YES by default
155-
* PPRevealSideOptionsKeepOffsetOnRotation = 1 << 4, /// Keep the same offset when rotating. By default, set to no
156-
* PPRevealSideOptionsResizeSideView = 1 << 5, /// Resize the side view. If set to yes, this disabled the bouncing stuff since the view behind is not large enough to show bouncing correctly. Set to NO by default
157-
159+
- PPRevealSideOptionsNone = 0
160+
- PPRevealSideOptionsShowShadows = 1 << 1
161+
Disable or enable the shadows. Enabled by default
162+
- PPRevealSideOptionsBounceAnimations = 1 << 2
163+
Decide if the animations are boucing or not. By default, they are
164+
- PPRevealSideOptionsCloseCompletlyBeforeOpeningNewDirection = 1 << 3
165+
Decide if we close completely the old direction, for the new one or not. Set to YES by default
166+
- PPRevealSideOptionsKeepOffsetOnRotation = 1 << 4
167+
Keep the same offset when rotating. By default, set to no
168+
- PPRevealSideOptionsResizeSideView = 1 << 5
169+
Resize the side view. If set to yes, this disabled the bouncing stuff since the view behind is not large enough to show bouncing correctly. Set to NO by default
170+
158171
*/
159172
@property (nonatomic, assign) PPRevealSideOptions options;
160173

‎PPRevealSideViewController/PPRevealSideviewController/PPRevealSideViewController.m‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1034,6 +1034,7 @@ - (void) gestureRecognizerDidPan:(UIPanGestureRecognizer*)panGesture {
10341034
}
10351035

10361036
- (void) gestureRecognizerDidTap:(UITapGestureRecognizer*)tapGesture {
1037+
PPRSLog(@"Yes, the tap gesture is animated, this is normal, not a bug! Is there anybody here with a non animate interface? :P");
10371038
[self popViewControllerAnimated:YES];
10381039
}
10391040

‎README.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@ PPRevealSideViewController
22
==========================
33

44
This is a new controller container, showing views on the side like the Facebook or Path app. It is as easy to use as a navigation controller.
5-
Sometimes, you need to push a new controller to show some options, but a small controller would be enough … PPRevealSideViewController is the controller you need.
5+
Sometimes, you need to push a new controller to show some options, but a small controller would be enough … PPRevealSideViewController is THE controller you need.
6+
7+
Pan and Tap gestures are also included !
8+
9+
[See a demo on Youtube!](http://www.youtube.com/watch?v=lsc7RQvyy20)
610

711
# Installation
812

@@ -77,7 +81,17 @@ If you want to pop a new center controller, then do the following :
7781
MainViewController *c = [[MainViewController alloc] initWithNibName:@"MainViewController" bundle:nil];
7882
UINavigationController *n = [[UINavigationController alloc] initWithRootViewController:c];
7983
[self.revealSideViewController popViewControllerWithNewCenterController:n animated:YES];
80-
84+
85+
## Pushing from a side
86+
If you are for example on the up side, and you want to push a controller on the left, you could call a method on your center controller asking him to display a left controller. But I thought it would be more convenient to provide a way to push an old controller directly. So, using the following will do the trick
87+
88+
[self.revealSideViewController pushOldViewControllerOnDirection:PPRevealSideDirectionLeft animated:YES];
89+
90+
If you are on top, and you want to push a new controller on top (why not), the default behavior of the controller would be to close the top side since it's open. But you can force it to pop push :
91+
92+
[self.revealSideViewController pushViewController:c onDirection:PPRevealSideDirectionTop animated:YES forceToPopPush:YES];
93+
94+
8195
## To go deeper
8296
By default, the side views are not loaded. This means that even if you interface have a button to push a side view, the panning gesture won't show the controller. If you want so, you need to preload the controller you want to present.
8397

0 commit comments

Comments
 (0)