HDK: HOM/HOM_Pane.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_Pane_h__
00017 #define __HOM_Pane_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 #include "HOM_PaneTab.h"
00025 class HOM_Desktop;
00026 class HOM_FloatingPanel;
00027 
00028 SWIGOUT(%rename(Pane) HOM_Pane;)
00029 
00030 class HOM_API HOM_Pane
00031 {
00032 public:
00033     HOM_Pane()
00034     { HOM_CONSTRUCT_OBJECT(this) }
00035     HOM_Pane(const HOM_Pane &)
00036     { HOM_CONSTRUCT_OBJECT(this) }
00037     virtual ~HOM_Pane()
00038     { HOM_DESTRUCT_OBJECT(this) }
00039 
00040     virtual std::string __repr__()
00041         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00042 
00043     SWIGOUT(%newobject desktop;)
00044     virtual HOM_Desktop *desktop()
00045         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00046 
00047     virtual int id()
00048         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00049 
00050     SWIGOUT(%newobject floatingPanel;)
00051     virtual HOM_FloatingPanel *floatingPanel()
00052         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00053 
00054     SWIGPYTHONOUT(%feature("autodoc",
00055         "tabs(self) -> tuple of PaneTabs") tabs;)
00056     virtual std::vector<HOM_ElemPtr<HOM_PaneTab> > tabs()
00057         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00058 
00059     SWIGPYTHONOUT(%newobject createTab;)
00060     virtual HOM_PaneTab *createTab(HOM_EnumValue &type)
00061         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00062 
00063     SWIGOUT(%newobject currentTab;)
00064     virtual HOM_PaneTab *currentTab()
00065         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00066 
00067     SWIGPYTHONOUT(%feature("autodoc",
00068         "tabOfType(self, type, index=0) -> PaneTab or None") tabOfType;)
00069     SWIGOUT(%newobject tabOfType;)
00070     virtual HOM_PaneTab *tabOfType(HOM_EnumValue &type, int index = 0)
00071         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_TypeError, 
00072               HOM_Error) = 0;
00073 
00074     SWIGOUT(%newobject splitHorizontally;)
00075     virtual HOM_Pane *splitHorizontally()
00076         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00077 
00078     SWIGOUT(%newobject splitVertically;)
00079     virtual HOM_Pane *splitVertically()
00080         throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
00081 };
00082 
00083 #endif