HOM/HOM_PathBasedPaneTab.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_PathBasedPaneTab_h__
#define __HOM_PathBasedPaneTab_h__

#include "HOM_PaneTab.h"
class HOM_Node;

SWIGOUT(%rename(PathBasedPaneTab) HOM_PathBasedPaneTab;)

class HOM_API HOM_PathBasedPaneTab : virtual public HOM_PaneTab
{
public:
    HOM_PathBasedPaneTab()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_PathBasedPaneTab(const HOM_PathBasedPaneTab &pane)
    : HOM_PaneTab(pane)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_PathBasedPaneTab()
    { HOM_DESTRUCT_OBJECT(this) }

    // Let swig know we're overriding __repr__ for this class so it doesn't
    // provide its own __repr__.
    SWIGOUT(virtual std::string __repr__()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;)

    // These methods deal with the pane's network, not the current node
    // inside that network.  The path gadget on the pane will display the
    // network's path.
    SWIGOUT(%newobject pwd;)
    virtual HOM_Node *pwd()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setPwd(HOM_Node &node)
        throw(HOM_NotAvailable, HOM_OperationFailed, HOM_ObjectWasDeleted, 
              HOM_Error) = 0;
    virtual void cd(const char *path)
        throw(HOM_NotAvailable, HOM_OperationFailed, HOM_ObjectWasDeleted, 
              HOM_Error) = 0;

    // These methods deal with the current node inside the pane.  For example,
    // the current node inside a network editor pane is the one that appears
    // in an (unpinned) parameter pane.
    virtual HOM_Node *currentNode()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setCurrentNode(HOM_Node &node)
        throw(HOM_NotAvailable, HOM_OperationFailed, HOM_ObjectWasDeleted,
              HOM_Error) = 0;
};

#endif

---