definterface.h File Reference

#include "plugin.h"
#include "events.h"
#include <wx/frame.h>
#include <wx/bitmap.h>
#include <wx/pen.h>
#include <wx/brush.h>

Include dependency graph for definterface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	wxIFMDefaultInterfacePlugin
class	wxIFMDefaultContainerPlugin
struct	wxIFMTabConfig
struct	wxIFMCaptionConfig
class	wxIFMDefaultPanelPlugin
class	wxIFMComponentButtonManager
	Class for managing small buttons that appear for a component. More...
class	wxIFMComponentButton
class	wxIFMDefaultChildData
class	wxIFMContainerData
class	wxIFMPanelTabData
class	wxIFMTab
class	wxIFMPanelData
class	wxIFMAddTopContainerEvent
class	wxIFMRemoveTopContainerEvent
class	wxIFMSelectTabEvent
class	wxIFMComponentButtonEvent
Defines
#define	IFM_FLOATING_FRAME_STYLE   wxFRAME_NO_TASKBAR | wxFRAME_FLOAT_ON_PARENT | wxRESIZE_BORDER | wxSYSTEM_MENU | wxCLOSE_BOX
#define	IFM_CAPTION_PAD   1
	gap between the caption and the components client area
#define	IFM_COMPONENT_BUTTON_X   10
#define	IFM_COMPONENT_BUTTON_Y   11
#define	IFM_COMPONENT_BUTTON_PAD   2
#define	IFM_COMPONENT_ID_CLOSE   0
#define	IFM_COMPONENT_ID_MAXIMIZE   1
#define	IFM_COMPONENT_ID_MINIMIZE   2
#define	IFM_CONTAINER_GRIPPER_WIDTH   0
#define	IFM_ORIENTATION_DEFAULT   -1
	select orientation automatically
#define	IFM_ORIENTATION_NONE   0
	unitialized (an erronous) orientation
#define	IFM_ORIENTATION_TOP   1
	top container
#define	IFM_ORIENTATION_BOTTOM   2
	bottom container
#define	IFM_ORIENTATION_LEFT   3
	left container
#define	IFM_ORIENTATION_RIGHT   4
	right container
#define	IFM_ORIENTATION_FLOAT   5
	floating
#define	IFM_ORIENTATION_DOCKED   6
	this container is docked inside another container
#define	wxIFMAddTopContainerEventFunctionHandler(func)   (wxObjectEventFunction)wxStaticCastEvent(wxIFMAddTopContainerEventFunction, &func)
#define	wxIFMRemoveTopContainerEventFunctionHandler(func)   (wxObjectEventFunction)wxStaticCastEvent(wxIFMRemoveTopContainerEventFunction, &func)
#define	wxIFMSelectTabEventFunctionHandler(func)   (wxObjectEventFunction)wxStaticCastEvent(wxIFMSelectTabEventFunction, &func)
#define	wxIFMComponentButtonEventFunctionHandler(func)   (wxObjectEventFunction)wxStaticCastEvent(wxIFMComponentButtonEventFunction, &func)
#define	EVT_IFM_ADDTOPCONTAINER(func)   wx__DECLARE_EVT0(wxEVT_IFM_ADDTOPCONTAINER, wxIFMAddTopContainerEventFunctionHandler(func))
#define	EVT_IFM_REMOVETOPCONTAINER(func)   wx__DECLARE_EVT0(wxEVT_IFM_REMOVETOPCONTAINER, wxIFMRemoveTopContainerEventFunctionHandler(func))
#define	EVT_IFM_SELECTTAB(func)   wx__DECLARE_EVT0(wxEVT_IFM_SELECTTAB, wxIFMSelectTabEventFunctionHandler(func))
#define	EVT_IFM_COMPONENTBUTTONCLICK(func)   wx__DECLARE_EVT0(wxEVT_IFM_COMPONENTBUTTONCLICK, wxIFMComponentButtonEventFunctionHandler(func))
Typedefs
typedef void(wxEvtHandler::*	wxIFMAddTopContainerEventFunction )(wxIFMAddTopContainerEvent &)
typedef void(wxEvtHandler::*	wxIFMRemoveTopContainerEventFunction )(wxIFMRemoveTopContainerEvent &)
typedef void(wxEvtHandler::*	wxIFMSelectTabEventFunction )(wxIFMSelectTabEvent &)
typedef void(wxEvtHandler::*	wxIFMComponentButtonEventFunction )(wxIFMComponentButtonEvent &)
Functions
	WX_DECLARE_LIST (wxIFMComponent, wxIFMComponentList)
	WX_DEFINE_ARRAY (wxIFMComponentButton *, wxIFMComponentButtonArray)
	WX_DEFINE_ARRAY (wxIFMTab *, wxIFMTabArray)
	DECLARE_IFM_COMPONENT_TYPE (IFM_COMPONENT_PANEL) DECLARE_EVENT_TYPE(wxEVT_IFM_ADDTOPCONTAINER
	DECLARE_EVENT_TYPE (wxEVT_IFM_REMOVETOPCONTAINER, 0)
	DECLARE_EVENT_TYPE (wxEVT_IFM_SELECTTAB, 0)
	DECLARE_EVENT_TYPE (wxEVT_IFM_COMPONENTBUTTONCLICK, 0)

---

Detailed Description

Prototypes the default interface plugins for IFM

Author:

Robin McNeill

Date:

Created: 11/06/04

Copyright (c) Robin McNeill Licensed under the terms of the wxWindows license

Definition in file definterface.h.

---

Define Documentation

#define EVT_IFM_ADDTOPCONTAINER (  func   )     wx__DECLARE_EVT0(wxEVT_IFM_ADDTOPCONTAINER, wxIFMAddTopContainerEventFunctionHandler(func))

Definition at line 758 of file definterface.h.

#define EVT_IFM_COMPONENTBUTTONCLICK (  func   )     wx__DECLARE_EVT0(wxEVT_IFM_COMPONENTBUTTONCLICK, wxIFMComponentButtonEventFunctionHandler(func))

Definition at line 761 of file definterface.h.

#define EVT_IFM_REMOVETOPCONTAINER (  func   )     wx__DECLARE_EVT0(wxEVT_IFM_REMOVETOPCONTAINER, wxIFMRemoveTopContainerEventFunctionHandler(func))

Definition at line 759 of file definterface.h.

#define EVT_IFM_SELECTTAB (  func   )     wx__DECLARE_EVT0(wxEVT_IFM_SELECTTAB, wxIFMSelectTabEventFunctionHandler(func))

Definition at line 760 of file definterface.h.

#define IFM_CAPTION_PAD   1

gap between the caption and the components client area Definition at line 28 of file definterface.h. Referenced by wxIFMDefaultPanelPlugin::OnCreateComponent(), and wxIFMDefaultPanelPlugin::OnUpdate().

#define IFM_COMPONENT_BUTTON_PAD   2

Definition at line 32 of file definterface.h. Referenced by wxIFMComponentButtonManager::GetRect(), and wxIFMComponentButtonManager::Layout().

#define IFM_COMPONENT_BUTTON_X   10

Definition at line 30 of file definterface.h. Referenced by wxIFMComponentButtonManager::AddButton(), wxIFMComponentButtonManager::Layout(), and wxIFMComponentButtonManager::SetHeight().

#define IFM_COMPONENT_BUTTON_Y   11

Definition at line 31 of file definterface.h. Referenced by wxIFMComponentButtonManager::AddButton(), wxIFMDefaultPanelPlugin::OnCreateComponent(), and wxIFMComponentButtonManager::SetHeight().

#define IFM_COMPONENT_ID_CLOSE   0

Todo: provide an auto generating facility for these id's Definition at line 35 of file definterface.h. Referenced by wxIFMDefaultPanelPlugin::OnComponentButtonClick(), wxIFMDefaultContainerPlugin::OnComponentButtonClick(), wxIFMDefaultPanelPlugin::OnCreateComponent(), wxIFMDefaultContainerPlugin::OnCreateComponent(), and wxIFMDefaultContainerPlugin::OnUpdate().

#define IFM_COMPONENT_ID_MAXIMIZE   1

Definition at line 36 of file definterface.h. Referenced by wxIFMDefaultPanelPlugin::OnComponentButtonClick().

#define IFM_COMPONENT_ID_MINIMIZE   2

Definition at line 37 of file definterface.h. Referenced by wxIFMDefaultPanelPlugin::OnComponentButtonClick().

#define IFM_CONTAINER_GRIPPER_WIDTH   0

Definition at line 39 of file definterface.h. Referenced by wxIFMDefaultContainerPlugin::OnCreateComponent().

#define IFM_FLOATING_FRAME_STYLE   wxFRAME_NO_TASKBAR | wxFRAME_FLOAT_ON_PARENT | wxRESIZE_BORDER | wxSYSTEM_MENU | wxCLOSE_BOX

Definition at line 26 of file definterface.h.

#define IFM_ORIENTATION_BOTTOM   2

bottom container Definition at line 70 of file definterface.h. Referenced by wxIFMDefaultInterfacePlugin::OnAddChild(), wxIFMDefaultResizePlugin::OnConvertRect(), wxIFMDefaultDockingPlugin::OnDragEnd(), wxIFMDefaultInterfacePlugin::OnGetContentRect(), wxIFMDefaultResizePlugin::OnPaintDecor(), wxIFMDefaultResizePlugin::OnResizeBegin(), wxIFMDefaultResizePlugin::OnResizeEnd(), wxIFMDefaultResizePlugin::OnSetCursor(), wxIFMDefaultResizePlugin::OnSetRect(), wxIFMDefaultInterfacePlugin::OnUpdate(), wxIFMDefaultResizePlugin::UpdateContainerResizeSashes(), and wxIFMDefaultResizePlugin::UpdateResizeSashes().

#define IFM_ORIENTATION_DEFAULT   -1

select orientation automatically Definition at line 67 of file definterface.h. Referenced by wxIFMDefaultInterfacePlugin::OnAddChild().

#define IFM_ORIENTATION_DOCKED   6

this container is docked inside another container Definition at line 74 of file definterface.h. Referenced by wxIFMDefaultContainerPlugin::OnDock(), and wxIFMDefaultInterfacePlugin::OnGetContentRect().

#define IFM_ORIENTATION_FLOAT   5

floating Definition at line 73 of file definterface.h. Referenced by wxIFMDefaultInterfacePlugin::OnAddChild().

#define IFM_ORIENTATION_LEFT   3

left container Definition at line 71 of file definterface.h. Referenced by MainFrm::CreateGUIControls(), wxIFMDefaultInterfacePlugin::OnAddChild(), wxIFMDefaultResizePlugin::OnConvertRect(), wxIFMDefaultDockingPlugin::OnDragEnd(), wxIFMDefaultInterfacePlugin::OnGetContentRect(), wxIFMDefaultResizePlugin::OnPaintDecor(), wxIFMDefaultResizePlugin::OnResizeBegin(), wxIFMDefaultResizePlugin::OnResizeEnd(), wxIFMDefaultResizePlugin::OnSetCursor(), wxIFMDefaultResizePlugin::OnSetRect(), wxIFMDefaultInterfacePlugin::OnUpdate(), and wxIFMDefaultResizePlugin::UpdateContainerResizeSashes().

#define IFM_ORIENTATION_NONE   0

unitialized (an erronous) orientation Definition at line 68 of file definterface.h. Referenced by wxIFMDefaultInterfacePlugin::OnRemoveTopContainer().

#define IFM_ORIENTATION_RIGHT   4

right container Definition at line 72 of file definterface.h. Referenced by wxIFMDefaultInterfacePlugin::OnAddChild(), wxIFMDefaultResizePlugin::OnConvertRect(), wxIFMDefaultDockingPlugin::OnDragEnd(), wxIFMDefaultInterfacePlugin::OnGetContentRect(), wxIFMDefaultResizePlugin::OnPaintDecor(), wxIFMDefaultResizePlugin::OnResizeBegin(), wxIFMDefaultResizePlugin::OnResizeEnd(), wxIFMDefaultResizePlugin::OnSetCursor(), wxIFMDefaultResizePlugin::OnSetRect(), wxIFMDefaultInterfacePlugin::OnUpdate(), wxIFMDefaultResizePlugin::UpdateContainerResizeSashes(), and wxIFMDefaultResizePlugin::UpdateResizeSashes().

#define IFM_ORIENTATION_TOP   1

top container Definition at line 69 of file definterface.h. Referenced by MainFrm::CreateGUIControls(), wxIFMDefaultInterfacePlugin::OnAddChild(), wxIFMDefaultResizePlugin::OnConvertRect(), wxIFMDefaultDockingPlugin::OnDragEnd(), wxIFMDefaultInterfacePlugin::OnGetContentRect(), wxIFMDefaultResizePlugin::OnPaintDecor(), wxIFMDefaultResizePlugin::OnResizeBegin(), wxIFMDefaultResizePlugin::OnResizeEnd(), wxIFMDefaultResizePlugin::OnSetCursor(), wxIFMDefaultResizePlugin::OnSetRect(), wxIFMDefaultInterfacePlugin::OnUpdate(), and wxIFMDefaultResizePlugin::UpdateContainerResizeSashes().

#define wxIFMAddTopContainerEventFunctionHandler (  func   )     (wxObjectEventFunction)wxStaticCastEvent(wxIFMAddTopContainerEventFunction, &func)

Definition at line 749 of file definterface.h.

#define wxIFMComponentButtonEventFunctionHandler (  func   )     (wxObjectEventFunction)wxStaticCastEvent(wxIFMComponentButtonEventFunction, &func)

Definition at line 755 of file definterface.h.

#define wxIFMRemoveTopContainerEventFunctionHandler (  func   )     (wxObjectEventFunction)wxStaticCastEvent(wxIFMRemoveTopContainerEventFunction, &func)

Definition at line 751 of file definterface.h.

#define wxIFMSelectTabEventFunctionHandler (  func   )     (wxObjectEventFunction)wxStaticCastEvent(wxIFMSelectTabEventFunction, &func)

Definition at line 753 of file definterface.h.

---

Typedef Documentation

typedef void(wxEvtHandler::* wxIFMAddTopContainerEventFunction)(wxIFMAddTopContainerEvent &)

Definition at line 744 of file definterface.h.

typedef void(wxEvtHandler::* wxIFMComponentButtonEventFunction)(wxIFMComponentButtonEvent &)

Definition at line 747 of file definterface.h.

typedef void(wxEvtHandler::* wxIFMRemoveTopContainerEventFunction)(wxIFMRemoveTopContainerEvent &)

Definition at line 745 of file definterface.h.

typedef void(wxEvtHandler::* wxIFMSelectTabEventFunction)(wxIFMSelectTabEvent &)

Definition at line 746 of file definterface.h.

---

Function Documentation

DECLARE_EVENT_TYPE (  wxEVT_IFM_COMPONENTBUTTONCLICK  , 0  )

DECLARE_EVENT_TYPE (  wxEVT_IFM_SELECTTAB  , 0  )

DECLARE_EVENT_TYPE (  wxEVT_IFM_REMOVETOPCONTAINER  , 0  )

DECLARE_IFM_COMPONENT_TYPE (  IFM_COMPONENT_PANEL   )

WX_DECLARE_LIST (  wxIFMComponent  , wxIFMComponentList  )

WX_DEFINE_ARRAY (  wxIFMTab *  , wxIFMTabArray  )

WX_DEFINE_ARRAY (  wxIFMComponentButton *  , wxIFMComponentButtonArray  )