PWidget.h

Go to the documentation of this file.

//* -*- mode:C++; tab-width:4; c-basic-offset:4; indent-tabs-mode:nil -*- */
//    Name:       src/objects/PWidget.h
//    Purpose:    Contains the Definition of the basic gui widget
//    Author:     Shane T. Mueller, Ph.D.
//    Copyright:  (c) 2003-2026 Shane T. Mueller <smueller@obereed.net>
//    License:    GPL 2
//
//
//
//     This file is part of the PEBL project.
//
//    PEBL is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    PEBL 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 General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with PEBL; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#ifndef __PWIDGET_H__
#define __PWIDGET_H__
 
#include "../base/PEBLObject.h"
#include "PColor.h"
#include "../utility/Defs.h"
 
#include <list>
#include <iostream>
 
 
 
class PWidget: virtual public PEBLObjectBase
{
public:
 
    PWidget();
    PWidget(const PWidget & pw);
    PWidget(pInt x, pInt y, pInt width, pInt height, bool visible);
    virtual ~PWidget();
 
 
   //overloaded generic PEBLObjectBase methods
    virtual bool SetProperty(std::string, Variant v);
    virtual Variant GetProperty(std::string)const;
    virtual ObjectValidationError ValidateProperty(std::string, Variant v)const;
    virtual ObjectValidationError ValidateProperty(std::string)const;
 
    virtual bool RotoZoom(pDouble angle, pDouble zoomx, pDouble zoomy, pInt smooth);
    virtual bool SetPoint(pInt x, pInt y, PColor col);
    virtual PColor GetPixel(pInt x, pInt y);
    virtual void SetParent(PWidget * widget);
    virtual PWidget*  GetParent(){return mParent;}
    virtual bool IsParent(PWidget* parent);
 
    virtual bool Draw(){return false;}
 
    virtual void SetPosition(pInt x, pInt y);
 
    virtual void SetZoomX(pDouble x);
    virtual void SetZoomY(pDouble x);
    virtual void SetRotation(pDouble x);
 
    virtual void SetWidth(pInt w);
    virtual void SetHeight(pInt h);
 
 
    virtual pInt GetX()const {return mX;};
    virtual pInt GetY()const {return mY;};
 
    virtual pInt GetWidth()const {return mWidth;};
    virtual pInt GetHeight()const {return mHeight;};
 
 
 
 
    virtual void SetBackgroundColor(const PColor &color);
    virtual PColor  GetBackgroundColor(){return mBackgroundColor;};
 
    virtual bool AddSubWidget(PWidget * widget);
 
    virtual bool RemoveSubWidget(PWidget * widget);
 
    virtual bool RemoveSubWidgets();
 
 
    virtual bool RemoveLastSubWidget();
 
    virtual void Show();
    virtual void Hide();
    virtual bool IsVisible()const {return mIsVisible;}
 
    virtual std::string ObjectName() const{return "PWidget";};
 
protected:
 
    virtual std::ostream & SendToStream(std::ostream& out) const;
 
 
    pInt mX, mY;
 
    //These are the actual locations of the points to be drawn.  They differ
    //from mX and mY in labels and images, which are drawn on their center point.
    pInt mDrawX;
    pInt mDrawY;
 
    //image file before or after zooming.
    pInt mWidth, mHeight;
 
    //These are properties for rotation/zoom
    pDouble mZoomX;
    pDouble mZoomY;
    pDouble mRotation;
 
    PColor mBackgroundColor;
 
   //A list of sub-widgets.
    std::list<PWidget*> mSubWidgets;
 
    //Whether this should actually get drawn.
    bool mIsVisible;
 
    PWidget * mParent;
private:
 
 
 
};
 
 
#endif