ObjectivelyMVC 0.1.0
Object oriented MVC framework for OpenGL, SDL2 and GNU C
Public Member Functions | Data Fields | Protected Attributes
CollectionItemView Struct Reference

CollectionViewItems are a visual representation of an item within a CollectionView. More...

#include <CollectionItemView.h>

Inheritance diagram for CollectionItemView:
View

Public Member Functions

Class * _CollectionItemView (void)
 The CollectionItemView archetype. More...
 
CollectionItemViewinitWithFrame (CollectionItemView *self)
 
CollectionItemViewinitWithFrame (CollectionItemView *self, const SDL_Rect *frame)
 Initializes this CollectionItemView with the specified frame. More...
 
void setSelected (CollectionItemView *self, _Bool isSelected)
 Sets the selected state of this item. More...
 
- Public Member Functions inherited from View
Class * _View (void)
 The View archetype. More...
 
_Bool acceptsFirstResponder (const View *self)
 
void addClassName (View *self, const char *className)
 Adds the given class name to this View. More...
 
void addSubview (View *self, View *subview)
 Adds a subview to this view, to be drawn above its siblings. More...
 
void addSubviewRelativeTo (View *self, View *subview, View *other, ViewPosition position)
 Adds a subview to this view, positioned relatively to other. More...
 
 ancestorWithIdentifier (const View *self, const char *identifier)
 
void applyStyle (View *self, const Style *style)
 Applies the given Style to this View. More...
 
void applyTheme (View *self, const Theme *theme)
 Applies the given Theme to this View. More...
 
void applyThemeIfNeeded (View *self, const Theme *theme)
 Recursively applies the Theme to this View and its subviews. More...
 
void attachStylesheet (View *self, SDL_Window *window)
 Attaches this View's Stylesheet to the Theme associated with the given window. More...
 
void awakeWithCharacters (View *self, const char *chars)
 Wakes this View with the given null-terminated JSON C string. More...
 
void awakeWithData (View *self, const Data *data)
 Wakes this View with the specified JSON Data. More...
 
void awakeWithDictionary (View *self, const Dictionary *dictionary)
 Wakes this View with the specified Dictionary. More...
 
void awakeWithResource (View *self, const Resource *resource)
 Wakes this View with the specified Resource. More...
 
void awakeWithResourceName (View *self, const char *name)
 Wakes this View with the Resource by the specified name. More...
 
void becomeFirstResponder (View *self)
 Become the first responder in the View hierarchy. More...
 
_Bool bind (View *self, const Inlet *inlets, const Dictionary *dictionary)
 Performs data binding for the Inlets described in dictionary. More...
 
SDL_Rect bounds (const View *self)
 
void bringSubviewToFront (View *self, View *subview)
 Brings the specified subview to the front. More...
 
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. More...
 
void didMoveToWindow (View *self, SDL_Window *window)
 Informs this View that it has been added to the View hierachy of the given window. More...
 
_Bool didReceiveEvent (const View *self, const SDL_Event *event)
 
void * draw (View *self, Renderer *renderer)
 Draws this View. More...
 
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. More...
 
void enumerateAdjacent (const View *self, ViewEnumerator enumerator, ident data)
 Enumerates adjacent siblings of this View, applying enumerator to each. More...
 
void enumerateAncestors (const View *self, ViewEnumerator enumerator, ident data)
 Enumerates all ancestors of this View, applying enumerator to each. More...
 
void enumerateDescendants (const View *self, ViewEnumerator enumerator, ident data)
 Enumerates all descendants of this View, applying enumerator to each. More...
 
void enumerateSelection (View *self, const char *rule, ViewEnumerator enumerator, ident data)
 Enumerates all Views in the selection matched by rule, applying enumerator to each. More...
 
void enumerateSiblings (const View *self, ViewEnumerator enumerator, ident data)
 Enumerates all siblings of this View, applying enumerator to each. More...
 
void enumerateSubviews (const View *self, ViewEnumerator enumerator, ident data)
 Enumerates all subviews of this View, applying enumerator to each. More...
 
void enumerateSuperview (const View *self, ViewEnumerator enumerator, ident data)
 Enumerates the superview of this View, if any, applying enumerator to it. More...
 
ViewfirstResponder (SDL_Window *window)
 
_Bool hasClassName (const View *self, cosnt char *className)
 
ViewhitTest (const View *self, const SDL_Point *point)
 Performs a hit test against this View and its descendants for the given point. More...
 
Viewinit (View *self)
 Initializes this View. More...
 
ViewinitWithFrame (View *self, const SDL_Rect *frame)
 Initializes this View with the specified frame. More...
 
void invalidateStyle (View *self)
 Invalidates the computed Style for this View and its descendants. More...
 
_Bool isContainer (const View *self)
 
_Bool isDescendantOfView (const View *self, const View *view)
 
_Bool isFirstResponder (const View *self)
 
_Bool isVisible (const View *self)
 
void layoutIfNeeded (View *self)
 Recursively updates the layout of this View and its subviews. More...
 
 layoutSubviews (View *self)
 Performs layout for this View's immediate subviews. More...
 
_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. More...
 
String * path (const View *self)
 
void removeAllClassNames (View *self)
 Removes all class names from this View. More...
 
void removeAllSubviews (View *self)
 Removes all subviews from this View. More...
 
void removeClassName (View *self, const char *className)
 Removes the given class name to this View. More...
 
void removeFromSuperview (View *self)
 Removes this View from its superview. More...
 
void removeSubview (View *self, View *subview)
 Removes the given subview from this View. More...
 
void render (View *self, Renderer *renderer)
 Renders this View using the given renderer. More...
 
void renderDeviceDidReset (View *self)
 Informs this View that the render device has reset. More...
 
void renderDeviceWillReset (View *self)
 Informs this View that the render device will reset. More...
 
SDL_Rect renderFrame (const View *self)
 
void replaceSubview (View *self, View *subview, View *replacement)
 Replaces the specified subview with the given replacement. More...
 
void resignFirstResponder (View *self)
 Resigns first responder priority. More...
 
void resize (View *self, const SDL_Size *size)
 Resizes this View to the specified size. More...
 
void resolve (View *self, Outlet *outlets)
 Resolves the given Outlets from this View's hierarchy. More...
 
void respondToEvent (View *self, const SDL_Event *event)
 Responds to the specified event. More...
 
Set * select (View *self, const char *rule)
 Resolves all descendants (including this View) that match the given Selector rule. More...
 
void setFirstResponder (SDL_Window *window, View *view)
 Sets the first responder for the given window. More...
 
SDL_Size size (const View *self)
 
SDL_Size sizeThatContains (const View *self)
 
void sizeThatFits (const View *self)
 
void sizeToContain (View *self)
 Resizes this View to contain its subviews. More...
 
void sizeToFit (View *self)
 Resizes this View to fit its subviews. More...
 
 subviewWithIdentifier (const View *self, const char *identifier)
 
void updateBindings (View *self)
 Updates data bindings, prompting the appropriate layout changes. More...
 
SDL_Rect viewport (const View *self)
 
ViewviewWithCharacters (const char *chars, Outlet *outlets)
 Instantiates a View initialized with the given null-terminated JSON C string. More...
 
ViewviewWithData (const Data *data, Outlet *outlets)
 Instantiates a View initialized with the contents of data. More...
 
ViewviewWithDictionary (const Dictionary *dictionary, Outlet *outlets)
 Instantiates a View initialized with the attributes described in dictionary. More...
 
ViewviewWithResource (const Resource *resource, Outlet *outlets)
 Instantiates a View initialized with the JSON data in resource. More...
 
ViewviewWithResourceName (const char *name, Outlet *outlets)
 Instantiates a View initialized with the JSON Resource with the specified name. More...
 
Array * visibleSubviews (const View *self)
 
void warn (View *self, const char *fmt,...)
 Appends a warning for this View. More...
 
void willMoveToWindow (View *self, SDL_Window *window)
 Informs this View that it will be added to the View hierarchy for the given window. More...
 

Data Fields

ImageViewimageView
 The ImageView. More...
 
_Bool isSelected
 True when this item is selected, false otherwise. More...
 
ViewselectionOverlay
 The View drawn over this item when it is selected. More...
 
Texttext
 The text. More...
 
View view
 The superclass. More...
 
- Data Fields inherited from View
ViewAlignment alignment
 The alignment. More...
 
int autoresizingMask
 The ViewAutoresizing bitmask. More...
 
SDL_Color backgroundColor
 The background color. More...
 
SDL_Color borderColor
 The border color. More...
 
int borderWidth
 The border width. More...
 
MutableSet * classNames
 The class names. More...
 
_Bool clipsSubviews
 If true, subviews will be clipped to this View's frame. More...
 
StylecomputedStyle
 The computed Style of this View. More...
 
SDL_Rect frame
 The frame, relative to the superview. More...
 
_Bool hidden
 If true, this View is not drawn. More...
 
char * identifier
 An optional identifier. More...
 
SDL_Size maxSize
 The maximum size this View may be resized to during layout. More...
 
SDL_Size minSize
 The minimum size this View may be resized to during layout. More...
 
_Bool needsApplyTheme
 If true, this View will apply the Theme before it is drawn. More...
 
_Bool needsLayout
 If true, this View will layout its subviews before it is drawn. More...
 
ViewnextResponder
 The next responder, or event handler, in the chain. More...
 
Object object
 The superclass. More...
 
ViewPadding padding
 The padding. More...
 
Stylestyle
 The element-level Style of this View. More...
 
Stylesheetstylesheet
 An optional Stylesheet. More...
 
MutableArray * subviews
 The immediate subviews. More...
 
Viewsuperview
 The super View. More...
 
ViewControllerviewController
 The ViewController. More...
 
MutableArray * warnings
 The warnings this View generated. More...
 
SDL_Window * window
 The window. More...
 

Protected Attributes

CollectionItemViewInterface * interface
 The interface. More...
 
- Protected Attributes inherited from View
ViewInterface * interface
 The interface. More...
 

Detailed Description

CollectionViewItems are a visual representation of an item within a CollectionView.

Definition at line 43 of file CollectionItemView.h.

Member Function Documentation

◆ _CollectionItemView()

Class * _CollectionItemView ( void  )

The CollectionItemView archetype.

Returns
The CollectionItemView Class.

Definition at line 137 of file CollectionItemView.c.

137 {
138 static Class *clazz;
139 static Once once;
140
141 do_once(&once, {
142 clazz = _initialize(&(const ClassDef) {
143 .name = "CollectionItemView",
144 .superclass = _View(),
145 .instanceSize = sizeof(CollectionItemView),
146 .interfaceOffset = offsetof(CollectionItemView, interface),
147 .interfaceSize = sizeof(CollectionItemViewInterface),
149 });
150 });
151
152 return clazz;
153}
static void initialize(Class *clazz)
CollectionViewItems are a visual representation of an item within a CollectionView.
CollectionItemViewInterface * interface
The interface.
Class * _View(void)
The View archetype.
Definition: View.c:1769

◆ initWithFrame() [1/2]

CollectionItemView * initWithFrame ( CollectionItemView self)

◆ initWithFrame() [2/2]

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

Initializes this CollectionItemView with the specified frame.

Parameters
selfThe CollectionItemView.
frameThe frame.
Returns
The initialized CollectionItemView, or NULL on error.

Definition at line 77 of file CollectionItemView.c.

77 {
78
79 self = (CollectionItemView *) super(View, self, initWithFrame, frame);
80 if (self) {
81 self->imageView = $(alloc(ImageView), initWithFrame, frame);
82 assert(self->imageView);
83
85
86 $((View *) self, addSubview, (View *) self->imageView);
87
88 self->text = $(alloc(Text), initWithText, NULL, NULL);
89 assert(self->text);
90
91 self->text->view.alignment = ViewAlignmentMiddleCenter;
92
93 $((View *) self, addSubview, (View *) self->text);
94
95 self->selectionOverlay = $(alloc(View), initWithFrame, NULL);
96 assert(self->selectionOverlay);
97
98 $(self->selectionOverlay, addClassName, "selectionOverlay");
99
100 self->selectionOverlay->autoresizingMask = ViewAutoresizingFill;
101
102 $((View *) self, addSubview, self->selectionOverlay);
103
104 self->view.clipsSubviews = true;
105 }
106
107 return self;
108}
static Label * initWithText(Label *self, const char *text, Font *font)
Definition: Label.c:96
@ ViewAutoresizingFill
Definition: View.h:89
@ ViewAlignmentMiddleCenter
Definition: View.h:72
CollectionItemView * initWithFrame(CollectionItemView *self)
ImageView * imageView
The ImageView.
ImageViews render an Image in the context of a View hierarchy.
Definition: ImageView.h:43
View view
The superclass.
Definition: ImageView.h:48
Text rendered with TrueType fonts.
Definition: Text.h:41
Views are the fundamental building blocks of ObjectivelyMVC user interfaces.
Definition: View.h:133
_Bool clipsSubviews
If true, subviews will be clipped to this View's frame.
Definition: View.h:180
ViewAlignment alignment
The alignment.
Definition: View.h:149
void addSubview(View *self, View *subview)
Adds a subview to this view, to be drawn above its siblings.
Definition: PageView.c:35
void addClassName(View *self, const char *className)
Adds the given class name to this View.
Definition: View.c:120
int autoresizingMask
The ViewAutoresizing bitmask.
Definition: View.h:154
SDL_Rect frame
The frame, relative to the superview.
Definition: View.h:190

◆ setSelected()

void setSelected ( CollectionItemView self,
_Bool  isSelected 
)

Sets the selected state of this item.

Parameters
selfThe CollectionItemView.
isSelectedThe selected state.
Remarks
Subclasses may override this method to change the visual cue for selection.

Definition at line 114 of file CollectionItemView.c.

114 {
115 self->isSelected = isSelected;
116}
_Bool isSelected
True when this item is selected, false otherwise.

Field Documentation

◆ imageView

ImageView* CollectionItemView::imageView

The ImageView.

Definition at line 59 of file CollectionItemView.h.

◆ interface

CollectionItemViewInterface* CollectionItemView::interface
protected

The interface.

Definition at line 54 of file CollectionItemView.h.

◆ isSelected

_Bool CollectionItemView::isSelected

True when this item is selected, false otherwise.

Definition at line 64 of file CollectionItemView.h.

◆ selectionOverlay

View* CollectionItemView::selectionOverlay

The View drawn over this item when it is selected.

Definition at line 69 of file CollectionItemView.h.

◆ text

Text* CollectionItemView::text

The text.

Definition at line 74 of file CollectionItemView.h.

◆ view

View CollectionItemView::view

The superclass.

Definition at line 48 of file CollectionItemView.h.


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