Dashboard
An opaque pointer ProUIDashboard is a handle to the overall dashboard tool after it has been shown.
Showing a Dashboard
Functions Introduced:
Use the function ProUIDashboardShow() to push a new dashboard User Interface into the dashboard stack mechanism. The dashboard will be shown in the message area of . This function creates an event loop, and thus does not exit until the dashboard is being dismissed.
Use the function ProUIDashboardshowoptionsAlloc() to allocate a handle containing data used to build a dashboard. The input arguments for this function are:
• main_page—Specifies the main page for the dashboard.
• slideup_pages—Specifies a ProArray of handles representing the slide-down pages, if needed.
• appdata—Specifies the application data to be stored with the dashboard.
Use the function ProUIDashboardshowoptionsNotificationSet() to assign a callback function to be called for the indicated event occurrence in the dashboard. The input arguments for this function are:
• options—Specifies a handle to data used to build a dashboard.
• notification—Specifies the notification function to be called for the given event.
• appdata—Specifies the application data to be passed to the callback function when it is invoked.
You can register event notifications for the following events on the dashboard:
• PRO_UI_DASHBOARD_CREATE—when the dashboard is first initialized (before the pages are initialized).
• PRO_UI_DASHBOARD_SHOW—when the dashboard is shown or resumed.
• PRO_UI_DASHBOARD_HIDE—when the dashboard is paused and replaced by another tool.
• PRO_UI_DASHBOARD_ENTER—when you switch to a dashboard from another component in the ribbon user interface
• PRO_UI_DASHBOARD_EXIT
—when you leave the dash board and return to a component on the ribbon user interface
• PRO_UI_DASHBOARD_DISMISS—upon the dashboard “close” event.
• PRO_UI_DASHBOARD_DESTROY—when the dashboard is finally destroyed.
The function ProUIDashboardshowoptionsTitleSet() sets the title of the dashboard. The input arguments of this function are:
• dash_options—Specifies the handle containing data that is used to build the dashboard.
• title—Specifies the title of the dashboard.
Use the function ProUIDashboardshowoptionsIconSet() to set an icon for the specified dashboard. This is the first icon in the first group from the left on the dashboard.
The function ProUIDashboardshowoptionsHelpTextSet() sets the help text for the specified dashboard.
• 1. Dashboard icon
• 2. Dashboard help text
Use the function ProUIDashboardshowoptionsDefaultOpenSet() to set the specified dashboard as the open by default page. The input arguments follow:
• dash_options—Specify the handle to the data used to build the dashboard.
• page_name—Specify the page name to be opened by default.
You can use the function ProUIDashboardshowoptionsFree() to free a handle containing the data used to build a dashboard.
Use the function ProUIDashboardDestroy() to pop the dashboard from the dashboard stack mechanism. The dashboard User Interface will be destroyed.