InfoBarOp Class Reference

#include <infobar.h>

Inheritance diagram for InfoBarOp:

List of all members.

Public Member Functions
	InfoBarOp (CDlgResID DialogID=0)
virtual MsgResult	Message (Msg *Msg)
void	Do (OpDescriptor *)
	This function should be over-ridden to perform an operation without passing a parameter.
BOOL	Create ()
	The create method reserves everything needed to guarantee that the dialog will appear. It returns FALSE if it fails. If any dialog merging was specified (by providing a non-zero value for SubDialogID in the call to the DialogOp constructor) then it will be carried out when this function is called.
BOOL	Create (UINT32 DialogID)
void	OnSizeParent (WPARAM, LPARAM lParam)
	Resize the info bar when the parent window moves/resizes, or when one of the children becomes visible/invisible.
void	Toggle ()
	Toggle the Info Bar on or off (i.e. make it invisible or visible).
void	NewCurrentSpread ()
	This function gets called by the LayerManager when the Current Spread is changing.
void	DisableLayerControl ()
	Disables the layer control.
void	EnableLayerControl ()
	Enables the layer control.
Static Public Member Functions
static BOOL	Init ()
	Declares a preference that allows you to clear memory in delete().
static OpState	GetState (String_256 *, OpDescriptor *)
Static Public Attributes
static UINT32	IDD = _R(IDD_INFOBAR)
static const CDlgMode	Mode = MODELESS
static BOOL	Visible = TRUE
Private Member Functions
void	ChangeActiveLayer (WORD LayerIndex)
	Changes the active layer.
Private Attributes
wxPoint	DragPos
BOOL	DraggingBar

---

Detailed Description

Definition at line 106 of file infobar.h.

---

Constructor & Destructor Documentation

InfoBarOp::InfoBarOp (  CDlgResID  DialogID = 0  )

Definition at line 126 of file infobar.cpp. : DialogOp(InfoBarOp::IDD, InfoBarOp::Mode, SubDialogID) { // Not dragging the info bar intially DraggingBar = FALSE; }

---

Member Function Documentation

void InfoBarOp::ChangeActiveLayer (  WORD  NewLayerIndex  )  [private]

Changes the active layer. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 11/1/94 Parameters: NewLayerIndex,:  z-order Index of the new active layer. [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 483 of file infobar.cpp. { ENSURE(FALSE,"This function should not be called"); /* INT32 CurrentIndex = 0; // Traverse the Layer Manager's LyrDetList List* LyrList = &((Document::GetCurrent()->GetLayerMgr()).LyrDetList); ListItem* CurLayerDet = LyrList->GetHead(); ENSURE(CurLayerDet != NULL, "The LyrDetList is empty"); while (CurLayerDet != NULL) { if (CurrentIndex == NewLayerIndex) { // We have found the layer to make active ((LyrDetails*)CurLayerDet)->Status.Flags.Active = TRUE; } else if ( ((LyrDetails*)CurLayerDet)->Status.Flags.Active ) { // We have found the old active layer ((LyrDetails*)CurLayerDet)->Status.Flags.Active = FALSE; } CurLayerDet = LyrList->GetNext(CurLayerDet); // Get next layer detail record CurrentIndex ++; } // Commit the changes (Document::GetCurrent()->GetLayerMgr()).CommitLayerChanges(); */ }

BOOL InfoBarOp::Create (  UINT32  DialogID  )

BOOL InfoBarOp::Create (  void   )  [virtual]

The create method reserves everything needed to guarantee that the dialog will appear. It returns FALSE if it fails. If any dialog merging was specified (by providing a non-zero value for SubDialogID in the call to the DialogOp constructor) then it will be carried out when this function is called. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if all resources to create the dialog can be successfully allocated. FALSE otherwise Errors: If the resources cannot be allocated then ERRORIF is called with a Dialog creation failed error message. See also: - Reimplemented from DialogOp. Definition at line 241 of file infobar.cpp. { return DialogOp::Create(); }

void InfoBarOp::DisableLayerControl (   )

Disables the layer control. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 17/1/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 441 of file infobar.cpp. { EnableGadget(_R(IDC_LAYER_COMBO), FALSE ); EnableGadget(_R(IDC_INVOKE_LYR_DLG), FALSE); }

void InfoBarOp::Do (  OpDescriptor *   )  [virtual]

This function should be over-ridden to perform an operation without passing a parameter. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 9/6/94 Parameters: OpDesc,:  A pointer to the OpDescriptor which invoked the operation [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: Operation::DoWithParam Reimplemented from Operation. Definition at line 248 of file infobar.cpp. { // Just to make sure info bar is not opened until it is positioned correctly (by // InfoBarOp::OnSizeParent()). Close(); }

void InfoBarOp::EnableLayerControl (   )

Enables the layer control. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 17/1/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 462 of file infobar.cpp. { EnableGadget(_R(IDC_LAYER_COMBO), TRUE ); EnableGadget(_R(IDC_INVOKE_LYR_DLG), TRUE ); }

OpState InfoBarOp::GetState (  String_256 *  , OpDescriptor *  )  [static]

Definition at line 211 of file infobar.cpp. { OpState OpSt; return(OpSt); }

BOOL InfoBarOp::Init (  void   )  [static]

Declares a preference that allows you to clear memory in delete(). Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 19/4/94 Returns: TRUE if it worked OK, FALSE if not Reimplemented from SimpleCCObject. Definition at line 219 of file infobar.cpp. { // Create the OpDescriptor for this operation class. if (!(RegisterOpDescriptor( 0, _R(IDT_VIEWINFOBAR), CC_RUNTIME_CLASS(InfoBarOp), OPTOKEN_INFOBAR, InfoBarOp::GetState, 0, /* help ID */ _R(IDBBL_INFOBAROP), 0 /* bitmap ID */))) { return FALSE; } // Declare info bar preference. return Camelot.DeclareSection("Windows", 5) && Camelot.DeclarePref("Windows", "InfoBarIsVisible", &Visible); }

MsgResult InfoBarOp::Message (  Msg *  Message  )  [virtual]

if (IS_OUR_DIALOG_MSG(Message)) { DialogMsg* Msg = (DialogMsg*)Message; Handle Msg here } Pass message on to base class for rest of handling. return <BaseClass>Message(Message); This Pure virtual function will ENSURE Returns: Errors: - See also: MessageHandler IS_OUR_DIALOG_MSG Reimplemented from DialogOp. Definition at line 135 of file infobar.cpp. { /* if (Document::GetCurrent() == NULL) // No document - can't do anything return; // Process static Infobar control messages if ((Gadget == _R(IDC_INVOKE_LYR_DLG)) && (DlgMsg == DIM_LFT_BN_CLICKED)) { // Obtain a pointer to the op descriptor for the Layer dialog operation OpDescriptor* OpDesc = OpDescriptor::FindOpDescriptor(CC_RUNTIME_CLASS(LayerDlg)); // Invoke the operation. OpDesc->Invoke(); } // Process active layer selection if ((Gadget == _R(IDC_LAYER_COMBO)) && (DlgMsg == DIM_SELECTION_CHANGED)) { // Obtain the index of the selected item WORD Index; GetValueIndex(_R(IDC_LAYER_COMBO), &Index); ChangeActiveLayer(Index); } if (Gadget >= _R(ID_FIRST_TOOL_CTRL)) { // Gadgets with IDs of 1000 or greater belong to the tool, not the Info bar, so // pass the message on to the tool. Tool *pTool = Tool::GetCurrent(); ENSURE(pTool != NULL, "InfoBarOp::HandleMessage - no Tool is selected!"); if (pTool != NULL) pTool->HandleInfoBarMessage(DlgMsg, Gadget); } else { #if 0 // Handle the dragging of the info bar switch (DlgMsg) { case DIM_RGT_BN_DOWN: case DIM_LFT_BN_DOWN: GetCursorPos(&DragPos); SetCapture(WindowID); DraggingBar = TRUE; break; case DIM_MOUSE_DRAG: if (!DraggingBar) { GetCursorPos(&DragPos); SetCapture(WindowID); DraggingBar = TRUE; return; } POINT CurrPoint; GetCursorPos(&CurrPoint); ScrollWindow(WindowID, CurrPoint.x - DragPos.x, 0, NULL, NULL); DragPos = CurrPoint; break; case DIM_RGT_BN_UP: case DIM_LFT_BN_UP: ReleaseCapture(); DraggingBar = FALSE; break; } #endif } */ return OK; }

void InfoBarOp::NewCurrentSpread (   )

This function gets called by the LayerManager when the Current Spread is changing. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 10/1/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 377 of file infobar.cpp. { ENSURE(FALSE,"This function should not be called"); /* GadgetRedraw(_R(IDC_LAYER_COMBO),FALSE); // Turn off drawing until we have finished making changes // to the gadget. // Delete any existing list items INT32 Count; GetValueCount(_R(IDC_LAYER_COMBO),&Count); while (Count != 0) { DeleteValue(_R(IDC_LAYER_COMBO), FALSE, Count-1); Count--; } WORD SelItemIndex = 0; // The list index of the selected item (i.e. the active layer) WORD i = 0; BOOL FoundActiveLayer = FALSE; // Traverse the Layer Manager's LyrDetList and add all layer identifiers to the list gadget List* LyrList = &((Document::GetCurrent()->GetLayerMgr()).LyrDetList); ListItem* CurLayerDet = LyrList->GetHead(); ENSURE(CurLayerDet != NULL, "The LyrDetList is empty"); while (CurLayerDet != NULL) { // Is the current layer the active layer ? if ( ((LyrDetails*)CurLayerDet)->Status.Flags.Active ) { // Ensure that there is only one active layer ENSURE (!FoundActiveLayer, "More than one active layer found"); FoundActiveLayer = TRUE; SelItemIndex = i; } // Add string to end of list box SetStringGadgetValue(_R(IDC_LAYER_COMBO),&(((LyrDetails*)CurLayerDet)->Status.StringLayerID)); CurLayerDet = LyrList->GetNext(CurLayerDet); i++; } ENSURE(FoundActiveLayer,"No active layer was found"); GadgetRedraw(_R(IDC_LAYER_COMBO),TRUE); // Turn drawing back on SetSelectedValueIndex(_R(IDC_LAYER_COMBO), SelItemIndex); // Select the active layer */ }

void InfoBarOp::OnSizeParent (  WPARAM  , LPARAM  lParam )

Resize the info bar when the parent window moves/resizes, or when one of the children becomes visible/invisible. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 9/11/93 Parameters: WPARAM  - ignored. [INPUTS] lParam - the special MFC structure that is sent when a parent tells its child windows to resize themselves. lParam  - the structure is updated to reflect how much client area was [OUTPUTS] taken by the Info Bar. The WM_SIZEPARENT message is sent, which is a special AFX message (from the WM_USER address space I think). The child windows then adjust the structure passed to them to steal part of the workspace for themselves, and whatever is left over is used for the client area. This is all undocumented and was deduced by looking at the MFC files WINCORE.CPP, WINFRM.CPP, BARCORE.CPP, and BARDLG.CPP. Definition at line 279 of file infobar.cpp. { AFX_SIZEPARENTPARAMS FAR* lpLayout = (AFX_SIZEPARENTPARAMS FAR*)lParam; if (Visible) { // Make the window zero size to avoid redraws //MoveWindow(WindowID, 0, 0, 0, 0, FALSE); // Info Bar is visible - reposition it wrt parent window. CRect rect; rect.CopyRect(&lpLayout->rect); CSize sizeAvail = rect.Size(); // maximum size available CSize size; // maximum requested size size.cx = min(32767, sizeAvail.cx); size.cy = min(28, sizeAvail.cy); // top align (stretch width) size.cx = sizeAvail.cx; lpLayout->rect.top += size.cy; rect.right = rect.left + size.cx; rect.bottom = rect.top + size.cy; #if _MFC_VER < 0x300 _AfxRepositionWindow(lpLayout, WindowID, &rect); // If the window hasn't actually been opened yet, then open it. // This deferral is necessary otherwise the window is opened before being // correctly positioned, and a portion of the document view is invalidated // and redrawn, which we definitely don't want. #if 1 if (!IsWindowVisible(WindowID)) { lpLayout->hDWP = ::DeferWindowPos(lpLayout->hDWP, WindowID, NULL, 0, 0, 0, 0, SWP_NOACTIVATE|SWP_NOZORDER|SWP_NOMOVE|SWP_NOSIZE| SWP_SHOWWINDOW); } #endif #else lpLayout->hDWP = ::DeferWindowPos(lpLayout->hDWP, WindowID, NULL, rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top, SWP_NOACTIVATE|SWP_NOZORDER|SWP_SHOWWINDOW); #endif } }

void InfoBarOp::Toggle (   )

Toggle the Info Bar on or off (i.e. make it invisible or visible). Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 9/11/93 Definition at line 341 of file infobar.cpp. { // Work out whether to open or close the info bar, and do so. // (Also update preference variable) if (IsOpen()) { Close(); Visible = FALSE; } else { Open(); Visible = TRUE; } // Find the main frame, and force the child windows to be repositioned/redrawn. CMainFrame *pFrame = (CMainFrame *) AfxGetApp()->m_pMainWnd; pFrame->RecalcLayout(); }

---

Member Data Documentation

BOOL InfoBarOp::DraggingBar [private]

Definition at line 142 of file infobar.h.

wxPoint InfoBarOp::DragPos [private]

Definition at line 141 of file infobar.h.

UINT32 InfoBarOp::IDD = _R(IDD_INFOBAR) [static]

Definition at line 121 of file infobar.h.

const CDlgMode InfoBarOp::Mode = MODELESS [static]

Definition at line 122 of file infobar.h.

BOOL InfoBarOp::Visible = TRUE [static]

Definition at line 138 of file infobar.h.

---

The documentation for this class was generated from the following files:

• Kernel/infobar.h (r1785/r1282)
• Kernel/infobar.cpp (r1785/r1282)

---