mmsinputwidgetclass.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2007 Stefan Schwarzer, Jens Schneider,             *
 *                           Matthias Hardt, Guido Madaus                  *
 *                                                                         *
 *   Copyright (C) 2007-2008 BerLinux Solutions GbR                        *
 *                           Stefan Schwarzer & Guido Madaus               *
 *                                                                         *
 *   Copyright (C) 2009-2013 BerLinux Solutions GmbH                       *
 *                                                                         *
 *   Authors:                                                              *
 *      Stefan Schwarzer   <stefan.schwarzer@diskohq.org>,                 *
 *      Matthias Hardt     <matthias.hardt@diskohq.org>,                   *
 *      Jens Schneider     <jens.schneider@diskohq.org>,                   *
 *      Guido Madaus       <guido.madaus@diskohq.org>,                     *
 *      Patrick Helterhoff <patrick.helterhoff@diskohq.org>,               *
 *      René Bählkow       <rene.baehlkow@diskohq.org>                     *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License version 2.1 as published by the Free Software Foundation.     *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
 **************************************************************************/

#ifndef MMSINPUTWIDGETCLASS_H_
#define MMSINPUTWIDGETCLASS_H_

#include "mmsgui/theme/mmstextbaseclass.h"

//! describe attributes for MMSInputWidget which are additional to the MMSWidgetClass
namespace MMSGUI_INPUTWIDGET_ATTR {

    #define MMSGUI_INPUTWIDGET_ATTR_ATTRDESC \
        { "cursor_state", TAFF_ATTRTYPE_STATE }

    #define MMSGUI_INPUTWIDGET_ATTR_IDS \
        MMSGUI_INPUTWIDGET_ATTR_IDS_cursor_state

    #define MMSGUI_INPUTWIDGET_ATTR_INIT { \
        MMSGUI_BASE_ATTR_ATTRDESC, \
        MMSGUI_BORDER_ATTR_ATTRDESC, \
        MMSGUI_WIDGET_ATTR_ATTRDESC, \
        MMSGUI_FONT_ATTR_ATTRDESC, \
        MMSGUI_SHADOW_ATTR_ATTRDESC, \
        MMSGUI_TEXTINFO_ATTR_ATTRDESC, \
        MMSGUI_INPUTWIDGET_ATTR_ATTRDESC, \
        { NULL, TAFF_ATTRTYPE_NONE } \
    }

    typedef enum {
        MMSGUI_BASE_ATTR_IDS,
        MMSGUI_BORDER_ATTR_IDS,
        MMSGUI_WIDGET_ATTR_IDS,
        MMSGUI_FONT_ATTR_IDS,
        MMSGUI_SHADOW_ATTR_IDS,
        MMSGUI_TEXTINFO_ATTR_IDS,
        MMSGUI_INPUTWIDGET_ATTR_IDS
    } ids;
}

extern TAFF_ATTRDESC MMSGUI_INPUTWIDGET_ATTR_I[];


//! A data access class for the input widget.
/*!
This class is the base for the MMSInputWidget class and is derived from
MMSTextBaseClass which is the base for all widgets with text output.
With this data store you have access to all changeable widget attributes.
It is also one of the base classes for MMSThemeManager and MMSDialogManager
which are main features of the MMSGUI.
\note This class will be internally used by class MMSInputWidget.
\author Jens Schneider
*/
class MMSInputWidgetClass : public MMSTextBaseClass {
    private:
        //! name of the theme class
        string          className;

        //! is cursor state set?
        bool            iscursor_state;

        //! requested cursor state
        MMSSTATE        cursor_state;

        //! Read and set all attributes from the given TAFF buffer.
        /*!
        \param tafff        pointer to the TAFF buffer
        \param prefix       optional, prefix to all attribute names (<prefix><attrname>=<attrvalue>)
        \param path         optional, path needed for empty path values from the TAFF buffer
        \param reset_paths  optional, should reset all path attributes?
        */
        void setAttributesFromTAFF(MMSTaffFile *tafff, string *prefix = NULL, string *path = NULL,
                                   bool reset_paths = false);

    public:
        //! stores base widget attributes
        MMSWidgetClass widgetClass;

        //! Constructor of class MMSInputWidgetClass.
        MMSInputWidgetClass();

        //! Destructor of class MMSInputWidgetClass.
        virtual ~MMSInputWidgetClass();

        //! Mark all attributes as not set.
        void unsetAll();

        //! Set the name of the theme class.
        /*!
        \param classname  name of the class
        */
        void setClassName(string className);

        //! Get the name of the theme class.
        /*!
        \return name of the class
        */
        string getClassName();

        //! Check if the cursor state is set.
        bool isCursorState();

        //! Set the cursor state.
        /*!
        \param cursor_state state: true, false, auto
        */
        void setCursorState(MMSSTATE cursor_state);

        //! Mark the cursor state as not set.
        void unsetCursorState();

        //! Get the current cursor state.
        /*!
        \return cursor state
        */
        MMSSTATE getCursorState();

    // friends
    friend class MMSThemeManager;
    friend class MMSDialogManager;
};

#endif /*MMSINPUTWIDGETCLASS_H_*/

---