element.h

Go to the documentation of this file.

/*
 * element.h
 *
 * Copyright (C) 2008,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.
 *
 *
 * Basic dialog element.  This is *very* basic, capturing the base class of
 * elements in the dialog hierarchy.
 */

#ifndef WAVEPACKET_DIALOG_ELEMENT_H__
#define WAVEPACKET_DIALOG_ELEMENT_H__

// includes --------------------------------------------------------------------
#include "drawer.h"
#include "wave-crypto/wave-crypto.h"


// forward declaration
class Datahash;


namespace dialog {

// forward declaration
class Manager;


/// \ingroup dialog
/*@{*/


////////////////////////////////////////////////////////////////////////////////
//
//      Element base class
//
////////////////////////////////////////////////////////////////////////////////

class Element {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Element(void) throw();

        // dialog::Element class interface methods ------------------------------
        virtual int getWidth(void) = 0;
        virtual int getHeight(void) = 0;
        virtual void draw(IN const point_t& offset) = 0;
        virtual void cursor(IN const point_t& pos) = 0;
        virtual const char * keyboard(IN int key, IN int mods);
        virtual Element * getFocus(IN const point_t& pos);
        virtual void notifyFocus(IN bool haveFocus);
        virtual const char * button(IN int button, IN int state,
                                IN const point_t& pos) = 0;
        virtual void addData(IN crypto::DESKey * key,
                                IO Datahash * data);
};



smart_ptr<Element> constructElementTree(IN Manager * mgr,
                                IN const Datahash * hash);



///     Clients will need to provide an object that implements this interface if
///     they want to provide their own custom-defined dialog::Element objects.
class Factory {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Factory(void) throw();

        // dialog::Factory class interface methods -----------------------------
        virtual smart_ptr<Element> createElement(IN const char * type,
                                        IN Manager * mgr,
                                        IN const Datahash * data) = 0;
};



/// factory for built-in types
smart_ptr<Factory> getDefaultFactory(void);


/// helper method to register default types with a manager
void registerDefaultFactories(IN Manager * mgr);



};      // dialog namespace

#endif  // WAVEPACKET_DIALOG_ELEMENT_H__