Control.h

Go to the documentation of this file.

/*
 * ObjectivelyMVC: Object oriented MVC framework for OpenGL, SDL2 and GNU C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <Objectively/MutableArray.h>
 
#include <ObjectivelyMVC/Action.h>
#include <ObjectivelyMVC/Text.h>
 
typedef enum {
    ControlBevelNone,
    ControlBevelInset,
    ControlBevelOutset
} ControlBevel;
 
OBJECTIVELYMVC_EXPORT const EnumName ControlBevelNames[];
 
typedef enum {
    ControlSelectionNone,
    ControlSelectionSingle,
    ControlSelectionMultiple
} ControlSelection;
 
OBJECTIVELYMVC_EXPORT const EnumName ControlSelectionNames[];
 
typedef enum {
    ControlStateDefault = 0x0,
    ControlStateHighlighted = 0x1,
    ControlStateDisabled = 0x2,
    ControlStateSelected = 0x4,
    ControlStateFocused = 0x8,
} ControlState;
 
OBJECTIVELYMVC_EXPORT const EnumName ControlStateNames[];
 
typedef struct ControlInterface ControlInterface;
 
struct Control {
 
    View view;
 
    ControlInterface *interface;
 
    MutableArray *actions;
 
    ControlBevel bevel;
 
    unsigned int state;
 
    ControlSelection selection;
};
 
struct ControlInterface {
 
    ViewInterface viewInterface;
 
    Array *(*actionsForEvent)(const Control *self, const SDL_Event *event);
 
    void (*addActionForEventType)(Control *self, SDL_EventType eventType, ActionFunction function, ident sender, ident data);
 
    _Bool (*captureEvent)(Control *self, const SDL_Event *event);
 
    Control *(*initWithFrame)(Control *self, const SDL_Rect *frame);
 
    _Bool (*isDisabled)(const Control *self);
 
    _Bool (*isFocused)(const Control *self);
 
    _Bool (*isHighlighted)(const Control *self);
 
    _Bool (*isSelected)(const Control *self);
 
    void (*stateDidChange)(Control *self);
};
 
OBJECTIVELYMVC_EXPORT Class *_Control(void);