Dialog CATDlgToolBar
Usage: you can derive this class.
public class CATDlgToolBar
Base class for dockable frames.
Role:Assign a CATDlgToolBar to a document window.
Constructor and Destructor Index
- o
CATDlgToolBar(CATDialog*,CATString&,CATDlgStyle)
- Constructor.
- o
~CATDlgToolBar()
- Destructor.
Method Index
- o
GetContextualMenu()
- Returns contextual menu associated with the toolbar.
- o
GetDockState()
- Returns whether the toolbar is docked on not.
- o
GetFloatingPosition(int&,int&)
- Gets the position of the toolbar.
- o
GetToolBarMButtonNotification()
- Returns the event notification sent whenever the toolbar buttons are pressed.
- o
GetWindCloseNotification()
- Returns the event notification sent whenever the toolbar is closed.
- o
GetWindDockNotification()
- Returns the event notification sent whenever the toolbar is docked.
- o
SetDockState(CATULong)
- Dock or undock the toolbar.
- o
SetFloatingPosition(int,int)
- Positions the toolbar.
Constructor and Destructor
o CATDlgToolBar
| public CATDlgToolBar( | | iParent, |
| const | iObjectName, |
| | iStyle | =NULL) |
-
Constructor.
- Parameters:
-
- iParent
- The parent widget.
- iObjectName
- The internal name of the toolbar.
- iStyle
- The style of the tab toolbar.
Legal values:
- CATDlgTlbDockOnBottom
- The toolbar is anchored to the bottom of the window.
- CATDlgTlbDockOnLeft
- The toolbar is anchored to the left of the window.
- CATDlgTlbDockOnRight
- The toolbar is anchored to the right of the window.
- CATDlgTlbDockOnTop
- The toolbar is anchored to the top of the window.
- CATDlgTlbUnDock
- The toolbar has its own window.
o ~CATDlgToolBar
| public virtual ~CATDlgToolBar( | ) |
-
Destructor.
Methods
o GetContextualMenu
| public GetContextualMenu( | ) |
-
Returns contextual menu associated with the toolbar.
o GetDockState
-
Returns whether the toolbar is docked on not.
- Returns:
- The style of the tab toolbar.
Legal values:
- CATDlgTlbDockOnBottom
- The toolbar is anchored to the bottom of the window.
- CATDlgTlbDockOnLeft
- The toolbar is anchored to the left of the window.
- CATDlgTlbDockOnRight
- The toolbar is anchored to the right of the window.
- CATDlgTlbDockOnTop
- The toolbar is anchored to the top of the window.
- CATDlgTlbUnDock
- The toolbar has its own window.
o GetFloatingPosition
| public GetFloatingPosition( | | oX, |
| | oY) |
-
Gets the position of the toolbar.
- Parameters:
-
- iX
- the x coordinate of the toolbar.
- iY
- the y coordinate of the toolbar.
o GetToolBarMButtonNotification
| public GetToolBarMButtonNotification( | ) |
-
Returns the event notification sent whenever the toolbar buttons are pressed.
o GetWindCloseNotification
| public GetWindCloseNotification( | ) |
-
Returns the event notification sent whenever the toolbar is closed.
o GetWindDockNotification
| public GetWindDockNotification( | ) |
-
Returns the event notification sent whenever the toolbar is docked.
o SetDockState
| public SetDockState( | | iState) |
-
Dock or undock the toolbar.
- Parameters:
-
- iState
- The style of the tab toolbar.
Legal values:
- CATDlgTlbDockOnBottom
- The toolbar is anchored to the bottom of the window.
- CATDlgTlbDockOnLeft
- The toolbar is anchored to the left of the window.
- CATDlgTlbDockOnRight
- The toolbar is anchored to the right of the window.
- CATDlgTlbDockOnTop
- The toolbar is anchored to the top of the window.
- CATDlgTlbUnDock
- The toolbar has its own window.
o SetFloatingPosition
| public SetFloatingPosition( | | x, |
| | y) |
-
Positions the toolbar.
- Parameters:
-
- iX
- the x coordinate of the toolbar.
- iY
- the y coordinate of the toolbar.
This object is included in the file: CATDlgToolBar.h
If needed, your Imakefile.mk should include the module: DI0PANV2
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.