AfrFoundation CATAfrAccessFactory
Usage: you must use this class as is. You should never derive it.
public class CATAfrAccessFactory
Method Index
- o
AccessRelease(CATCmdAccess*)
- Releases an existing Access object.
- o
AddAccessChild(CATCmdContainer*,CATCmdAccess*)
- Adds a child to an access
Use macro defined in CATCreateWorkshop.
- o
AddToolbarView(CATCmdContainer*,int,enum ComponentPosition)
- Adds a view to a CATCmdContainer object
Use macro defined in CATCreateWorkshop.
- o
CATAfrGetActiveSection()
- Get the name of the currently active section (the one displayed by the
ActionBar).
- o
CATAfrGetActiveSections(CATListOfCATString&)
- Get the name of the currently active sections (those displayed by the
ActionBar).
- o
CATAfrSetActiveSection(CATString&)
- Set the given section by its name as active.
- o
NewAccess(CATString,CATString)
- Creates an access.
- o
SetAccessAnchorName(CATCmdAccess*,CATString)
- Defines the anchor name for an access
Use macro defined in CATCreateWorkshop.
- o
SetAccessChild(CATCmdContainer*,CATCmdAccess*)
- Defines the child of an access
Use macro defined in CATCreateWorkshop.
- o
SetAccessCommand(CATCmdStarter*,CATString)
- Defines the access command.
- o
SetAccessNext(CATCmdAccess*,CATCmdAccess*)
- Sets the following access.
- o
SetAccessWeight(CATCmdAccess*,float)
- Set the access weight.
- o
SetAddinMenu(CATCmdContainer*,CATCmdContainer*)
- Sets an addinmenu for the access
Use macro defined in CATCreateWorkshop.
- o
SetRepresentationType(CATCmdAccess*,CATString)
- Sets the representation type for an access.
- o
SetWorkbenchHiddenToolbar(CATCmdWorkbench*,CATString)
- Hides a toolbar while in a workbench.
- o
SetWorkbenchMenu(CATCmdContainer*,CATCmdContainer*)
- Sets a menu for the workbench
Use macro defined in CATCreateWorkshop.
- o
SetWorkbenchToolbarStyle(CATCmdWorkbench*,CATAfrToolbarStyleDef)
- Defines toolbar's style for an access.
- o
SetWorkbenchToolbarsExclusive(CATCmdWorkbench*)
- Sets the toolbars for an access to be exclusive.
- o
SetWorkbenchWithoutToolbar(CATCmdWorkbench*,CATString)
- Removes a toolbar while in a workbench.
- o
SetWorkshopMenu(CATCmdContainer*,CATCmdContainer*)
- Sets a menu for the workshop
Use macro defined in CATCreateWorkshop.
Enumerated Type Index
- o
CATAfrToolbarStyleDef
- Defines the button representation in the toolbars.
- o
ComponentPosition
- Position of the toolbar in the application window.
Methods
o AccessRelease
| public static AccessRelease( | | variableName) |
-
Releases an existing Access object.
Use macro defined in CATCreateWorkshop.h
o AddAccessChild
| public static AddAccessChild( | | variableName, |
| | childName) |
-
Adds a child to an access
Use macro defined in CATCreateWorkshop.h
o AddToolbarView
| public static AddToolbarView( | | variableName, |
| | visibility, |
| | position) |
-
Adds a view to a CATCmdContainer object
Use macro defined in CATCreateWorkshop.h
o CATAfrGetActiveSection
| public static CATAfrGetActiveSection( | ) |
-
Get the name of the currently active section (the one displayed by the
ActionBar).
This function returns the name of the first section found that is active.
To get all the active sections of the ActionBar, prefer using
CATAfrGetActiveSections function.
- Returns:
- the name of the active section.
o CATAfrGetActiveSections
| public static CATAfrGetActiveSections( | | o_activeSections) |
-
Get the name of the currently active sections (those displayed by the
ActionBar).
- Parameters:
-
- o_activeSections
- the names of the active sections.
o CATAfrSetActiveSection
| public static CATAfrSetActiveSection( | const | i_name) |
-
Set the given section by its name as active. The active section is the one
displayed by the ActionBar.
- Parameters:
-
- i_name
- the name of the section to set active. If this name doesn't refer
to a section, nothing happens.
The fixed area can't be set as active as it's always displayed.
o NewAccess
| public static NewAccess( | | className, |
| | objectName) |
-
Creates an access.
Use macro defined in CATCreateWorkshop.h
o SetAccessAnchorName
| public static SetAccessAnchorName( | | variableName, |
| | anchor) |
-
Defines the anchor name for an access
Use macro defined in CATCreateWorkshop.h
o SetAccessChild
| public static SetAccessChild( | | variableName, |
| | childName) |
-
Defines the child of an access
Use macro defined in CATCreateWorkshop.h
o SetAccessCommand
| public static SetAccessCommand( | | variableName, |
| | command) |
-
Defines the access command...
Use macro defined in CATCreateWorkshop.h
o SetAccessNext
| public static SetAccessNext( | | variableName, |
| | nextName) |
-
Sets the following access...
Use macro defined in CATCreateWorkshop.h
o SetAccessWeight
| public static SetAccessWeight( | | i_pAccess, |
| | i_weight) |
-
Set the access weight.
- Parameters:
-
- i_pAccess
- the CATCmdAccess object on which to set the weight.
- i_weight
- the weight value to associate to the given CATCmdAccess object.
o SetAddinMenu
| public static SetAddinMenu( | | variableName, |
| | menu) |
-
Sets an addinmenu for the access
Use macro defined in CATCreateWorkshop.h
o SetRepresentationType
| public static SetRepresentationType( | | variableName, |
| | RepresentationType) |
-
Sets the representation type for an access.
Use macro defined in CATCreateWorkshop.h
o SetWorkbenchHiddenToolbar
| public static SetWorkbenchHiddenToolbar( | | variableName, |
| | TbName) |
-
Hides a toolbar while in a workbench.
Use macro defined in CATCreateWorkshop.h
o SetWorkbenchMenu
| public static SetWorkbenchMenu( | | variableName, |
| | menu) |
-
Sets a menu for the workbench
Use macro defined in CATCreateWorkshop.h
o SetWorkbenchToolbarStyle
| public static SetWorkbenchToolbarStyle( | | variableName, |
| | style) |
-
Defines toolbar's style for an access...
Use macro defined in CATCreateWorkshop.h
o SetWorkbenchToolbarsExclusive
| public static SetWorkbenchToolbarsExclusive( | | variableName) |
-
Sets the toolbars for an access to be exclusive....
Use macro defined in CATCreateWorkshop.h
o SetWorkbenchWithoutToolbar
| public static SetWorkbenchWithoutToolbar( | | variableName, |
| | TbName) |
-
Removes a toolbar while in a workbench.
Use macro defined in CATCreateWorkshop.h
o SetWorkshopMenu
| public static SetWorkshopMenu( | | variableName, |
| | menu) |
-
Sets a menu for the workshop
Use macro defined in CATCreateWorkshop.h
Enumerated Types
o CATAfrToolbarStyleDef
-
enum CATAfrToolbarStyleDef {
Icons,
Text
}
Defines the button representation in the toolbars.
- Parameters:
-
- Icons
- Each button in all toolbars of the workbench are represented by an icon.
Icons are defined in the CATRsc file of the header.
- Text
- Each button in all toolbars of the workbench are represented by a text.
The text is the title of the button. See the CATNls file of the header.
o ComponentPosition
-
enum ComponentPosition {
CATAfrTop,
CATAfrBottom,
CATAfrLeft,
CATAfrRight,
CATAfrUnDock,
CATAfrCompassWest
}
Position of the toolbar in the application window.
- Parameters:
-
- CATAfrUnDock
- The toolbar is undocked.
- CATAfrBottom
- The toolbar is docked at the bottom of the application window
- CATAfrTop
- The toolbar is docked at the top of the application window
- CATAfrLeft
- The toolbar is docked at the left of the application window
- CATAfrRight
- The toolbar is docked at the right of the application window
- CATAfrCompassWest
- The toolbar is docked on the west side of the compass
This object is included in the file: CATAfrAccessFactory.h
If needed, your Imakefile.mk should include the module: CATAfrFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.