gamepad-vgfx-element.h

Go to the documentation of this file.

/*
 * gamepad-vgfx-element.h
 *
 * Copyright (C) 2010  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Drawing gamepad dialog elements using vector graphics interfaces
 */

#ifndef GAMEPAD_GAMEPAD_VGFX_ELEMENT_H__
#define GAMEPAD_GAMEPAD_VGFX_ELEMENT_H__

// includes --------------------------------------------------------------------
#include "dialog/dialog.h"
#include "gamepad/manager.h"
#include "vgfx/drawer.h"


namespace gamepad {


/// \ingroup gamepad_api
/// \defgroup gamepad_vgfx_element Gamepad Vector Graphics Dialog Elements
///
/// These are dialog::Element objects that are rendered using the Vector
/// Graphics Engine (vgfx).
/*@{*/


/// what is the name of the testing element?
const char * getVgfxTestElementName(void) throw();


/// what is the name of the simple rendering element?
const char * getVgfxSimpleElementName(void) throw();


/// register the vgfx-based testing dialog Element with the dialog Manager
void registerVgfxTestFactory(IN smart_ptr<Manager>& gamepadMgr,
                        IN dialog::Manager * dialogMgr,
                        IN smart_ptr<vgfx::Drawer>& drawer);


/// register the vgfx-based simple rendering dialog Element with the Manager
void registerVgfxSimpleFactory(IN smart_ptr<Manager>& gamepadMgr,
                        IN dialog::Manager * dialogMgr,
                        IN smart_ptr<vgfx::Drawer>& drawer);


};      // gamepad namespace


#endif  // GAMEPAD_GAMEPAD_VGFX_ELEMENT_H__