Merge MatrixKit develop with commit hash: b85b736313bec0592bd1cabc68035d97f5331137

Riot/Modules/MatrixKit/Controllers/MXKViewControllerActivityHandling.h

@@ -0,0 +1,50 @@
+// 
+// Copyright 2021 The Matrix.org Foundation C.I.C
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#ifndef MXKViewControllerActivityHandling_h
+#define MXKViewControllerActivityHandling_h
+
+/**
+ `MXKViewControllerActivityHandling` defines a protocol to handle requirements for
+ all matrixKit view controllers and table view controllers.
+ 
+ It manages the following points:
+ - stop/start activity indicator according to the state of the associated matrix sessions.
+ */
+@protocol MXKViewControllerActivityHandling <NSObject>
+
+/**
+ Activity indicator view.
+ By default this activity indicator is centered inside the view controller view. It automatically
+ starts if `shouldShowActivityIndicator `returns true for the session.
+ It is stopped on other states.
+ Set nil to disable activity indicator animation.
+ */
+@property (nonatomic) UIActivityIndicatorView *activityIndicator;
+
+/**
+ Bring the activity indicator to the front and start it.
+ */
+- (void)startActivityIndicator;
+
+/**
+ Stop the activity indicator if all conditions are satisfied.
+ */
+- (void)stopActivityIndicator;
+
+@end
+
+#endif /* MXKViewControllerActivityHandling_h */