Routines for profedit.kb


AddNewIcon

File Name

profedit.kb

Syntax

AddNewIcon(VAL w: WINDOW, REF pc: ProfileConfigEventRec, VAL fromPreview: BOOLEAN): INTEGER

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

Called when the user clicks on the Add Icon button or when the user adds a new icon from the icon bar preview.

Dialog Forms Called

None


AddNewMenu

File Name

profedit.kb

Syntax

AddNewMenu(VAL w: WINDOW, REF pc: ProfileConfigEventRec, VAL fromPreview: BOOLEAN):INTEGER

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

Called when the user clicks on the Add Menu button or when the user adds a new menu from the menu bar preview.

Dialog Forms Called

None


AddNewRowToLastMenuColumn

File Name

profedit.kb

Syntax

AddNewRowToLastMenuColumn(VAL column: INTEGER, VAL menu_number: INTEGER, REF menuList: LIST OF MenuBarRecord)

Parameters

column - column to insert <new row>

menuNumber - number of the menu item to be added

menuList - menu list to which to add item

Returns

Integer

Side Effects

None

Description

Inserts a new row after the last row of the previous column, but only if the last row of the previous column is not already a new row.

Dialog Forms Called

None


AddOrEditIconForList

File Name

profedit.kb

Syntax

AddOrEditIconForList(VAL w: Window, REF pc: ProfileConfigEventRec, VAL mode: STRING, VAL fromPreview: BOOLEAN )

Parameters

w - window handle

pc - ProfileConfigEventRec

mode - add or edit

Returns

Nothing

Side Effects

None

Description

This procedure adds an icon to the icon bar list. It is called when the user is adding a new profile, so profile_id and modify_datetimes are not yet known.

Dialog Forms Called

None


AddOrEditMenuColumnFromPreview

File Name

profedit.kb

Syntax

AddOrEditMenuColumnFromPreview(VAL w: WINDOW, VAL viewMenuData: ViewMenuItemEventRec): INTEGER

Parameters

w - window handle

viewMenuData - viewMenuItemEventRec

Returns

Nothing

Side Effects

None

Description

Called when the adds a menu column from preview.

Dialog Forms Called

None


AddToMenuList

File Name

profedit.kb

Syntax

AddToMenuList(VAL menuText: STRING, VAL menuNumber: INTEGER, REF menuList: LIST OF MenuBarRecord)

Parameters

menuText - text of the menu item to be added

menuNumber - number of the menu item to be added

menuList - menu list to add item to

Returns

menuList - Updated list of menu items

Side Effects

None

Description

This function adds a menu item to the menu list.

Dialog Forms Called

None


AddToProfileAssignList

File Name

profedit.kb

Syntax

AddToProfileAssignList(VAL w: Window, REF AssignList: LIST OF ProfileAssignRecord, REF profile_assign: ProfileAssignRecord)

Parameters

w - window handle

AssignList - list of ProfileAssignRecord

profile_assign - ProfileAssignRecord

Returns

Nothing

Side Effects

None

Description

This procedure takes the profile assignment and if the user or group already has another profile, prompts the user that if they choose OK, it replaces the user's or group's profile with this profile. If the user chooses OK, the assignment is added to the AssignList. If the user or group does not have a profile assignment, the assignment is added to the AssignList. When the profile is added or updated, the profile assignments in the AssignList are inserted/updated in the database.

Dialog Forms Called

None


BrowseIconFile

File Name

profedit.kb

Syntax

BrowseIconFile(VAL w: WINDOW, VAL icon: IconBarRecord)

Parameters

icon - IconBarRecord

Returns

icon

Side Effects

None

Description

This routine obtains the file name to associate with the icon

Dialog Forms Called

None


ClearEntityFields

File Name

profedit.kb

Syntax

ClearEntityFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure clears the entity variables in the ProfileConfigEventRec and also clears all entity boxes on the Profile Editor.

Dialog Forms Called

None


ClearIconField

File Name

profedit.kb

Syntax

ClearIconFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure clears the icon fields and icon variables in the ProfileConfigEventRec.

Dialog Forms Called

None


ClearMenuFields

File Name

profedit.kb

Syntax

ClearMenuFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure clears the menu variables in the ProfileConfigEventRec and also clears all menu boxes on the Profile Editor.

Dialog Forms Called

None


ClearProfileFields

File Name

profedit.kb

Syntax

ClearProfileFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure clears all the profile variables on the profileConfigEventRec and also clears all the profile boxess on the Profile Editor.

Dialog Forms Called

None


ClearSystemActionFields

File Name

profedit.kb

Syntax

ClearSystemActionFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - the window handle of the profile editor

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure clears the system action related variables on the profileConfigEventRec. It also clears the action fields.

Dialog Forms Called

None


CopyProfile

File Name

profedit.kb

Syntax

CopyProfile(REF profile: ProfileRecord, VAL profile_name: STRING): INTEGER

Parameters

profile - ProfileRecord

profile_name - ProfileName

Returns

Integer

Side Effects

None

Description

This function takes the profile provided and copies it to a new profile with the profile name given. The profile entity relationship, icons and menus are copied. The system, group and user assignments are not copied because a user and group can only have one profile assigned and only one profile can be the system default.

Dialog Forms Called

None


DeleteIconPosition

File Name

profedit.kb

Syntax

DeleteIconPosition(VAL w: WINDOW, REF pc: profileConfigEventRec, VAL fromPreview: BOOLEAN)

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

Called when the user clicks on the delete Icon button or when the user deletes an icon from the icon bar preview.

Dialog Forms Called

None


DeleteMenuPosition

File Name

profedit.kb

Syntax

DeleteMenuPosition(VAL w: WINDOW, REF pc: profileConfigEventRec, VAL fromPreview: BOOLEAN): INTEGER

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

Called when the user clicks on the delete Menu button or when the user deletes menu item from the menu bar preview.

Dialog Forms Called

None


FillEntityFields

File Name

profedit.kb

Syntax

FillEntityFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure retrieves the currently selected row in the list of entities. It sets pc.entity and pc.entityActionList. It also fills in the entity fields with those values.

Dialog Forms Called

None


FillEntityList

File Name

profedit.kb

Syntax

FillEntityList(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure clears the entitylist control and inserts all the entities in the control. Based on the number of entities, it enables or disables buttons and calls a function to fill in the entity fields.

Dialog Forms Called

None


FillIconBarForProfile

File Name

profedit.kb

Syntax

FillIconBarForProfile(VAL w: Window, REF pc: ProfileConfigEventRec)

Parameters

Nothing

Returns

Nothing

Side Effects

None

Description

This routine fills the menu list when a profile is selected or when the user changes to the menu page after a profile was previously selected.

Dialog Forms Called

None


FillIconFields

File Name

profedit.kb

Syntax

FillIconFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure retrieves the currently selected row in the list of icons. It sets pc.icon. It also fills in the icon fields with those values.

Dialog Forms Called

None


FillIconList

File Name

profedit.kb

Syntax

FillIconList(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure clears the iconlist control and inserts the all the icons in the control. Based on the number of icons, it enables or disables buttons and calls a function to fill in the icon fields.

Dialog Forms Called

None


FillIconPositionComboBox

File Name

profedit.kb

Syntax

FillIconPositionComboBox( VAL w: WINDOW )

Parameters

w - the window handle of the profile editor

Returns

Nothing

Side Effects

None

Description

This procedure fills the icon position (ICON_POSITION) combo box used on the Toolbar Buttons tab of the Profile Configuration dialog box.

Dialog Forms Called

None


FillMenuFields

File Name

profedit.kb

Syntax

FillMenuFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w: window handle

pc: ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure retrieves the currently selected row in the list of menu items. It sets pc.menu. It also fills in the menu fields with those values.

Dialog Forms Called

None


FillMenuForProfile

File Name

profedit.kb

Syntax

FillMenuForProfile(VAL w: Window, REF pc: ProfileConfigEventRec)

Parameters

Nothing

Returns

Nothing

Side Effects

None

Description

This routine fills the menu list when a profile is selected or when the user changes to the menu page after a profile was previously selected.

Dialog Forms Called

None


FillMenuList

File Name

profedit.kb

Syntax

FillMenuList(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure clears the menulist control and inserts all the menu items in the control. Based on the number of menu items, it enables or disables buttons and calls a function to fill in the menu fields.

Dialog Forms Called

None


FillProfileFields

File Name

profedit.kb

Syntax

FillProfileFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure gets the data for the currently selected profile, fills the profile variables on the ProfileConfigEventRec and also fills the profile boxes on the Profile Editor.

Dialog Forms Called

None


FillProfileList

File Name

profedit.kb

Syntax

FillProfileList(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure will clear the profilelist control and insert the current list of profiles. It will then enable or disable buttons depending on how many profiles are in the list and will call a function to fill the profile boxes.

Dialog Forms Called

None


FillSystemActionFields

File Name

profedit.kb

Syntax

FillSystemActionFields(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - the window handle of the Profile Editor

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure gets the currently selected system action, fills the associated system action variables on the pc reordc, and sets the system action boxes on the Profile Editor.

Dialog Forms Called

None


FillSystemActionListBox

File Name

profedit.kb

Syntax

FillSystemActionListBox(VAL w: Window, VAL fieldname: STRING, REF profile: ProfileRecord, VAL profileEntityList: LIST OF entityRecord)

Parameters

w - the window handle of the profile editor

fieldname - the control that needs to be filled

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure gets the profile and fills the boxes with the profile's system actions.

Dialog Forms Called

None


FillSystemActionsList

File Name

profedit.kb

Syntax

FillSystemActionsList(VAL w: Window, REF pc: ProfileConfigEventRec )

Parameters

w - the window handle of the Profile Editor

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This procedure gets the currently selected system action, fills the associated system action variables on the pc record, and sets the system action boxes on the Profile Editor.

Dialog Forms Called

None


HasProfileRights

File Name

profedit.kb

Syntax

HasProfileRights(VAL rights:INTEGER): BOOLEAN

Parameters

rights - Integer of user's security_mask

Returns

TRUE if user has enough rights,FALSE otherwise

Side Effects

None

Description

This function checks whether the security_mask passed in allows the user to use the Profile Editor. This function is only used when the Profile Editor is launched by itself.

Dialog Forms Called

None


LoadIconsForProfile

File Name

profedit.kb

Syntax

LoadIconForProfile ( VAL w: WINDOW, VAL profile: ProfileRecord, REF ToolBarList: LIST OF $ToolbarNodeRecord)

Parameters

Integer - profile ID for which to create iconbar

List of $ToolbarNodeRecord - List of icons for this profile

Returns

ToolBarList - LIST OF $ToolbarNodeRecord

Side Effects

None

Description

This function will load the toolbar for the given profile passed in. The final list is a depiction of the icons for that profile.

Dialog Forms Called

None


LoadMenuForProfile

File Name

profedit.kb

Syntax

LoadMenuForProfile ( VAL w: WINDOW, VAL profile: ProfileRecord, REF menuTextList: List of STRING)

Parameters

ProfileRecord - profile for which to create menubar

LIST OF STRING - menu string list for this profile

Returns

List of String

Side Effects

None

Description

This function will load the menu bar for the given profile passed in.

Dialog Forms Called

None


Profile_Configuration

File Name

profedit.kb

Syntax

Profile_Configuration

Parameters

Nothing

Returns

Nothing

Side Effects

None

Description

This procedure launch the Profile Editor.

Dialog Forms Called

None


Profile_Main

File Name

profedit.kb

Syntax

Profile_Main(VAL Args: LIST OF STRING)

Parameters

Args - list of string (passed in on the command line)

Returns

Nothing

Side Effects

None

Description

This procedure will allow the user to login to the database, initialize some global variables, and start the Profile Editor if they have the rights to do so.

Dialog Forms Called

None


ProfileConfigurationEvent

File Name

profedit.kb

Syntax

ProfileConfigurationEvent(REF pc: ProfileConfigEventRec)

Parameters

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This event launches the Profile Editor. It allows the user to add,update,delete profiles; to add,update,delete entities; to add,update,delete system actions; to add,update,delete icons for a profile; to add, update, delete menus for a profile.

Dialog Forms Called

None


ProfileCopyEvent

File Name

profedit.kb

Syntax

ProfileCopyEvent(REF profile_name: STRING)

Parameters

profile_name - String of original profile name

Returns

the new profile_name

Side Effects

None

Description

This procedure will allow the user to enter in the new profile name for the profile they are trying to copy.

Dialog Forms Called

None


RemoveFmProfileAssignList

File Name

profedit.kb

Syntax

RemoveFmProfileAssignList( VAL profile_id: INTEGER, REF AssignList: LIST OF ProfileAssignRecord, VAL profile_assign: ProfileAssignRecord )

Parameters

profile_id - integer representing the profile type..user or group

AssignList - List of ProfileAssignRecord

profile_assign - ProfileAssignRecord

Returns

Nothing

Side Effects

None

Description

This procedure takes the profile assignment and removes it from the AssignList and the list box.

Dialog Forms Called

None


ReSortIconMCLB

File Name

profedit.kb

Syntax

ReSortIconMCLB(VAL w: WINDOW, REF iconList: LIST OF IconBarEventRecord)

Parameters

iconList - list of icons

Returns

Nothing

Side Effects

None

Description

This procedure sorts the icon MCLB when the user adds a new icon to the list or changes the icon position for an existing icon.

Dialog Forms Called

None


ReSortMenuMCLB

File Name

profedit.kb

Syntax

ReSortMenuMCLB(VAL w: WINDOW, REF menuList: LIST OF MenuBarEventRecord)

Parameters

iconList - list of icons

Returns

Nothing

Side Effects

None

Description

This procedure sorts the menu MCLB when the user adds a new menu to the list or changes the menu position for an existing menu.

Dialog Forms Called

None


SaveIcon

File Name

profedit.kb

Syntax

SaveIcon(VAL w: WINDOW, REF pc: ProfileConfigEventRec, VAL fromPreview: BOOLEAN )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

Called when the user clicks on the Save Icon button or when the user saves an icon from the icon bar preview.

Dialog Forms Called

None


SaveMenu

File Name

profedit.kb

Syntax

SaveMenu(VAL w: WINDOW, REF pc: ProfileConfigEventRec, VAL fromPreview: BOOLEAN )

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

Called when the user clicks on the Save Menu button or when the user saves a menu from the menu bar preview.

Dialog Forms Called

None


SetIconButtons

File Name

profedit.kb

Syntax

SetIconButtons(VAL w: WINDOW)

Parameters

w - window handle

Returns

Nothing

Side Effects

None

Description

Sets the buttons on the Icons dialog box tab.

Dialog Forms Called

None


SetMenuButtons

File Name

profedit.kb

Syntax

SetMenuButtons(VAL w: WINDOW)

Parameters

w: window handle

Returns

Nothing

Side Effects

None

Description

Sets the buttons on the Menu dialog box tab.

Dialog Forms Called

None


SetMenuColumnRow

File Name

profedit.kb

Syntax

SetMenuColumnRow (REF menu: MenuBarEventRecord)

Parameters

menu - MenuBarEventRec

Returns

Nothing

Side Effects

None

Description

This procedure sets the menu.column and menu.row variables on the menu record according to the menu.menu_number.

Dialog Forms Called

None


SetMenuNumber

File Name

profedit.kb

Syntax

SetMenuNumber (REF menu: MenuBarRecord, REF column: Integer, REF row: Integer )

Parameters

menu - MenuBarRecord

column - Integer

row - Integer

Returns

Integer

Side Effects

None

Description

This procedure sets column and row variables based on the menu.menu_number.

Dialog Forms Called

None


SetProfileButtons

File Name

profedit.kb

Syntax

SetProfileButtons(VAL w: WINDOW)

Parameters

w - window handle

Returns

Nothing

Side Effects

None

Description

Sets buttons on the Profile tab.

Dialog Forms Called

None


SetRightForAction

File Name

profedit.kb

Syntax

SetRightForAction( REF action: SystemActionsRecord , REF rightsList: LIST OF RightsRecord): INTEGER

Parameters

action - the system action record

rightsList - list of rightrecord for this action

Returns

action - the system action record

Side Effects

None

Description

This function sets the right_required field on the action record for all required rights.

Dialog Forms Called

None


ShiftIconsRight

File Name

profedit.kb

Syntax

ShiftIconsRight(VAL w: WINDOW, REF pc: ProfileConfigEventRec, VAL fromPreview: BOOLEAN)

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

Moves all icons one position to the right.

Dialog Forms Called

None


ShiftMenu

File Name

profedit.kb

Syntax

ShiftMenu(VAL w: WINDOW, REF pc: ProfileConfigEventRec, VAL fromPreview: BOOLEAN)

Parameters

w - window handle

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

Moves menu columns to the right or rows of a menu down. If the user selected a column with row 0 to move, then all columns are moved to the right. If a column with other than a row 0 is selected, then the rows of that column are moved down.

Dialog Forms Called

None


SortIconList

File Name

profedit.kb

Syntax

SortIconList(REF iconList: LIST OF IconBarEventRecord)

Parameters

iconList - list of icon records

Returns

None

Side Effects

None

Description

Sorts the icon list.

Dialog Forms Called

None


SortMenuList

File Name

profedit.kb

Syntax

SortMenuList(REF menuList: LIST OF MenuBarEventRecord)

Parameters

menuList - list of menu records

Returns

None

Side Effects

None

Description

This function resorts the menu.

Dialog Forms Called

None


ValidateAction

File Name

profedit.kb

Syntax

ValidateAction (VAL w: Window, REF action: SystemActionsRecord, REF RightsList: LIST OF RightsRecord): INTEGER

Parameters

w - window handle

action - the system action record

rightsList - list of rightrecord for this action

Returns

action - the system action record

Side Effects

None

Description

This function sets action records for an add or update.

Dialog Forms Called

None


ValidateEntity

File Name

profedit.kb

Syntax

ValidateEntity(VAL w: Window, REF entity: EntityRecord): INTEGER

Parameters

w - window handle

entity - the entity record

Returns

None

Side Effects

None

Description

This function sets entity records for an add or update.

Dialog Forms Called

None


ValidateIcon

File Name

profedit.kb

Syntax

ValidateIcon( VAL w: Window, REF icon: IconBarRecord): Integer

Parameters

w - window handle

icon - the iconbar record

Returns

icon - the iconbar record

Side Effects

None

Description

This function sets icon records for an add or update.

Dialog Forms Called

None


ValidateMenu

File Name

profedit.kb

Syntax

ValidateMenu(VAL w: Window ,REF menu: MenuBarRecord, VAL fromPreview: BOOLEAN, VAL mode: STRING): INTEGER

Parameters

w - window handle

menu - the menubar record

fromPreview - invoked from the preview menubar dialog

Returns

menu - the menubar record

Side Effects

None

Description

This function sets menu records for an add or update.

Dialog Forms Called

None


ValidateProfile

File Name

profedit.kb

Syntax

ValidateProfile(VAL w: Window, REF profile: ProfileRecord): INTEGER

Parameters

w - window handle

profile - the profile record

Returns

1 for success, 0 for failure

Side Effects

None

Description

This function sets profile records for an add or update.

Dialog Forms Called

None


ViewIconBarEvent

File Name

profedit.kb

Syntax

ViewIconBarEvent(REF pc: ProfileConfigEventRec)

Parameters

profile - ProfileRecord

Returns

Nothing

Side Effects

None

Description

This event launches a dialog box with the icons for the profile selected. If changes are made to the icon bar, the dialog box reflects those changes.

Dialog Forms Called

None


ViewIconItemEvent

File Name

profedit.kb

Syntax

ViewIconItemEvent(REF pc: profileConfigEventRec)

Parameters

profile - ProfileRecord

Returns

Nothing

Side Effects

None

Description

This event launches a dialog box with the icons for the profile selected. If changes are made to the icon bar, the dialog box reflects those changes.

Dialog Forms Called

None


ViewMenuBarEvent

File Name

profedit.kb

Syntax

ViewMenuBarEvent(REF pc: ProfileConfigEventRec)

Parameters

pc - ProfileConfigEventRec

Returns

Nothing

Side Effects

None

Description

This event launches a dialog box with the menu for the profile selected. If changes are made to the menu, the dialog box reflects those changes.

Dialog Forms Called

None


ViewMenuItemEvent

File Name

profedit.kb

Syntax

ViewMenuItemEvent(REF ViewMenuData: ViewMenuItemEventRec)

Parameters

ViewMenuData - ViewMenuItemEventRec

Returns

Nothing

Side Effects

None

Description

This event launches a dialog box with the menu for the profile selected. If changes are made to the menu bar, the dialog box reflects those changes.

Dialog Forms Called

None


viwenuForList

File Name

profedit.kb

Syntax

AddOrEditMenuForList(VAL w: Window, REF pc: ProfileConfigEventRec, VAL mode: STRING, VAL fromPreview: BOOLEAN )

Parameters

w - window handle

pc - ProfileConfigEventRec

mode - add or edit

Returns

Nothing

Side Effects

None

Description

This procedure adds a menu item to the menu bar list. It is called when the user is adding a new profile so profile_id and modify_datetimes are not yet known.

Dialog Forms Called

None