Up

# NSRuleEditor

### Authors

Fred Kiefer (`fredkiefer@gmx.de`)

> The rule editor class

Copyright: (C) 2020 Free Software Foundation, Inc.

### Contents -

1. Software documentation for the NSRuleEditor class
2. Software documentation for the NSRuleEditorDelegate protocol

# Software documentation for the NSRuleEditor class

## NSRuleEditor : NSControl

> Declared in:
>   AppKit/NSRuleEditor.h

Availability: MacOS-X 10.5.0
Description forthcoming.

Instance Variables
Method summary

- -addRow:
- -canRemoveAllRows
- -criteriaForRow:
- -criteriaKeyPath
- -delegate
- -displayValuesForRow:
- -displayValuesKeyPath
- -formattingDictionary
- -formattingStringsFilename
- -insertRowAtIndex:withType:asSubrowOfRow:animate:
- -isEditable
- -nestingMode
- -numberOfRows
- -parentRowForRow:
- -predicate
- -predicateForRow:
- -reloadCriteria
- -reloadPredicate
- -removeRowAtIndex:
- -removeRowsAtIndexes:includeSubrows:
- -rowClass
- -rowForDisplayValue:
- -rowHeight
- -rowTypeForRow:
- -rowTypeKeyPath
- -selectRowIndexes:byExtendingSelection:
- -selectedRowIndexes
- -setCanRemoveAllRows:
- -setCriteria:andDisplayValues:forRowAtIndex:
- -setCriteriaKeyPath:
- -setDelegate:
- -setDisplayValuesKeyPath:
- -setEditable:
- -setFormattingDictionary:
- -setFormattingStringsFilename:
- -setNestingMode:
- -setRowClass:
- -setRowHeight:
- -setRowTypeKeyPath:
- -setSubrowsKeyPath:
- -subrowIndexesForRow:
- -subrowsKeyPath

### addRow:

- (void) addRow: (id)sender;
Availability: MacOS-X 10.5.0
Description forthcoming.

### canRemoveAllRows

- (BOOL) canRemoveAllRows;
Availability: MacOS-X 10.5.0
Description forthcoming.

### criteriaForRow:

- (NSArray*) criteriaForRow: (NSInteger)index;
Availability: MacOS-X 10.5.0
Description forthcoming.

### criteriaKeyPath

- (NSString*) criteriaKeyPath;
Availability: MacOS-X 10.5.0
Description forthcoming.

### delegate

- (id) delegate;
Availability: MacOS-X 10.5.0
Description forthcoming.

### displayValuesForRow:

- (NSArray*) displayValuesForRow: (NSInteger)index;
Availability: MacOS-X 10.5.0
Description forthcoming.

### displayValuesKeyPath

- (NSString*) displayValuesKeyPath;
Availability: MacOS-X 10.5.0
Description forthcoming.

### formattingDictionary

- (NSDictionary*) formattingDictionary;
Availability: MacOS-X 10.5.0
Description forthcoming.

### formattingStringsFilename

- (NSString*) formattingStringsFilename;
Availability: MacOS-X 10.5.0
Description forthcoming.

### insertRowAtIndex: withType: asSubrowOfRow: animate:

- (void) insertRowAtIndex: (NSInteger)index withType: (NSRuleEditorRowType)type asSubrowOfRow: (NSInteger)row animate: (BOOL)flag;
Availability: MacOS-X 10.5.0
Description forthcoming.

### isEditable

- (BOOL) isEditable;
Availability: MacOS-X 10.5.0
Description forthcoming.

### nestingMode

- (NSRuleEditorNestingMode) nestingMode;
Availability: MacOS-X 10.5.0
Description forthcoming.

### numberOfRows

- (NSInteger) numberOfRows;
Availability: MacOS-X 10.5.0
Description forthcoming.

### parentRowForRow:

- (NSInteger) parentRowForRow: (NSInteger)row;
Availability: MacOS-X 10.5.0
Description forthcoming.

### predicate

- (NSPredicate*) predicate;
Availability: MacOS-X 10.5.0
Description forthcoming.

### predicateForRow:

- (NSPredicate*) predicateForRow: (NSInteger)row;
Availability: MacOS-X 10.5.0
Description forthcoming.

### reloadCriteria

- (void) reloadCriteria;
Availability: MacOS-X 10.5.0
Description forthcoming.

### reloadPredicate

- (void) reloadPredicate;
Availability: MacOS-X 10.5.0
Description forthcoming.

### removeRowAtIndex:

- (void) removeRowAtIndex: (NSInteger)index;
Availability: MacOS-X 10.5.0
Description forthcoming.

### removeRowsAtIndexes: includeSubrows:

- (void) removeRowsAtIndexes: (NSIndexSet*)rowIds includeSubrows: (BOOL)flag;
Availability: MacOS-X 10.5.0
Description forthcoming.

### rowClass

- (Class) rowClass;
Availability: MacOS-X 10.5.0
Description forthcoming.

### rowForDisplayValue:

- (NSInteger) rowForDisplayValue: (id)value;
Availability: MacOS-X 10.5.0
Description forthcoming.

### rowHeight

- (CGFloat) rowHeight;
Availability: MacOS-X 10.5.0
Description forthcoming.

### rowTypeForRow:

- (NSRuleEditorRowType) rowTypeForRow: (NSInteger)row;
Availability: MacOS-X 10.5.0
Description forthcoming.

### rowTypeKeyPath

- (NSString*) rowTypeKeyPath;
Availability: MacOS-X 10.5.0
Description forthcoming.

### selectRowIndexes: byExtendingSelection:

- (void) selectRowIndexes: (NSIndexSet*)ids byExtendingSelection: (BOOL)flag;
Availability: MacOS-X 10.5.0
Description forthcoming.

### selectedRowIndexes

- (NSIndexSet*) selectedRowIndexes;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setCanRemoveAllRows:

- (void) setCanRemoveAllRows: (BOOL)flag;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setCriteria: andDisplayValues: forRowAtIndex:

- (void) setCriteria: (NSArray*)crits andDisplayValues: (NSArray*)vals forRowAtIndex: (NSInteger)index;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setCriteriaKeyPath:

- (void) setCriteriaKeyPath: (NSString*)path;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setDelegate:

- (void) setDelegate: (id)delegate;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setDisplayValuesKeyPath:

- (void) setDisplayValuesKeyPath: (NSString*)path;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setEditable:

- (void) setEditable: (BOOL)flag;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setFormattingDictionary:

- (void) setFormattingDictionary: (NSDictionary*)dict;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setFormattingStringsFilename:

- (void) setFormattingStringsFilename: (NSString*)filename;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setNestingMode:

- (void) setNestingMode: (NSRuleEditorNestingMode)flag;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setRowClass:

- (void) setRowClass: (Class)rowClass;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setRowHeight:

- (void) setRowHeight: (CGFloat)height;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setRowTypeKeyPath:

- (void) setRowTypeKeyPath: (NSString*)path;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setSubrowsKeyPath:

- (void) setSubrowsKeyPath: (NSString*)path;
Availability: MacOS-X 10.5.0
Description forthcoming.

### subrowIndexesForRow:

- (NSIndexSet*) subrowIndexesForRow: (NSInteger)row;
Availability: MacOS-X 10.5.0
Description forthcoming.

### subrowsKeyPath

- (NSString*) subrowsKeyPath;
Availability: MacOS-X 10.5.0
Description forthcoming.

## Instance Variables for NSRuleEditor Class

### _action

@protected SEL _action;
Availability: MacOS-X 10.5.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _target

@protected id _target;
Availability: MacOS-X 10.5.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

# Software documentation for the NSRuleEditorDelegate protocol

## NSRuleEditorDelegate

> Declared in:
>   AppKit/NSRuleEditor.h

Availability: MacOS-X 10.6.0
Description forthcoming.
Method summary

- -ruleEditor:child:forCriterion:withRowType:
- -ruleEditor:displayValueForCriterion:inRow:
- -ruleEditor:numberOfChildrenForCriterion:withRowType:
- -ruleEditor:predicatePartsForCriterion:withDisplayValue:inRow:
- -ruleEditorRowsDidChange:

### ruleEditor: child: forCriterion: withRowType:

- (id) ruleEditor: (NSRuleEditor*)editor child: (NSInteger)idx forCriterion: (id)crit withRowType: (NSRuleEditorRowType)type;
Availability: MacOS-X 10.6.0
Description forthcoming.

### ruleEditor: displayValueForCriterion: inRow:

- (id) ruleEditor: (NSRuleEditor*)editor displayValueForCriterion: (id)crit inRow: (NSInteger)row;
Availability: MacOS-X 10.6.0
Description forthcoming.

### ruleEditor: numberOfChildrenForCriterion: withRowType:

- (NSInteger) ruleEditor: (NSRuleEditor*)editor numberOfChildrenForCriterion: (id)crit withRowType: (NSRuleEditorRowType)type;
Availability: MacOS-X 10.6.0
Description forthcoming.

### ruleEditor: predicatePartsForCriterion: withDisplayValue: inRow:

- (NSDictionary*) ruleEditor: (NSRuleEditor*)editor predicatePartsForCriterion: (id)crit withDisplayValue: (id)val inRow: (NSInteger)row;
Availability: MacOS-X 10.6.0
Description forthcoming.

### ruleEditorRowsDidChange:

- (void) ruleEditorRowsDidChange: (NSNotification*)notif;
Availability: MacOS-X 10.6.0
Description forthcoming.

Up