# GormPlacementInfo documentation

### Authors

Generated by heron

### Contents -

1. Software documentation for the GormPlacementHint class
2. Software documentation for the GormPlacementInfo class
3. GormPlacementInfo types

# Software documentation for the GormPlacementHint class

## GormPlacementHint : NSObject

> Declared in:
>   GormCore/GormPlacementInfo.h

Description forthcoming.

Instance Variables
Method summary

- -border
- -distanceToFrame:
- -end
- -frame
- -initWithBorder:position:validityStart:validityEnd:frame:
- -position
- -rectWithHalfDistance:
- -start

### border

- (GormHintBorder) border;
Description forthcoming.

### distanceToFrame:

- (int) distanceToFrame: (NSRect)frame;
Description forthcoming.

### end

- (float) end;
Description forthcoming.

### frame

- (NSRect) frame;
Description forthcoming.

### initWithBorder: position: validityStart: validityEnd: frame:

- (id) initWithBorder: (GormHintBorder)border position: (float)position validityStart: (float)start validityEnd: (float)end frame: (NSRect)frame;
Description forthcoming.

### position

- (float) position;
Description forthcoming.

### rectWithHalfDistance:

- (NSRect) rectWithHalfDistance: (int)halfDistance;
Description forthcoming.

### start

- (float) start;
Description forthcoming.

## Instance Variables for GormPlacementHint Class

### _border

@protected GormHintBorder _border;
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.

### _end

@protected float _end;
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.

### _frame

@protected NSRect _frame;
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.

### _position

@protected float _position;
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.

### _start

@protected float _start;
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 GormPlacementInfo class

## GormPlacementInfo : NSObject

> Declared in:
>   GormCore/GormPlacementInfo.h

Description forthcoming.

Instance Variables

## Instance Variables for GormPlacementInfo Class

### bottomHints

@public NSMutableArray* bottomHints;
Description forthcoming.

### firstPass

@public BOOL firstPass;
Description forthcoming.

### hintFrame

@public NSRect hintFrame;
Description forthcoming.

### hintInitialized

@public BOOL hintInitialized;
Description forthcoming.

### knob

@public IBKnobPosition knob;
Description forthcoming.

### lastBottomRect

@public NSRect lastBottomRect;
Description forthcoming.

### lastFrame

@public NSRect lastFrame;
Description forthcoming.

### lastLeftRect

@public NSRect lastLeftRect;
Description forthcoming.

### lastRightRect

@public NSRect lastRightRect;
Description forthcoming.

### lastTopRect

@public NSRect lastTopRect;
Description forthcoming.

### leftHints

@public NSMutableArray* leftHints;
Description forthcoming.

### oldRect

@public NSRect oldRect;
Description forthcoming.

### resizingIn

@public NSView* resizingIn;
Description forthcoming.

### rightHints

@public NSMutableArray* rightHints;
Description forthcoming.

### topHints

@public NSMutableArray* topHints;
Description forthcoming.

# GormPlacementInfo types

### GormHintBorder

typedef enum _GormHintBorder GormHintBorder;
Description forthcoming.