ScrollViews allow users to pan their internal contents. More...

#include <ScrollView.h>

Inheritance diagram for ScrollView:

Public Member Functions
Class *	_ScrollView (void)
	The ScrollView archetype.

ScrollView *	initWithFrame (ScrollView self, const SDL_Rect frame)
	Initializes this ScrollView with the specified frame and style.

void	scrollToOffset (ScrollView *self, const SDL_Point offset)
	Scrolls the content View to the specified offset.

void	setContentView (ScrollView self, View contentView)
	Sets the content view of this ScrollView.

void	setScrollBarVisibility (ScrollView *self, ScrollBarVisibility visibility)
	Sets whether this ScrollView's ScrollBar is shown, hidden, or shown only as needed.

Public Member Functions inherited from View
Class *	_View (void)
	The View archetype.

bool	acceptsKeyResponder (const View *self)

bool	acceptsTouchResponder (const View *self)

void	addClassName (View self, const char className)
	Adds the given class name to this View.

void	addSubview (View self, View subview)
	Adds a subview to this view, to be drawn above its siblings.

void	addSubviewRelativeTo (View self, View subview, View *other, ViewPosition position)
	Adds a subview to this view, positioned relatively to `other`.

	ancestorWithIdentifier (const View self, const char identifier)

void	applyStyle (View self, const Style style)
	Applies the given Style to this View.

void	applyTheme (View self, const Theme theme)
	Applies the given Theme to this View.

void	applyThemeIfNeeded (View self, const Theme theme)
	Recursively applies the Theme to this View and its subviews.

void	attachStylesheet (View self, SDL_Window window)
	Attaches this View's Stylesheet to the Theme associated with the given window.

void	awakeWithCharacters (View self, const char chars)
	Wakes this View with the given null-terminated JSON C string.

void	awakeWithData (View self, const Data data)
	Wakes this View with the specified JSON Data.

void	awakeWithDictionary (View , const Dictionary )
	Wakes this View with the specified Dictionary.

void	awakeWithResource (View self, const Resource resource)
	Wakes this View with the specified Resource.

void	awakeWithResourceName (View self, const char name)
	Wakes this View with the Resource by the specified name.

void	becomeKeyResponder (View *self)
	Become the key responder in the View hierarchy.

void	becomeTouchResponder (View *self)
	Become the touch responder in the View hierarchy.

bool	bind (View self, const Inlet inlets, const Dictionary *dictionary)
	Performs data binding for the Inlets described in `dictionary`.

SDL_Rect	bounds (const View *self)

void	bringSubviewToFront (View self, View subview)
	Brings the specified subview to the front.

void	clearWarnings (const View *self, WarningType type)
	Clears this View's Warnings matching the given level.

SDL_Rect	clippingFrame (const View *self)

bool	containsPoint (const View self, const SDL_Point point)

int	depth (const View *self)

	descendantWithIdentifier (const View self, const char identifier)

void	detachStylesheet (View self, SDL_Window window)
	Detaches this View's Stylesheet from the Theme associated with the given window.

void	didMoveToWindow (View self, SDL_Window window)
	Informs this View that it has been added to the View hierachy of the given window.

bool	didReceiveEvent (const View self, const SDL_Event event)

void	draw (View self, Renderer renderer)
	Draws this View.

void	emitViewEvent (View *self, ViewEvent code, ident data)
	Emits a ViewEvent originating from this View.

void	enumerate (const View *self, ViewEnumerator enumerator, ident data)

void	enumerate (View *self, ViewEnumerator enumerator, ident data)
	Enumerates this View and its descendants, applying `enumerator` to each.

void	enumerateAdjacent (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates adjacent siblings of this View, applying `enumerator` to each.

void	enumerateAncestors (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all ancestors of this View, applying `enumerator` to each.

void	enumerateDescendants (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all descendants of this View, applying `enumerator` to each.

void	enumerateSelection (View self, const char rule, ViewEnumerator enumerator, ident data)
	Enumerates all Views in the selection matched by `rule`, applying `enumerator` to each.

void	enumerateSiblings (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all siblings of this View, applying `enumerator` to each.

void	enumerateSubviews (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all subviews of this View, applying `enumerator` to each.

void	enumerateSuperview (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates the superview of this View, if any, applying `enumerator` to it.

void	enumerateVisible (const View *self, ViewEnumerator enumerator, ident data)

void	enumerateVisible (View *self, ViewEnumerator enumerator, ident data)
	Enumerates this View and its visible descendants, applying `enumerator` to each.

bool	hasClassName (const View self, cosnt char className)

bool	hasOverflow (const View *self)

View *	hitTest (const View self, const SDL_Point point)
	Performs a hit test against this View and its descendants for the given point.

View *	init (View *self)
	Initializes this View.

View *	initWithFrame (View self, const SDL_Rect frame)
	Initializes this View with the specified frame.

void	invalidateStyle (View *self)
	Invalidates the computed Style for this View and its descendants.

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)
	Recursively updates the layout of this View and its subviews.

	layoutSubviews (View *self)
	Arranges this View's immediate subviews within its (already final) frame.

void	layoutWithConstraint (View *self, ViewConstraint width, ViewConstraint height)
	Resolves this View's size against the given ViewConstraints, then arranges it.

void	layoutWithSize (View self, const SDL_Size size)
	Resizes this View to the given size, then arranges it.

bool	matchesSelector (const View self, const SimpleSelector simpleSelector)

void	moveToWindow (View self, SDL_Window window)
	Moves this View to the View hierarchy of the given window.

String *	path (const View *self)

void	removeAllClassNames (View *self)
	Removes all class names from this View.

void	removeAllSubviews (View *self)
	Removes all subviews from this View.

void	removeClassName (View self, const char className)
	Removes the given class name to this View.

void	removeFromSuperview (View *self)
	Removes this View from its superview.

void	removeSubview (View self, View subview)
	Removes the given subview from this View.

void	render (View self, Renderer renderer)
	Renders this View using the given renderer.

void	renderDeviceDidReset (View *self)
	Informs this View that the render device has reset.

void	renderDeviceWillReset (View *self)
	Informs this View that the render device will reset.

SDL_Rect	renderFrame (const View *self)

void	replaceSubview (View self, View subview, View *replacement)
	Replaces the specified subview with the given replacement.

void	resignKeyResponder (View *self)
	Resigns key responder priority.

void	resignTouchResponder (View *self)
	Resigns touch responder priority.

void	resize (View self, const SDL_Size size)
	Resizes this View to the specified size.

void	resolve (View self, Outlet outlets)
	Resolves the given Outlets from this View's hierarchy.

void	respondToEvent (View self, const SDL_Event event)
	Responds to the specified event.

Set *	select (View self, const char rule)
	Resolves all descendants (including this View) that match the given Selector rule.

View *	selectFirst (View self, const char rule)
	Resolves the first descendant View that matches the given Selector rule.

void	setNeedsApplyTheme (View *self)
	Marks this View as needing Theme application before it is next drawn.

void	setNeedsLayout (View *self)
	Marks this View as needing layout before it is next drawn.

void	setVisibility (View *self, ViewVisibility visibility)
	Sets this View's visibility.

SDL_Size	size (const View *self)

SDL_Size	sizeThastFills (const View *self)

SDL_Size	sizeThatContains (const View *self)

SDL_Size	sizeThatFills (const View *self)

void	sizeThatFits (const View *self)

SDL_Size	sizeThatSatisfies (View *self, ViewConstraint width, ViewConstraint height)
	Resolves the size this View wants to be, within the offered ViewConstraints.

void	sizeToContain (View *self)
	Resizes this View to contain its subviews.

void	sizeToFill (View *self)
	Resizes this View to fill its superview.

void	sizeToFit (View *self)
	Resizes this View to fit its subviews.

void	sizeToSatisfy (View *self, ViewConstraint width, ViewConstraint height)
	Resizes this View to satisfy the given ViewConstraints.

	subviewWithIdentifier (const View self, const char identifier)

void	updateBindings (View *self, ident data)
	Updates data bindings, prompting the appropriate layout changes.

SDL_Rect	viewport (const View *self)

View *	viewWithCharacters (const char chars, Outlet outlets)
	Instantiates a View initialized with the given null-terminated JSON C string.

View *	viewWithData (const Data data, Outlet outlets)
	Instantiates a View initialized with the contents of `data`.

View *	viewWithDictionary (const Dictionary dictionary, Outlet outlets)
	Instantiates a View initialized with the attributes described in `dictionary`.

View *	viewWithResource (const Resource resource, Outlet outlets)
	Instantiates a View initialized with the JSON data in `resource`.

View *	viewWithResourceName (const char name, Outlet outlets)
	Instantiates a View initialized with the JSON Resource with the specified `name`.

Array *	visibleSubviews (const View *self)

void	warn (View self, ViewWarningType type, const char fmt,...)

void	warn (View self, WarningType level, const char fmt,...)
	Appends a warning for this View.

void	willMoveToWindow (View self, SDL_Window window)
	Informs this View that it will be added to the View hierarchy for the given window.

Static Public Member Functions
static void	scrollToOffset (ScrollView self, const SDL_Point offset)
	Scrolls the content View to the specified offset.

Data Fields
SDL_Point	contentOffset
	The content View offset.

View *	contentView
	The content View.

Control	control
	The superclass.

ScrollBar *	scrollBar
	The scrollbar. Always present; shown per `scrollBarVisibility` (see the `scrollbar` style attribute / `setScrollBarVisibility`).

ScrollBarVisibility	scrollBarVisibility
	Governs whether the scrollbar is shown. Attribute `scrollbar`.

float	step
	The scroll step, in pixels.

Data Fields inherited from View
ViewAlignment	alignment
	The alignment.

int	autoresizingMask
	The ViewAutoresizing bitmask.

SDL_Color	backgroundColor
	The background color.

int	backgroundGradientAngle
	The angle of the background gradient, in degrees, clockwise from south: `0` (the default) fills downwards, `90` to the right, `180` upwards.

SDL_Color	backgroundGradientColor
	The far color of the background gradient, which runs from View::backgroundColor.

SDL_Color	borderColor
	The border color.

int	borderRadius
	The corner radius applied to the background, border and bevel.

int	borderWidth
	The border width.

Set *	classNames
	The class names.

bool	clipsSubviews
	If true, subviews will be clipped to this View's frame.

Style *	computedStyle
	The computed Style of this View.

ViewCornerCut	cornerCut
	The horizontal inset of each corner of the background and border.

char *	identifier
	An optional identifier.

SDL_Size	maxSize
	The maximum size this View may be resized to during layout.

SDL_Size	minSize
	The minimum size this View may be resized to during layout.

bool	needsApplyTheme
	If true, this View will apply the Theme before it is drawn.

bool	needsLayout
	If true, this View will layout its subviews before it is drawn.

View *	nextResponder
	The next responder, or event handler, in the chain.

Object	object
	The superclass.

ViewPadding	padding
	The padding.

ViewPointerEvents	pointerEvents
	Whether this View is the result of a hit test; its subviews always are.

bool	stretch
	Whether this View takes a share of the space its StackView leaves along its axis.

Style *	style
	The element-level Style of this View.

Stylesheet *	stylesheet
	An optional Stylesheet.

Array *	subviews
	The immediate subviews.

View *	superview
	The super View.

ViewController *	viewController
	The ViewController.

ViewVisibility	visibility
	Whether this View is drawn, and contributes to its superview's size.

Array *	warnings
	The Warnings this View generated.

SDL_Window *	window
	The window.

Protected Attributes
ScrollViewInterface *	interface [0]
	The interface type.

Protected Attributes inherited from View
ViewInterface *	interface [0]
	The interface type.

Detailed Description

ScrollViews allow users to pan their internal contents.

Forward declaration; ScrollView.h includes this header to embed a ScrollBar, so it can't be included here without a cycle.

Definition at line 61 of file ScrollView.h.

Member Function Documentation

◆ _ScrollView()

Class * _ScrollView ( void )

The ScrollView archetype.

Returns: The ScrollView Class.

Definition at line 292 of file ScrollView.c.

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

◆ initWithFrame()

ScrollView * initWithFrame	(	ScrollView *	self,
		const SDL_Rect *	frame
	)

Initializes this ScrollView with the specified frame and style.

Parameters

self	The ScrollView.
frame	The frame.

Returns: The initialized ScrollView, or NULL on error.

Definition at line 179 of file ScrollView.c.

                                                                          {
 
  self = (ScrollView *) super(Control, self, initWithFrame, frame);
  if (self) {
    self->step = 12.f;
 
    self->scrollBar = $(alloc(ScrollBar), initWithScrollView, self);
    assert(self->scrollBar);
 
    View *scrollBar = (View *) self->scrollBar;
    $(scrollBar, setVisibility, ViewVisibilityHidden);
 
    $((View *) self, addSubview, scrollBar);
  }
 
  return self;
}

◆ scrollToOffset() [1/2]

static void scrollToOffset	(	ScrollView *	self,
		const SDL_Point *	offset
	)

static

Scrolls the content View to the specified offset.

Definition at line 201 of file ScrollView.c.

                                                                      {
 
  if (self->contentView) {
    const SDL_Size contentSize = $(self->contentView, size);
    const SDL_Rect bounds = $((View *) self, bounds);
 
    if (contentSize.w > bounds.w) {
      self->contentOffset.x = clamp(offset->x, -(contentSize.w - bounds.w), 0);
    } else {
      self->contentOffset.x = 0;
    }
 
    if (contentSize.h > bounds.h) {
      self->contentOffset.y = clamp(offset->y, -(contentSize.h - bounds.h), 0);
    } else {
      self->contentOffset.y = 0;
    }
 
  } else {
    self->contentOffset.x = self->contentOffset.y = 0;
  }
 
  $((View *) self, setNeedsLayout);
  $((View *) self->scrollBar, setNeedsLayout);
}

◆ scrollToOffset() [2/2]

void scrollToOffset	(	ScrollView *	self,
		const SDL_Point	offset
	)

Scrolls the content View to the specified offset.

Parameters

self	The ScrollView.
offset	The offset.

◆ setContentView()

void setContentView	(	ScrollView *	self,
		View *	contentView
	)

Sets the content view of this ScrollView.

Parameters

self	The ScrollView.
contentView	The content view.

Definition at line 231 of file ScrollView.c.

                                                                {
 
  if (contentView != self->contentView) {
 
    if (self->contentView) {
      $(self->contentView, removeClassName, "contentView");
      $((View *) self, removeSubview, self->contentView);
      self->contentView = release(self->contentView);
    }
 
    if (contentView) {
      $(contentView, addClassName, "contentView");
      $((View *) self, addSubview, contentView);
      self->contentView = retain(contentView);
    }
    
    $((View *) self, addSubview, (View *) self->scrollBar);
 
    $(self, scrollToOffset, &MakePoint(0, 0));
  }
}

◆ setScrollBarVisibility()

void setScrollBarVisibility	(	ScrollView *	self,
		ScrollBarVisibility	visibility
	)

Sets whether this ScrollView's ScrollBar is shown, hidden, or shown only as needed.

Parameters

self	The ScrollView.
visibility	The ScrollBarVisibility.

Definition at line 257 of file ScrollView.c.

                                                                                     {
 
  View *this = (View *) self;
 
  $(this->style, addEnumAttribute, "scrollbar", ScrollBarVisibilityNames, visibility);
 
  $(this, invalidateStyle);
}

Field Documentation

◆ contentOffset

SDL_Point ScrollView::contentOffset

The content View offset.

Definition at line 77 of file ScrollView.h.

◆ contentView

View* ScrollView::contentView

The content View.

Remarks: A JSON layout MAY declare it as "contentView": { ... }, which is the same as ScrollView::setContentView with the resulting View.

Definition at line 84 of file ScrollView.h.

◆ control

Control ScrollView::control

The superclass.

Definition at line 66 of file ScrollView.h.

◆ interface

ScrollViewInterface* ScrollView::interface[0]

protected

The interface type.

Definition at line 72 of file ScrollView.h.

◆ scrollBar

ScrollBar* ScrollView::scrollBar

The scrollbar. Always present; shown per scrollBarVisibility (see the scrollbar style attribute / setScrollBarVisibility).

Definition at line 95 of file ScrollView.h.

◆ scrollBarVisibility

ScrollBarVisibility ScrollView::scrollBarVisibility

Governs whether the scrollbar is shown. Attribute scrollbar.

ScrollBarAuto (the default) shows it only when the content View's height exceeds this ScrollView's own.

Remarks: Styled. Set from a Style, and overwritten by the next one applied. Assign View::style, or a stylesheet rule, rather than this field.

Definition at line 103 of file ScrollView.h.

◆ step

float ScrollView::step

The scroll step, in pixels.

Definition at line 89 of file ScrollView.h.

The documentation for this struct was generated from the following files:

Sources/ObjectivelyMVC/ScrollView.h
Sources/ObjectivelyMVC/ScrollView.c

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Member Function Documentation

◆ _ScrollView()

◆ initWithFrame()

◆ scrollToOffset() [1/2]

◆ scrollToOffset() [2/2]

◆ setContentView()

◆ setScrollBarVisibility()

Field Documentation

◆ contentOffset

◆ contentView

◆ control

◆ interface

◆ scrollBar

◆ scrollBarVisibility

◆ step