mmsdialogmanager.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 MMSDIALOGMANAGER_H_
#define MMSDIALOGMANAGER_H_

#include "mmsgui/mmswindow.h"
#include "mmsgui/mmschildwindow.h"
#include "mmsgui/mmsmenuwidget.h"
#include "mmsgui/mmscanvaswidget.h"

// support old renamed methods
#define searchForWidget findWidget



//! With this class you can load dialog files written in disko's XML syntax.
/*!
It is recommended to use XML files to describe the layout of your dialog windows.
So you can change it (design it) without changing your C++ code. With the
dialog manager you also minimize the lines of your C++ code.
\author Jens Schneider
*/
class MMSDialogManager {
    private:
        //! if leave_window, then you can use a single MMSDialogManager instance to load
        //! more than one dialog window with the loadDialog() method
        bool                    leave_window;

        //! pointer to the instantiated window
        MMSWindow               *rootWindow;

        //! is window instantiated by me?
        bool                    rootWindow_is_mine;

        //! loaded child windows
        vector<MMSChildWindow*> childWins;

        //! filename of dialog's XML source
        string                  filename;

        //! description of the dialog
        MMSDescriptionClass     description;

        //! list of widgets with a name
        vector<MMSWidget*>      namedWidgets;

        void insertNamedWidget(MMSWidget *widget);

        void throughDoc(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow,
                        MMSTheme *theme, bool only_first_child = false);

        void getDescriptionValues(MMSTaffFile *tafff, MMSTheme *theme);

        void getMainWindowValues(MMSTaffFile *tafff, MMSTheme *theme);
        void getPopupWindowValues(MMSTaffFile *tafff, MMSTheme *theme);
        void getRootWindowValues(MMSTaffFile *tafff, MMSTheme *theme);
        void getChildWindowValues(MMSTaffFile *tafff, MMSWindow *rootWindow, MMSTheme *theme);
        string getTemplateValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getVBoxValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getHBoxValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getLabelValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getButtonValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getCanvasValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getImageValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getProgressBarValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        bool   getMenuItems(MMSTaffFile *tafff, MMSMenuWidget *menu, MMSTheme *theme);
        string getMenuValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getTextBoxValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getArrowValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getSliderValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getInputValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getCheckBoxValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);
        string getGapValues(MMSTaffFile *tafff, MMSWidget *currentWidget, MMSWindow *rootWindow, MMSTheme *theme);

        void updateTAFFAttributes(MMSTaffFile *tafff, MMSWidget *widget, string &widgetName);

    public:
        MMSDialogManager(bool leave_window = false);
        MMSDialogManager(MMSWindow *rootWindow);
        ~MMSDialogManager();
        bool isLoaded();
        MMSWindow* loadDialog(string filename, MMSTheme *theme = NULL);
        MMSChildWindow* loadChildDialog(string filename, MMSTheme *theme = NULL);
        MMSWidget* findWidget(string name);
        MMSWidget* operator[](string name);
        MMSWindow* getWindow();

        MMSDescriptionClass getDescription();

        MMSWidget *createWidgetFromTemplate(string className, MMSWidget *parentWidget, MMSWindow *rootWindow = NULL, MMSTheme *theme = NULL);
        MMSWidget *addWidgetFromTemplate(string className, MMSWidget *parentWidget, MMSWindow *rootWindow = NULL, MMSTheme *theme = NULL);
};

MMS_CREATEERROR(MMSDialogManagerError);

#endif /*MMSDIALOGMANAGER_H_*/

---