HOM/HOM_Desktop.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_Desktop_h__
#define __HOM_Desktop_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"
#include "HOM_EnumValue.h"
#include <string>
#include <vector>

class HOM_ShelfDock;
class HOM_Pane;
class HOM_PaneTab;
class HOM_FloatingPanel;

SWIGOUT(%rename(Desktop) HOM_Desktop;)

class HOM_API HOM_Desktop
{
public:
    HOM_Desktop()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_Desktop(const HOM_Desktop &)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_Desktop()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual std::string __repr__()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "panes(self) -> tuple of Panes") panes;)
    virtual std::vector<HOM_ElemPtr<HOM_Pane> > panes()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "paneTabs(self) -> tuple of PaneTabs") paneTabs;)
    virtual std::vector<HOM_ElemPtr<HOM_PaneTab> > paneTabs()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "floatingPaneTabs(self) -> tuple of PaneTabs") floatingPaneTabs;)
    virtual std::vector<HOM_ElemPtr<HOM_PaneTab> > floatingPaneTabs()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "paneTabOfType(self, type, index=0) -> PaneTab or None") 
        paneTabOfType;)
    SWIGOUT(%newobject paneTabOfType;)
    virtual HOM_PaneTab *paneTabOfType(HOM_EnumValue &type, int index=0)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_TypeError, 
              HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "findPaneTab(self, name) -> PaneTab or None") findPaneTab;)
    SWIGOUT(%newobject findPaneTab;)
    virtual HOM_PaneTab *findPaneTab(const char *name)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "createFloatingPaneTab(self, pane_tab_type, position=(), size=())"
        "-> PaneTab") createFloatingPaneTab;)
    SWIGOUT(%newobject createFloatingPaneTab;)
    virtual HOM_PaneTab *createFloatingPaneTab(
            HOM_EnumValue &pane_tab_type,
            const std::vector<int> &position = std::vector<int>(),
            const std::vector<int> &size = std::vector<int>())
        throw(HOM_TypeError, HOM_NotAvailable,
              HOM_ObjectWasDeleted, HOM_Error) = 0;

    // This method is deprecated:
    HOM_PaneTab *createFloatingPane(
            HOM_EnumValue &pane_tab_type,
            const std::vector<int> &position = std::vector<int>(),
            const std::vector<int> &size = std::vector<int>())
    { return createFloatingPaneTab(pane_tab_type, position, size); }

    SWIGPYTHONOUT(%feature("autodoc",
        "floatingPanels(self) -> tuple of FloatingPanels") floatingPanels;)
    virtual std::vector<HOM_ElemPtr<HOM_FloatingPanel> > floatingPanels()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "createFloatingPanel(self, pane_tab_type, position=(), size=()) ->"
        "FloatingPanel") floatingPanels;)
    SWIGOUT(%newobject createFloatingPanel;)
    virtual HOM_FloatingPanel *createFloatingPanel(HOM_EnumValue &pane_tab_type,
                    const std::vector<int> &position = std::vector<int>(),
                    const std::vector<int> &size = std::vector<int>())
        throw(HOM_TypeError, HOM_NotAvailable,
              HOM_ObjectWasDeleted, HOM_Error) = 0;
    
    virtual std::string name()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject shelfDock;)
    virtual HOM_ShelfDock *shelfDock()
        throw(HOM_Error) = 0;

    SWIGOUT(%newobject displaySideHelp;)
    virtual HOM_PaneTab *displaySideHelp(bool show = true)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted,
              HOM_OperationFailed, HOM_Error) = 0;

    virtual void setAsCurrent()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
};

#endif

---