Programming Reference: AIXShell

# Programming Reference

## AIXShell

Class Definition File | AIXShell.idl
Class C++ Binding | AIXShell.xh

Class Hierarchy

    SOMObject
       OpenDocShell
          ApplicationShell
             AIXShell

Description | The AIXShell class is a subclass of the ApplicationShell class. It provides the Motif or Common Desktop Environment (CDE) implementation of the shell as defined by ApplicationShell.

Methods

The methods defined by the AIXShell class include:

- CreateDocumentMenu
- CreateDraftsSubmenu
- CreateEditMenu
- CreateHelpMenu
- CreateLinksSubmenu
- CreateMenuItem
- CreateShowAsSubmenu
- CreateViewMenu

Overridden Methods

The AIXShell class overrides these methods:

- ApplicationSHell::CloseCleanup
- ApplicationShell::CreateMenuBar
- ApplicationShell::DocumentClose
- ApplicationShell::Exec
- ApplicationShell::InitWindowSystem
- ApplicationShell::MainLoop
- OpenDocShell::DispatchEvent
- OpenDocShell::GetEventSubType
- OpenDocShell::GetEventType
- OpenDocShell::GetEventWindow

### CreateDocumentMenu

This method creates the default Document menu.

Signature

    void CreateDocumentMenu (ODMenuBar *menuBar)

Parameters

menuBar (ODMenuBar *) - input

  A reference to the menu bar in which the Document menu is to be created.

Returns

None.

Remarks

This method creates the Document menu and its items and submenus. The AIX shell creates all menus dynamically. Windows and OS/2 shells get their menus from resource files.

Related Methods

- ApplicationShell::CreateMenuBar
- AIXShell::CreateDraftsSubmenu
- AIXShell::CreateMenuItem

### CreateDraftsSubmenu

This method creates the Drafts submenu of the default Document menu.

Signature

    ODPlatformMenu CreateDraftsSubmenu (ODMenuBar *menuBar)

Parameters

menuBar (ODMenuBar *) - input

  A reference to the menu bar in which the Drafts submenu is to be created.

Returns

rv (ODPlatformMenu) - returns

  The newly created submenu.

Remarks

This method creates the Drafts submenu of the Document menu. The AIX shell creates all menus dynamically. Windows and OS/2 shells get their menus from resource files.

Related Methods

- ApplicationShell::CreateMenuBar
- AIXShell::CreateDocumentMenu
- AIXShell::CreateMenuItem

### CreateEditMenu

This method creates the default Edit menu.

Signature

    void CreateEditMenu (ODMenuBar *menuBar)

Parameters

menuBar (ODMenuBar *) - input

  A reference to the menu bar in which the Edit menu is to be created.

Returns

None.

Remarks

This method creates the Edit menu and its items and submenus. The AIX shell creates all menus dynamically. Windows and OS/2 shells get their menus from resource files.

Related Methods

- ApplicationShell::CreateMenuBar
- AIXShell::CreateLinksSubmenu
- AIXShell::CreateMenuItem

### CreateHelpMenu

This method creates the default Help menu.

Signature

    void CreateEditMenu (ODMenuBar *menuBar)

Parameters

menuBar (ODMenuBar *) - input

  A reference to the menu bar in which the Help menu is to be created.

Returns

None.

Remarks

This method creates the Help menu and its items. The AIX shell creates all menus dynamically. Windows and OS/2 shells get their menus from resource files.

Related Methods

- ApplicationShell::CreateMenuBar
- AIXShell::CreateMenuItem

### CreateLinksSubmenu

This method creates the Links submenu of the default Edit menu.

Signature

    ODPlatformMenu CreateLinksSubmenu (ODMenuBar *menuBar)

Parameters

menuBar (ODMenuBar *) - input

  A reference to the menu bar in which the Links submenu is to be created.

Returns

rv (ODPlatformMenu) - returns

  The newly created submenu.

Remarks

This method creates the Links submenu of the Edit menu. The AIX shell creates all menus dynamically. Windows and OS/2 shells get their menus from resource files.

Related Methods

- ApplicationShell::CreateMenuBar
- AIXShell::CreateEditMenu
- AIXShell::CreateMenuItem

### CreateMenuItem

This method creates a menu item.

Signature

    void CreateMenuItem (ODMenuBar *menuBar,
                         ODMenuID menuID,
                         ODCommandID commandID,
                         ODULong messageID,
                         char *message)

Parameters

menuBar (ODMenuBar *) - input

  A reference to the menu bar in which the menu item is to be created.

menuID (ODMenuID) - input

  The ID of the menu in which this item it to be created.

commandID (ODCommandID) - input

  The ID of the menu item to be created.

messageID (ODULong) - input

  The index of the item label in the message catalog.

message (char *) - input

  The default menu item label string.

Returns

None.

Remarks

This method creates a new menu item in the given menu. It is called by the AIXShell's menu creation methods to create each of the menu items in the default menus.

Related Methods

- AIXShell::CreateDocumentMenu
- AIXShell::CreateDraftsSubmenu
- AIXShell::CreateEditMenu
- AIXShell::CreateHelpMenu
- AIXShell::CreateLinksSubmenu

### CreateShowAsSubmenu

This method creates the Show As submenu of the default View menu.

Signature

    ODPlatformMenu CreateShowAsSubmenu (ODMenuBar *menuBar)

Parameters

menuBar (ODMenuBar *) - input

  A reference to the menu bar in which the Show As submenu is to be created.

Returns

rv (ODPlatformMenu) - returns

  The newly created submenu.

Remarks

This method creates the Show As submenu of the View menu. The AIX shell creates all menus dynamically. Windows and OS/2 shells get their menus from resource files.

Related Methods

- ApplicationShell::CreateMenuBar
- AIXShell::CreateViewMenu
- AIXShell::CreateMenuItem

### CreateViewMenu

This method creates the default View menu.

Signature

    void CreateViewMenu (ODMenuBar *menuBar)

Parameters

menuBar (ODMenuBar *) - input

  A reference to the menu bar in which the View menu is to be created.

Returns

None.

Remarks

This method creates the View menu and its items and submenus. The AIX shell creates all menus dynamically. Windows and OS/2 shells get their menus from resource files.

Related Methods

- ApplicationShell::CreateMenuBar
- AIXShell::CreateShowAsSubmenu
- AIXShell::CreateMenuItem

[ Top | Previous | Next | Contents | Index | Documentation Homepage ]