vos/gui/gui/container.cc

Go to the documentation of this file.

/* $Id: container.cc,v 1.20 2003/08/05 14:23:15 reed Exp $ */


/*

    Copyright (C) 2002 Reed Hedges

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    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., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/


/** @file container.cc Code: a MetaObject for Container object types. */

#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>
#include "container.hh"

using namespace VOSGUI;

/* Constructor */
Container::Container(MetaObject* s) : Widget(s), MetaObject(s) {
}

Container::~Container() {
}



LocalContainer::LocalContainer(MetaObject* s) : Container(s), LocalWidget(s), Widget(s), MetaObject(s) {
    //addMessageHandler<LocalContainer>("gui:container-hidden", this, &LocalContainer::handleHidden);
    addMessageHandler<LocalContainer>("gui:start-listening", this, &LocalContainer::handleStartListening);
}





/* Return type string ("gui:container") */

const string Container::getType() {
    return string("gui:widget.container");
}

/* Register extenders with libvos MetaFactory */
void Container::registerExtenders() {
    LocalSite::addLocalObjectExtension(typeid(LocalContainer).name(), &LocalContainer::new_LocalContainer);
    LocalSite::addLocalObjectExtension(typeid(Container).name(), &LocalContainer::new_LocalContainer);
    LocalSite::addLocalObjectExtension("gui:widget.container", &LocalContainer::new_LocalContainer);
    RemoteSite::addRemoteObjectExtension(typeid(RemoteContainer).name(), &RemoteContainer::new_RemoteContainer);
    RemoteSite::addRemoteObjectExtension(typeid(Container).name(), &RemoteContainer::new_RemoteContainer);
    RemoteSite::addRemoteObjectExtension("gui:widget.container", &RemoteContainer::new_RemoteContainer);

    // these names are deprecated
    LocalSite::addLocalObjectExtension("gui:container", &LocalContainer::new_LocalContainer);
    RemoteSite::addRemoteObjectExtension("gui:container", &RemoteContainer::new_RemoteContainer);
}



/* Get and set Subproperties and other Subobjects */

string Container::getLayout() {
    return Property::getProperty(*this, "gui:layout", "vertical");
}

void Container::setLayout(const string& value, PropertyAccessControl* ac) {
    if(!ac)
        ac = accessControl;
    Property::setProperty(*this, "gui:layout", value, "text/plain", ac);
}

bool Container::getBorder() {
    return Property::getBoolProperty(*this, "gui:border", false);
}

void Container::setBorder(bool value, PropertyAccessControl* ac) {
    if(!ac)
        ac = accessControl;
    Property::setProperty(*this, "gui:border", value?"yes":"no", "text/x-yes-no", ac);
}

bool Container::getCompact() {
    return Property::getBoolProperty(*this, "gui:compact", false);
}

void Container::setCompact(bool val, PropertyAccessControl* ac) {
    if(!ac) ac = accessControl;
    Property::setBoolProperty(*this, "gui:compact", val, ac);
}

void Container::setCompactObject(Property* obj) {
    assert(obj);
    try {
        vRef<ParentChildRelation> pcr = findChild("gui:compact");
        setChild(pcr->position, "gui:compact", obj);
    } catch (NoSuchObjectError) {
        insertChild(-1, "gui:compact", obj);
    }
}

Property* Container::getCompactObject() {
    Property* p = meta_cast<Property*>(&findObject("gui:target"));
    if(!p) throw bad_cast();
    return p;
}



void LocalContainer::raise() {
    LOG("VOSGUI::LocalContainer", 2, "Sending raise message");
    vRef<Message> m = new Message();
    m->setType("update");
    m->setFrom(getURL().getString());
    m->setSourceSite(&getSite());
    m->setMethod("gui:raise-container");
    for(vector<Vobject*>::const_iterator i = remoteWindows.begin();
            i != remoteWindows.end(); i++) 
    {
        m->setTo( (*i)->getURL().getString() );
        (*i)->getSite().sendMessage(&m);
    }
}

#if 0
void LocalContainer::hide() {
    LOG("VOSGUI::LocalContainer", 2, "Sending hide messages");
    vRef<Message> m = new Message();
    m->setType("update");
    m->setFrom(getURL().getString());
    m->setSourceSite(&getSite());
    m->setMethod("gui:hide-container");
    for(vector<Vobject*>::const_iterator i = remoteWindows.begin();
            i != remoteWindows.end(); i++) 
    {
        m->setTo( (*i)->getURL().getString() );
        (*i)->getSite().sendMessage(&m);
    }
}
#endif

void LocalContainer::handleStartListening(Message* m) {
    // TODO: could check that the "listen" field is "raise"...
    try {
        remoteWindows.push_back(&(Vobject::findObjectFromRoot(m->getFrom())));
    } catch(exception& e) {
        LOG("VOSGUI::LocalContainer", 0, "Error handling \"start-listening\" message: " << e.what());
    }
}

RemoteContainer::RemoteContainer(MetaObject* s) : Container(s), RemoteWidget(s), Widget(s), MetaObject(s) {
    LOG("Remotecontainer", 0, "registering raise handler");
    addUpdateHandler<RemoteContainer>("gui:raise-container", this, &RemoteContainer::handleRaise); 

    LOG("VOSGUI::RemoteContainer", 2, "Sending start-listening message");
    vRef<Message> m = new Message();
    vRef<LocalSite> ls = RemoteVobject::initFields(this, &m, "gui:start-listening", true);
    m->insertField(-1, "listen", "raise");
    sendMessage(&m);
}
    

#if 0
void RemoteContainer::hidden() {
    LOG("VOSGUI::RemoteContainer", 2, "Sending hidden message");
    vRef<Message> m = new Message();
    vRef<LocalSite> ls = RemoteVobject::initFields(this, &m, "gui:container-hidden", true);
    sendMessage(&m);
}

void LocalContainer::handleHidden(Message* m) {
    hidden();
}

void LocalContainer::hidden() { 
    // override me
}

#endif 

void RemoteContainer::raise() { 
    LOG("VOSGUI::RemoteContainer", 0, "INTERNAL ERROR: raise() in base class called.");
}

//void RemoteContainer::hide() { 
//    LOG("VOSGUI::RemoteContainer", 0, "INTERNAL ERROR: hide() in base class called.");
//}

void RemoteContainer::handleRaise(Message* m) {
    LOG("VOSGUI::RemoteContainer", 2, "Recieved raise message...");
    raise();
}


//void RemoteContainer::handleHide(Message* m) {
//    LOG("VOSGUI::RemoteContainer", 2, "Recieved hide message...");
//    hide();
//}


/* Generators for factory */


MetaObject* LocalContainer::new_LocalContainer(MetaObject *s, const string& type) {
    return new LocalContainer(s);
}

MetaObject* RemoteContainer::new_RemoteContainer(MetaObject *s, const string& type) {
    return new RemoteContainer(s);
}

---