View.h File Reference

Views are the fundamental building blocks of ObjectivelyMVC user interfaces. More...

#include <Objectively/Data.h>
#include <Objectively/Enum.h>
#include <Objectively/Dictionary.h>
#include <Objectively/Array.h>
#include <Objectively/Set.h>
#include <Objectively/Resource.h>
#include <ObjectivelyMVC/Colors.h>
#include <ObjectivelyMVC/Renderer.h>
#include <ObjectivelyMVC/Theme.h>
#include <ObjectivelyMVC/View+JSON.h>
#include <ObjectivelyMVC/Warning.h>

Go to the source code of this file.

Data Structures
struct	View
	Views are the fundamental building blocks of ObjectivelyMVC user interfaces. More...
struct	ViewConstraint
	A constraint offered by an ancestor View to a descendant during View::sizeThatSatisfies. More...
struct	ViewCornerCut
	The horizontal inset of each of a View's corners. More...
struct	ViewPadding
	Spacing applied to the inside of a View's frame. More...

Macros
#define	AddPadding(a, b)    MakePadding(a.top + b.top, a.right + b.right, a.bottom + b.bottom, a.left + b.left)
#define	ClampSize(size, min, max)    clamp((size), (min), (max) ? (max) : INT32_MAX)
	Clamps size to min and max, where a max of zero is unbounded.
#define	CornerCutIsEmpty(cut)    ((cut).topLeft == 0 && (cut).topRight == 0 && (cut).bottomRight == 0 && (cut).bottomLeft == 0)
#define	MakeConstraint(mode, value)    (ViewConstraint) { (mode), (value) }
#define	MakeCornerCut(topLeft, topRight, bottomRight, bottomLeft)    (ViewCornerCut) { (topLeft), (topRight), (bottomRight), (bottomLeft) }
	Creates a ViewCornerCut with the given insets.
#define	MakePadding(top, right, bottom, left)    (ViewPadding) { (top), (right), (bottom), (left) }
	Creates a ViewPadding with the given dimensions.
#define	ViewAlignmentMaskAny    (ViewAlignmentMaskHorizontal | ViewAlignmentMaskVertical)
#define	ViewAlignmentMaskBottom   0x4
#define	ViewAlignmentMaskCenter   0x10
#define	ViewAlignmentMaskHorizontal    (ViewAlignmentMaskLeft | ViewAlignmentMaskCenter | ViewAlignmentMaskRight)
#define	ViewAlignmentMaskInternal   0x100
#define	ViewAlignmentMaskLeft   0x8
#define	ViewAlignmentMaskMiddle   0x2
#define	ViewAlignmentMaskRight   0x20
#define	ViewAlignmentMaskTop   0x1
#define	ViewAlignmentMaskVertical    (ViewAlignmentMaskTop | ViewAlignmentMaskMiddle | ViewAlignmentMaskBottom)

Enumerations
enum	ViewAlignment {   ViewAlignmentNone , ViewAlignmentTop = ViewAlignmentMaskTop , ViewAlignmentMiddle = ViewAlignmentMaskMiddle , ViewAlignmentBottom = ViewAlignmentMaskBottom ,   ViewAlignmentLeft = ViewAlignmentMaskLeft , ViewAlignmentCenter = ViewAlignmentMaskCenter , ViewAlignmentRight = ViewAlignmentMaskRight , ViewAlignmentTopLeft = (ViewAlignmentMaskTop | ViewAlignmentMaskLeft) ,   ViewAlignmentTopCenter = (ViewAlignmentMaskTop | ViewAlignmentMaskCenter) , ViewAlignmentTopRight = (ViewAlignmentMaskTop | ViewAlignmentMaskRight) , ViewAlignmentMiddleLeft = (ViewAlignmentMaskMiddle | ViewAlignmentMaskLeft) , ViewAlignmentMiddleCenter = (ViewAlignmentMaskMiddle | ViewAlignmentMaskCenter) ,   ViewAlignmentMiddleRight = (ViewAlignmentMaskMiddle | ViewAlignmentMaskRight) , ViewAlignmentBottomLeft = (ViewAlignmentMaskBottom | ViewAlignmentMaskLeft) , ViewAlignmentBottomCenter = (ViewAlignmentMaskBottom | ViewAlignmentMaskCenter) , ViewAlignmentBottomRight = (ViewAlignmentMaskBottom | ViewAlignmentMaskRight) ,   ViewAlignmentInternal = ViewAlignmentMaskInternal }
	Alignment constants, used to align a View within its superview. More...
enum	ViewAutoresizing {   ViewAutoresizingNone = 0 , ViewAutoresizingWidth = 0x1 , ViewAutoresizingHeight = 0x2 , ViewAutoresizingFill = 0x3 ,   ViewAutoresizingFit = 0x4 , ViewAutoresizingContain = 0x8 }
	Auto-resizing constants, which are bitmasked. More...
enum	ViewPointerEvents { ViewPointerEventsAuto , ViewPointerEventsNone }
	Whether a View is the result of a hit test. More...
enum	ViewPosition { ViewPositionBefore = -1 , ViewPositionAfter = 1 }
	Relative positioning of subviews within their superview. More...
enum	ViewVisibility { ViewVisibilityUnspecified , ViewVisibilityVisible , ViewVisibilityHidden }
	Visibility constants. More...

Functions
OBJECTIVELYMVC_EXPORT Class *	_View (void)
OBJECTIVELYMVC_EXPORT void	MVC_InvalidateRenderFrames (void)
	Invalidates every View's cached View::renderFrame and View::clippingFrame.

Variables
OBJECTIVELYMVC_EXPORT const EnumName	ViewAlignmentNames []
OBJECTIVELYMVC_EXPORT const EnumName	ViewAutoresizingNames []
OBJECTIVELYMVC_EXPORT const EnumName	ViewPointerEventsNames []
OBJECTIVELYMVC_EXPORT const EnumName	ViewVisibilityNames []

Detailed Description

Views are the fundamental building blocks of ObjectivelyMVC user interfaces.

Definition in file View.h.

Macro Definition Documentation

AddPadding

#define AddPadding	(		a,
			b
	)		MakePadding(a.top + b.top, a.right + b.right, a.bottom + b.bottom, a.left + b.left)

Returns

A ViewPadding that is the sum of a and b.

Definition at line 182 of file View.h.

               {
  int topLeft, topRight, bottomRight, bottomLeft;
} ViewCornerCut;
 
#define MakeCornerCut(topLeft, topRight, bottomRight, bottomLeft) \
  (ViewCornerCut) { (topLeft), (topRight), (bottomRight), (bottomLeft) }
 
#define CornerCutIsEmpty(cut) \
  ((cut).topLeft == 0 && (cut).topRight == 0 && (cut).bottomRight == 0 && (cut).bottomLeft == 0)
 
typedef enum {
  ViewPositionBefore = -1,
  ViewPositionAfter = 1
} ViewPosition;
 
typedef struct ViewInterface ViewInterface;
 
struct View {
 
  Object object;
 
  ViewInterface *interface[0];
 
  ViewAlignment alignment;
 
  int autoresizingMask;
 
  SDL_Color backgroundColor;
 
  int backgroundGradientAngle;
 
  SDL_Color backgroundGradientColor;
 
  SDL_Color borderColor;
 
  int borderRadius;
 
  int borderWidth;
 
  Set *classNames;
 
  struct {
    SDL_Rect frame;
    unsigned generation;
  } clippingFrameCache;
 
  bool clipsSubviews;
 
  Style *computedStyle;
 
  ViewCornerCut cornerCut;
 
  SDL_Rect frame;
 
  char *identifier;
 
  SDL_Size maxSize;
 
  SDL_Size minSize;
 
  bool needsApplyTheme;
 
  bool needsApplyStyle;
 
  bool needsApplyThemeSubviews;
 
  bool needsLayout;
 
  bool needsLayoutSubviews;
 
  View *nextResponder;
 
  ViewPadding padding;
 
  ViewPointerEvents pointerEvents;
 
  struct {
    SDL_Rect frame;
    unsigned generation;
  } renderFrameCache;
 
  Style *style;
 
  bool stretch;
 
  Stylesheet *stylesheet;
 
  Array *subviews;
 
  View *superview;
 
  ViewController *viewController;
 
  ViewVisibility visibility;
 
  Array *warnings;
 
  SDL_Window *window;
};
 
struct ViewInterface {
 
  ObjectInterface parentInterface;
 
  bool (*acceptsKeyResponder)(const View *self);
 
  bool (*acceptsTouchResponder)(const View *self);
 
  void (*addClassName)(View *self, const char *className);
 
  void (*addSubview)(View *self, View *subview);
 
  void (*addSubviewRelativeTo)(View *self, View *subview, View *other, ViewPosition position);
 
  View *(*ancestorWithIdentifier)(const View *self, const char *identifier);
 
  void (*applyStyle)(View *self, const Style *style);
 
  void (*applyTheme)(View *self, const Theme *theme);
 
  void (*applyThemeIfNeeded)(View *self, const Theme *theme);
 
  void (*attachStylesheet)(View *self, SDL_Window *window);
 
  void (*awakeWithCharacters)(View *self, const char *chars);
 
  void (*awakeWithData)(View *self, const Data *data);
 
  void (*awakeWithDictionary)(View *self, const Dictionary *dictionary);
 
  void (*awakeWithResource)(View *self, const Resource *resource);
 
  void (*awakeWithResourceName)(View *self, const char *name);
 
  void (*becomeKeyResponder)(View *self);
 
  void (*becomeTouchResponder)(View *self);
 
  bool (*bind)(View *self, const Inlet *inlets, const Dictionary *dictionary);
 
  SDL_Rect (*bounds)(const View *self);
 
  void (*bringSubviewToFront)(View *self, View *subview);
 
  void (*clearWarnings)(const View *self, WarningType level);
 
  SDL_Rect (*clippingFrame)(const View *self);
 
  bool (*containsPoint)(const View *self, const SDL_Point *point);
 
  int (*depth)(const View *self);
 
  View *(*descendantWithIdentifier)(const View *self, const char *identifier);
 
  void (*detachStylesheet)(View *self, SDL_Window *window);
 
  void (*didMoveToWindow)(View *self, SDL_Window *window);
 
  bool (*didReceiveEvent)(const View *self, const SDL_Event *event);
 
  void (*draw)(View *self, Renderer *renderer);
 
  void (*emitViewEvent)(View *self, ViewEvent code, ident data);
 
  void (*enumerate)(View *self, ViewEnumerator enumerator, ident data);
 
  void (*enumerateAdjacent)(const View *self, ViewEnumerator enumerator, ident data);
 
  void (*enumerateAncestors)(const View *self, ViewEnumerator enumerator, ident data);
 
  void (*enumerateDescendants)(const View *self, ViewEnumerator enumerator, ident data);
 
  void (*enumerateSelection)(View *self, const char *rule, ViewEnumerator enumerator, ident data);
 
  void (*enumerateSiblings)(const View *self, ViewEnumerator enumerator, ident data);
 
  void (*enumerateSubviews)(const View *self, ViewEnumerator enumerator, ident data);
 
  void (*enumerateSuperview)(const View *self, ViewEnumerator enumerator, ident data);
 
  void (*enumerateVisible)(View *self, ViewEnumerator enumerator, ident data);
 
  bool (*hasClassName)(const View *self, const char *className);
 
  bool (*hasOverflow)(const View *self);
 
  View *(*hitTest)(const View *self, const SDL_Point *point);
 
  View *(*init)(View *self);
 
  View *(*initWithFrame)(View *self, const SDL_Rect *frame);
 
  void (*invalidateStyle)(View *self);
 
  bool (*isContainer)(const View *self);
 
  bool (*isDescendantOfView)(const View *self, const View *view);
 
  bool (*isKeyResponder)(const View *self);
 
  bool (*isTouchResponder)(const View *self);
 
  bool (*isVisible)(const View *self);
 
  void (*layoutIfNeeded)(View *self);
 
  void (*layoutSubviews)(View *self);
 
  void (*layoutWithConstraint)(View *self, ViewConstraint width, ViewConstraint height);
 
  void (*layoutWithSize)(View *self, const SDL_Size *size);
 
  bool (*matchesSelector)(const View *self, const SimpleSelector *simpleSelector);
 
  void (*moveToWindow)(View *self, SDL_Window *window);
 
  String *(*path)(const View *self);
 
  void (*removeAllClassNames)(View *self);
 
  void (*removeAllSubviews)(View *self);
 
  void (*removeClassName)(View *self, const char *className);
 
  void (*removeFromSuperview)(View *self);
 
  void (*removeSubview)(View *self, View *subview);
 
  void (*render)(View *self, Renderer *renderer);
 
  void (*renderDeviceDidReset)(View *self);
 
  void (*renderDeviceWillReset)(View *self);
 
  SDL_Rect (*renderFrame)(const View *self);
 
  void (*replaceSubview)(View *self, View *subview, View *replacement);
 
  void (*resignKeyResponder)(View *self);
 
  void (*resignTouchResponder)(View *self);
 
  void (*resize)(View *self, const SDL_Size *size);
 
  void (*resolve)(View *self, Outlet *outlets);
 
  void (*respondToEvent)(View *self, const SDL_Event *event);
 
  Set *(*select)(View *self, const char *rule);
 
  View *(*selectFirst)(View *self, const char *rule);
 
  void (*setVisibility)(View *self, ViewVisibility visibility);
 
  void (*setNeedsApplyTheme)(View *self);
 
  void (*setNeedsLayout)(View *self);
 
  SDL_Size (*size)(const View *self);
 
  SDL_Size (*sizeThatContains)(const View *self);
 
  SDL_Size (*sizeThatFits)(const View *self);
 
  SDL_Size (*sizeThatFills)(const View *self);
 
  SDL_Size (*sizeThatSatisfies)(View *self, ViewConstraint width, ViewConstraint height);
 
  void (*sizeToContain)(View *self);
 
  void (*sizeToFill)(View *self);
 
  void (*sizeToFit)(View *self);
 
  void (*sizeToSatisfy)(View *self, ViewConstraint width, ViewConstraint height);
 
  View *(*subviewWithIdentifier)(const View *self, const char *identifier);
 
  void (*updateBindings)(View *self, ident data);
 
  SDL_Rect (*viewport)(const View *self);
 
  View *(*viewWithCharacters)(const char *chars, Outlet *outlets);
 
  View *(*viewWithData)(const Data *data, Outlet *outlets);
 
  View *(*viewWithDictionary)(const Dictionary *dictionary, Outlet *outlets);
 
  View *(*viewWithResource)(const Resource *resource, Outlet *outlets);
 
  View *(*viewWithResourceName)(const char *name, Outlet *outlets);
 
  Array *(*visibleSubviews)(const View *self);
 
  void (*warn)(View *self, WarningType level, const char *fmt, ...);
 
  void (*willMoveToWindow)(View *self, SDL_Window *window);
};
 
OBJECTIVELYMVC_EXPORT Class *_View(void);
 
OBJECTIVELYMVC_EXPORT void MVC_InvalidateRenderFrames(void);

ClampSize

#define ClampSize	(		size,
			min,
			max
	)		clamp((size), (min), (max) ? (max) : INT32_MAX)

Clamps size to min and max, where a max of zero is unbounded.

Definition at line 103 of file View.h.

                                     : INT32_MAX)

CornerCutIsEmpty

#define CornerCutIsEmpty

(

cut

)

((cut).topLeft == 0 && (cut).topRight == 0 && (cut).bottomRight == 0 && (cut).bottomLeft == 0)

Returns

True if cut insets no corner.

Definition at line 204 of file View.h.

MakeConstraint

#define MakeConstraint	(		mode,
			value
	)		(ViewConstraint) { (mode), (value) }

Returns

A ViewConstraint with the given mode and value.

Definition at line 163 of file View.h.

                   { (mode), (value) }

MakeCornerCut

#define MakeCornerCut	(		topLeft,
			topRight,
			bottomRight,
			bottomLeft
	)		(ViewCornerCut) { (topLeft), (topRight), (bottomRight), (bottomLeft) }

Creates a ViewCornerCut with the given insets.

Definition at line 198 of file View.h.

                  { (topLeft), (topRight), (bottomRight), (bottomLeft) }

MakePadding

#define MakePadding	(		top,
			right,
			bottom,
			left
	)		(ViewPadding) { (top), (right), (bottom), (left) }

Creates a ViewPadding with the given dimensions.

Definition at line 176 of file View.h.

                { (top), (right), (bottom), (left) }

ViewAlignmentMaskAny

#define ViewAlignmentMaskAny    (ViewAlignmentMaskHorizontal | ViewAlignmentMaskVertical)

Definition at line 58 of file View.h.

ViewAlignmentMaskBottom

#define ViewAlignmentMaskBottom   0x4

Definition at line 46 of file View.h.

ViewAlignmentMaskCenter

#define ViewAlignmentMaskCenter   0x10

Definition at line 48 of file View.h.

ViewAlignmentMaskHorizontal

#define ViewAlignmentMaskHorizontal    (ViewAlignmentMaskLeft | ViewAlignmentMaskCenter | ViewAlignmentMaskRight)

Definition at line 55 of file View.h.

ViewAlignmentMaskInternal

#define ViewAlignmentMaskInternal   0x100

Definition at line 50 of file View.h.

ViewAlignmentMaskLeft

#define ViewAlignmentMaskLeft   0x8

Definition at line 47 of file View.h.

ViewAlignmentMaskMiddle

#define ViewAlignmentMaskMiddle   0x2

Definition at line 45 of file View.h.

ViewAlignmentMaskRight

#define ViewAlignmentMaskRight   0x20

Definition at line 49 of file View.h.

ViewAlignmentMaskTop

#define ViewAlignmentMaskTop   0x1

Definition at line 44 of file View.h.

ViewAlignmentMaskVertical

#define ViewAlignmentMaskVertical    (ViewAlignmentMaskTop | ViewAlignmentMaskMiddle | ViewAlignmentMaskBottom)

Definition at line 52 of file View.h.

Enumeration Type Documentation

ViewAlignment

enum ViewAlignment

Alignment constants, used to align a View within its superview.

Enumerator
ViewAlignmentNone
ViewAlignmentTop
ViewAlignmentMiddle
ViewAlignmentBottom
ViewAlignmentLeft
ViewAlignmentCenter
ViewAlignmentRight
ViewAlignmentTopLeft
ViewAlignmentTopCenter
ViewAlignmentTopRight
ViewAlignmentMiddleLeft
ViewAlignmentMiddleCenter
ViewAlignmentMiddleRight
ViewAlignmentBottomLeft
ViewAlignmentBottomCenter
ViewAlignmentBottomRight
ViewAlignmentInternal

Definition at line 64 of file View.h.

             {
  ViewAlignmentNone,
  ViewAlignmentTop = ViewAlignmentMaskTop,
  ViewAlignmentMiddle = ViewAlignmentMaskMiddle,
  ViewAlignmentBottom = ViewAlignmentMaskBottom,
  ViewAlignmentLeft = ViewAlignmentMaskLeft,
  ViewAlignmentCenter = ViewAlignmentMaskCenter,
  ViewAlignmentRight = ViewAlignmentMaskRight,
  ViewAlignmentTopLeft = (ViewAlignmentMaskTop | ViewAlignmentMaskLeft),
  ViewAlignmentTopCenter = (ViewAlignmentMaskTop | ViewAlignmentMaskCenter),
  ViewAlignmentTopRight = (ViewAlignmentMaskTop | ViewAlignmentMaskRight),
  ViewAlignmentMiddleLeft = (ViewAlignmentMaskMiddle | ViewAlignmentMaskLeft),
  ViewAlignmentMiddleCenter = (ViewAlignmentMaskMiddle | ViewAlignmentMaskCenter),
  ViewAlignmentMiddleRight = (ViewAlignmentMaskMiddle | ViewAlignmentMaskRight),
  ViewAlignmentBottomLeft = (ViewAlignmentMaskBottom | ViewAlignmentMaskLeft),
  ViewAlignmentBottomCenter = (ViewAlignmentMaskBottom | ViewAlignmentMaskCenter),
  ViewAlignmentBottomRight = (ViewAlignmentMaskBottom | ViewAlignmentMaskRight),
  ViewAlignmentInternal = ViewAlignmentMaskInternal
} ViewAlignment;

ViewAutoresizing

enum ViewAutoresizing

Auto-resizing constants, which are bitmasked.

Enumerator
ViewAutoresizingNone
ViewAutoresizingWidth
ViewAutoresizingHeight
ViewAutoresizingFill
ViewAutoresizingFit
ViewAutoresizingContain

Definition at line 89 of file View.h.

             {
  ViewAutoresizingNone = 0,
  ViewAutoresizingWidth = 0x1,
  ViewAutoresizingHeight = 0x2,
  ViewAutoresizingFill = 0x3,
  ViewAutoresizingFit = 0x4,
  ViewAutoresizingContain = 0x8
} ViewAutoresizing;

ViewPointerEvents

enum ViewPointerEvents

Whether a View is the result of a hit test.

Enumerator
ViewPointerEventsAuto
ViewPointerEventsNone

Definition at line 109 of file View.h.

             {
  ViewPointerEventsAuto,
  ViewPointerEventsNone
} ViewPointerEvents;

ViewPosition

enum ViewPosition

Relative positioning of subviews within their superview.

Enumerator
ViewPositionBefore
ViewPositionAfter

Definition at line 210 of file View.h.

             {
  ViewPositionBefore = -1,
  ViewPositionAfter = 1
} ViewPosition;

ViewVisibility

enum ViewVisibility

Visibility constants.

Enumerator
ViewVisibilityUnspecified
ViewVisibilityVisible
ViewVisibilityHidden

Definition at line 119 of file View.h.

             {
  ViewVisibilityUnspecified,
  ViewVisibilityVisible,
  ViewVisibilityHidden
} ViewVisibility;

Function Documentation

_View()

OBJECTIVELYMVC_EXPORT Class * _View

(

void

)

Definition at line 2336 of file View.c.

                   {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "View",
      .superclass = _Object(),
      .instanceSize = sizeof(View),
      .interfaceSize = sizeof(ViewInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}

MVC_InvalidateRenderFrames()

OBJECTIVELYMVC_EXPORT void MVC_InvalidateRenderFrames

(

void

)

Invalidates every View's cached View::renderFrame and View::clippingFrame.

WindowController::renderTo invokes this after layout, before drawing, so that drawing and subsequent hit-testing observe post-layout frames; both methods memoize their result until the next invocation. Callers that mutate View frames outside of a layout pass MUST invoke this afterwards if hit-testing precision is required before the next render.

Definition at line 46 of file View.c.

                                      {
  if (++_renderFrameGeneration == 0) {
    _renderFrameGeneration = 1;
  }
}

Variable Documentation

ViewAlignmentNames

OBJECTIVELYMVC_EXPORT const EnumName ViewAlignmentNames[]

Definition at line 84 of file View.h.

ViewAutoresizingNames

OBJECTIVELYMVC_EXPORT const EnumName ViewAutoresizingNames[]

Definition at line 98 of file View.h.

ViewPointerEventsNames

OBJECTIVELYMVC_EXPORT const EnumName ViewPointerEventsNames[]

Definition at line 114 of file View.h.

ViewVisibilityNames

OBJECTIVELYMVC_EXPORT const EnumName ViewVisibilityNames[]

Definition at line 126 of file View.h.