Merge MatrixKit develop with commit hash: b85b736313bec0592bd1cabc68035d97f5331137

2026-04-20 00:24:43 +02:00 · 2021-12-03 11:47:24 +01:00
parent af65f71177
commit f57941177e
475 changed files with 87437 additions and 0 deletions
@@ -0,0 +1,126 @@
+/*
+ Copyright 2015 OpenMarket Ltd
+ Copyright 2017 Vector Creations Ltd
+ Copyright 2018 New Vector Ltd
+ 
+ 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.
+ */
+
+#import <UIKit/UIKit.h>
+#import <MatrixSDK/MatrixSDK.h>
+
+#import "MXKView.h"
+
+@class MXKAttachment;
+
+/**
+ Customize UIView in order to display image defined with remote url. Zooming inside the image (Stretching) is supported.
+ */
+@interface MXKImageView : MXKView <UIScrollViewDelegate>
+
+typedef void (^blockMXKImageView_onClick)(MXKImageView *imageView, NSString* title);
+
+/**
+ Load an image by its Matrix Content URI.
+ The image is loaded from the media cache (if any). If the image is not available yet,
+ it is downloaded from the Matrix media repository only if a media manager instance is provided.
+ 
+ The image extension is extracted from the provided mime type (if any). By default 'image/jpeg' is considered.
+ 
+ @param mxContentURI the Matrix Content URI
+ @param mimeType the media mime type, it is used to define the file extension (may be nil).
+ @param orientation the actual orientation of the encoded image (used UIImageOrientationUp by default).
+ @param previewImage image displayed until the actual image is available.
+ @param mediaManager the media manager instance used to download the image if it is not already in cache.
+ */
+- (void)setImageURI:(NSString *)mxContentURI
+           withType:(NSString *)mimeType
+andImageOrientation:(UIImageOrientation)orientation
+       previewImage:(UIImage*)previewImage
+       mediaManager:(MXMediaManager*)mediaManager;
+
+/**
+ Load an image by its Matrix Content URI to fit a specific view size.
+ 
+ CAUTION: this method is available only for the unencrypted content.
+ 
+ The image is loaded from the media cache (if any). If the image is not available yet,
+ it is downloaded from the Matrix media repository only if a media manager instance is provided.
+ The image extension is extracted from the provided mime type (if any). By default 'image/jpeg' is considered.
+ 
+ @param mxContentURI the Matrix Content URI
+ @param mimeType the media mime type, it is used to define the file extension (may be nil).
+ @param orientation the actual orientation of the encoded image (used UIImageOrientationUp by default).
+ @param previewImage image displayed until the actual image is available.
+ @param mediaManager the media manager instance used to download the image if it is not already in cache.
+ */
+- (void)setImageURI:(NSString *)mxContentURI
+           withType:(NSString *)mimeType
+andImageOrientation:(UIImageOrientation)orientation
+      toFitViewSize:(CGSize)viewSize
+         withMethod:(MXThumbnailingMethod)thumbnailingMethod
+       previewImage:(UIImage*)previewImage
+       mediaManager:(MXMediaManager*)mediaManager;
+
+/**
+ * Load an image attachment into the image viewer and display the full res image.
+ * This method must be used to display encrypted attachments
+ * @param attachment The attachment
+ */
+- (void)setAttachment:(MXKAttachment *)attachment;
+
+/**
+ * Load an attachment into the image viewer and display its thumbnail, if it has one.
+ * This method must be used to display encrypted attachments
+ * @param attachment The attachment
+ */
+- (void)setAttachmentThumb:(MXKAttachment *)attachment;
+
+/**
+ Toggle display to fullscreen.
+ 
+ No change is applied on the status bar here, the caller has to handle it. 
+ */
+- (void)showFullScreen;
+
+/**
+ The default background color.
+ Default is [UIColor blackColor].
+ */
+@property (nonatomic) UIColor *defaultBackgroundColor;
+
+// Use this boolean to hide activity indicator during image downloading
+@property (nonatomic) BOOL hideActivityIndicator;
+
+@property (strong, nonatomic) UIImage *image;
+@property (nonatomic, readonly) UIImageView *imageView;
+
+@property (nonatomic) BOOL stretchable;
+@property (nonatomic, readonly) BOOL fullScreen;
+
+// the image is cached in memory.
+// The medias manager uses a LRU cache.
+// to avoid loading from the file system.
+@property (nonatomic) BOOL enableInMemoryCache;
+
+// mediaManager folder where the image is stored
+@property (nonatomic) NSString* mediaFolder;
+
+// Let the user defines some custom buttons over the tabbar
+- (void)setLeftButtonTitle :leftButtonTitle handler:(blockMXKImageView_onClick)handler;
+- (void)setRightButtonTitle:rightButtonTitle handler:(blockMXKImageView_onClick)handler;
+
+- (void)dismissSelection;
+
+@end
+