prop_types.h

Go to the documentation of this file.

/*
 * prop_types.h
 *
 * Copyright (C) 2007   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.
 *
 *
 * Utility methods for various property types.
 * Here as a convenience for clients.
 */

#ifndef WAVEPACKET_OBJTREE_PROP_TYPES_H__
#define WAVEPACKET_OBJTREE_PROP_TYPES_H__

// includes --------------------------------------------------------------------
#include "common/common.h"


namespace objtree {


////////////////////////////////////////////////////////////////////////////////
//
//      COLOR property type
//
////////////////////////////////////////////////////////////////////////////////

struct color_t {
        int     red;
        int     green;
        int     blue;
        int     alpha;
};

color_t getColorFromString(IN const char * text);

void getStringFromColor(IN const color_t& c,
                                OUT std::string& out);


////////////////////////////////////////////////////////////////////////////////
//
//      FONT property type
//
////////////////////////////////////////////////////////////////////////////////

struct font_t {
        font_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        face_name = "";
                        point_size = 0;
                        italic = bold = underline = strikeout = false;
                };

        // data fields
        std::string             face_name;      // "Times New Roman", etc.
        float                   point_size;
        bool                    italic;
        bool                    bold;
        bool                    underline;
        bool                    strikeout;
};


void getFontFromString(IN const char * info,
                                OUT font_t& font);

void getStringFromFont(IN const font_t& font,
                                OUT std::string& out);

void getDisplayStringFromFont(IN const font_t& font,
                                OUT std::string& pretty);

};      // objtree namespace

#endif  // WAVEPACKET_OBJTREE_PROP_TYPES_H__