dialog/drawer.h

Go to the documentation of this file.

/*
 * drawer.h
 *
 * Copyright (C) 2009  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.
 *
 */

#ifndef WAVEPACKET_DIALOG_DRAWER_H__
#define WAVEPACKET_DIALOG_DRAWER_H__

// includes --------------------------------------------------------------------
#include "geometry/geometry_2d.h"
#include "threadsafe/smart_ptr.h"


namespace dialog {

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


typedef point2d_t<int> point_t;
typedef rect2d_t<int> rect_t;


/// sizing information about how a font is rendered
struct font_size_t {
        font_size_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        lead = trail = drop = rise = 0;
                }

        // data fields
        int             lead;   ///< pixels to left of draw origin
        int             trail;  ///< pixels to right of draw origin
        int             drop;   ///< pixels below draw origin
        int             rise;   ///< pixels above draw origin
};



struct border_size_t {
        border_size_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        size = 0;
                }

        // data fields
        int             size;   ///< border in x/y directions
};



/// types of elements that appear in a dialog
enum eElementType {
        eElement_Button         = 1,  ///< a simple text-only button
        eElement_Label          = 2,  ///< read-only text
        eElement_Textbox        = 3,  ///< a box for inputting text

        eElement_Container      = 50, ///< contains a group of elements
        eElement_Dialog         = 60, ///< a top-level dialog object

        // keep this last!
        eElement_Invalid        = 0
};



/// This is the object that is capable of rendering dialogs.
/// This library (core dialog library) does NOT render dialogs!  That is up to
///     a client-supplied library.
/// This is the interface that the client must support to render dialogs.
class Drawer {
public:
        // virtual constructor -------------------------------------------------
        virtual ~Drawer(void) throw();

        // dialog::Drawer class interface methods ------------------------------

        /// return the pixel size of the given string (based on whatever font
        ///     the Drawer wants to use for this sort of element)
        virtual font_size_t getFontSizing(IN eElementType type,
                                IN const char * text) = 0;

        /// return the border size (in pixels) for the given element type
        virtual border_size_t getBorderSizing(IN eElementType type) = 0;

        /// draw a string (using whatever font the Drawer wants to use for
        ///     this element type) at the given position.
        virtual void drawString(IN eElementType type,
                                IN const point_t& pos,
                                IN const char * text) = 0;

        /// draw a rect with a border at the given position.  The rect interior
        ///     AND the border should neatly fit within the specified rectangle.
        virtual void drawRectWithBorder(IN eElementType type,
                                IN const rect_t& rect) = 0;

        /// draw a circle at the specified position
        virtual void drawCircle(IN const point_t& pos,
                                IN float radius) = 0;
};



/// for testing, we provide a text-only drawer
class TextDrawer : public Drawer {
public:
        // virtual destructor --------------------------------------------------
        virtual ~TextDrawer(void) throw();

        // dialog::TextDrawer class interface methods --------------------------
        virtual void writeToStream(IO std::ostream& stream) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<TextDrawer> create(IN int borderSize);
};



};      // dialog namespace

#endif  // WAVEPACKET_DIALOG_DRAWER_H__