iska
154 lines
3.6 KiB
Objective-C
154 lines
3.6 KiB
Objective-C
//
|
|
// HTMLRange.h
|
|
// HTMLKit
|
|
//
|
|
// Created by Iska on 20/11/16.
|
|
// Copyright © 2016 BrainCookie. All rights reserved.
|
|
//
|
|
|
|
#import "HTMLNode.h"
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
typedef NS_ENUM(unsigned short, HTMLRangeComparisonMethod)
|
|
{
|
|
HTMLRangeComparisonMethodStartToStart = 0,
|
|
HTMLRangeComparisonMethodStartToEnd = 1,
|
|
HTMLRangeComparisonMethodEndToEnd = 2,
|
|
HTMLRangeComparisonMethodEndToStart = 3
|
|
};
|
|
|
|
#pragma mark - DOM Range
|
|
|
|
/**
|
|
A HTML Range, represents a sequence of content within a node tree.
|
|
Each range has a start and an end which are boundary points.
|
|
A boundary point is a tuple consisting of a node and a non-negative numeric offset.
|
|
|
|
https://dom.spec.whatwg.org/#ranges
|
|
*/
|
|
@interface HTMLRange : NSObject
|
|
|
|
/**
|
|
The node of the start boundary point.
|
|
*/
|
|
@property (nonatomic, readonly, strong) HTMLNode *startContainer;
|
|
|
|
/**
|
|
The offset of the start boundary point.
|
|
*/
|
|
@property (nonatomic, readonly, assign) NSUInteger startOffset;
|
|
|
|
/**
|
|
The node of the end boundary point.
|
|
*/
|
|
@property (nonatomic, readonly, strong) HTMLNode *endContainer;
|
|
|
|
/**
|
|
The offset of the end boundary point.
|
|
*/
|
|
@property (nonatomic, readonly, assign) NSUInteger endOffset;
|
|
|
|
/**
|
|
Checks whether the range is collapsed, i.e. if start is the same as end.
|
|
|
|
@return `YES` if the range is collapsed, `NO` otherwise.
|
|
*/
|
|
@property (nonatomic, readonly, assign, getter=isCollapsed) BOOL collapsed;
|
|
|
|
/**
|
|
The common container node that contains both start and end nodes.
|
|
*/
|
|
@property (nonatomic, readonly, weak) HTMLNode *commonAncestorContainer;
|
|
|
|
/**
|
|
Initializes a new range instance for the given document.
|
|
|
|
@param document The HTML doucment for which the range will be constructed.
|
|
@return A new HTML Range instance.
|
|
*/
|
|
- (instancetype)initWithDowcument:(HTMLDocument *)document;
|
|
|
|
/**
|
|
Sets the start boundary.
|
|
|
|
@param startNode The new node of the start boundary.
|
|
@param startOffset The new offset of the start boundary.
|
|
*/
|
|
- (void)setStartNode:(HTMLNode *)node startOffset:(NSUInteger)offset;
|
|
|
|
/**
|
|
Sets the end boundary.
|
|
|
|
@param startNode The new node of the end boundary.
|
|
@param startOffset The new offset of the end boundary.
|
|
*/
|
|
- (void)setEndNode:(HTMLNode *)node endOffset:(NSUInteger)offset;
|
|
|
|
/**
|
|
Sets the start boundary before the given node.
|
|
|
|
@param node The node before which the boundary will be set.
|
|
*/
|
|
- (void)setStartBeforeNode:(HTMLNode *)node;
|
|
|
|
/**
|
|
Sets the start boundary after the given node.
|
|
|
|
@param node The node after which the boundary will be set.
|
|
*/
|
|
- (void)setStartAfterNode:(HTMLNode *)node;
|
|
|
|
/**
|
|
Sets the end boundary before the given node.
|
|
|
|
@param node The node before which the boundary will be set.
|
|
*/
|
|
- (void)setEndBeforeNode:(HTMLNode *)node;
|
|
|
|
/**
|
|
Sets the end boundary after the given node.
|
|
|
|
@param node The node after which the boundary will be set.
|
|
*/
|
|
- (void)setEndAfterNode:(HTMLNode *)node;
|
|
|
|
/**
|
|
Collapses this range to its start.
|
|
*/
|
|
- (void)collapseToStart;
|
|
|
|
/**
|
|
Collapses this range to its end.
|
|
*/
|
|
- (void)collapseToEnd;
|
|
|
|
/**
|
|
Selects the given node in the range.
|
|
|
|
@param node The node to select
|
|
*/
|
|
- (void)selectNode:(HTMLNode *)node;
|
|
|
|
/**
|
|
Selects the node's contents in the range.
|
|
|
|
@param node The node to select the contents.
|
|
*/
|
|
- (void)selectNodeContents:(HTMLNode *)node;
|
|
|
|
|
|
/**
|
|
Compares the boundary points of this range with the given source range.
|
|
|
|
@param method The comparison method.
|
|
@param sourceRange The range to compare with.
|
|
@return `NSOrderedAscending` if ordered before, `NSOrderedSame` if ordered same, `NSOrderedDescending` otherwise.
|
|
|
|
@see HTMLRangeComparisonMethod
|
|
*/
|
|
- (NSComparisonResult)compareBoundaryPoints:(HTMLRangeComparisonMethod)method sourceRange:(HTMLRange *)sourceRange;
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|