HOM/HOM_FloatingPanel.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_FloatingPanel_h__
#define __HOM_FloatingPanel_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;

SWIGOUT(%rename(FloatingPanel) HOM_FloatingPanel;)

class HOM_API HOM_FloatingPanel
{
public:
    HOM_FloatingPanel()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_FloatingPanel(const HOM_FloatingPanel &)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_FloatingPanel()
    { 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",
        "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;

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

    virtual void setName(const char *name)
        throw(HOM_OperationFailed, HOM_TypeError, HOM_NotAvailable,
            HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool containsPlaybar()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setContainsPlaybar(bool on)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool containsShelf()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setContainsShelf(bool on)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool containsStatusBar()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setContainsStatusBar(bool on)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool containsMenuBar()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setContainsMenuBar(bool on)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool isAttachedToDesktop()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void attachToDesktop(bool on)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool isFullscreen()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setIsFullscreen(bool on)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

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

#endif

---