HDK: HOM/HOM_PaneTab.h Source File

00001 /*
00002  * PROPRIETARY INFORMATION.  This software is proprietary to
00003  * Side Effects Software Inc., and is not to be reproduced,
00004  * transmitted, or disclosed in any way without written permission.
00005  *
00006  * Produced by:
00007  *      Side Effects Software Inc
00008  *      123 Front Street West, Suite 1401
00009  *      Toronto, Ontario
00010  *      Canada   M5J 2M2
00011  *      416-504-9876
00012  *
00013  * COMMENTS:
00014  */
00015 
00016 #ifndef __HOM_PaneTab_h__
00017 #define __HOM_PaneTab_h__
00018 
00019 #include "HOM_API.h"
00020 #include "HOM_Defines.h"
00021 #include "HOM_Errors.h"
00022 #include "HOM_Module.h"
00023 #include "HOM_EnumValue.h"
00024 class HOM_Pane;
00025 
00026 SWIGOUT(%rename(PaneTab) HOM_PaneTab;)
00027 
00028 class HOM_API HOM_PaneTab
00029 {
00030 public:
00031     HOM_PaneTab()
00032     { HOM_CONSTRUCT_OBJECT(this) }
00033     HOM_PaneTab(const HOM_PaneTab &)
00034     { HOM_CONSTRUCT_OBJECT(this) }
00035     virtual ~HOM_PaneTab()
00036     { HOM_DESTRUCT_OBJECT(this) }
00037 
00038     virtual std::string __repr__()
00039         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00040 
00041     SWIGOUT(%newobject pane;)
00042     SWIGPYTHONOUT(%feature("autodoc",
00043         "pane(self) -> Pane or None") pane;)
00044     virtual HOM_Pane *pane()
00045         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00046 
00047     virtual std::string name()
00048         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00049     virtual void setName(const char *name)
00050         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00051 
00052     virtual bool isCurrentTab()
00053         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00054     virtual void setIsCurrentTab()
00055         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00056 
00057     virtual bool isFloating()
00058         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00059 
00060     SWIGOUT(%newobject clone;)
00061     virtual HOM_PaneTab *clone()
00062         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00063 
00064     virtual void close()
00065         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00066 
00067     SWIGPYTHONOUT(%feature("autodoc",
00068         "type(self) -> hou.paneTabType enum value") type;)
00069     virtual HOM_EnumValue &type()
00070         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00071     SWIGOUT(%newobject setType;)
00072     virtual HOM_PaneTab *setType(HOM_EnumValue &type)
00073         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_TypeError, 
00074               HOM_Error) = 0;
00075 
00076     virtual HOM_EnumValue &linkGroup()
00077         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00078     virtual void setLinkGroup(HOM_EnumValue &group)
00079         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_TypeError) = 0;
00080     virtual bool isPin()
00081         throw(HOM_NotAvailable, HOM_ObjectWasDeleted) = 0;
00082     virtual void setPin(bool pin)
00083         throw(HOM_NotAvailable, HOM_ObjectWasDeleted) = 0;
00084 };
00085 
00086 #endif