|
NX Open C++ Reference Guide
|
Represents all UI based session user interface preferneces. More...
Public Types | |
| enum | DisplayResourceBar { DisplayResourceBarLeft, DisplayResourceBarRight } |
| Describes whether the resource bar is displayed on left or right of window. More... | |
Public Member Functions | |
| bool | ConfirmUndo () |
| Returns the confirm undo flag Created in NX3.0.0. More... | |
| int | DialogBarDecimalPlaces () |
| Returns the dialog box decimal places Created in NX3.0.0. More... | |
| bool | DialogBarTracking () |
| Returns the dialog bar tracking flag Created in NX3.0.0. More... | |
| bool | DisplayAlertsOnInformation () |
| Returns the option "Display Alerts on Information" gives choice, whether the user wants the Diagnostic alerts appear when features contain information messages during feature creation, edit, and update. More... | |
| bool | DisplayAlertsOnWarnings () |
| Returns the option "Display Alerts on Warnings" gives choice, whether the user wants the Diagnostic alerts appear when features contain warnings during feature creation, edit, and update. More... | |
| bool | DisplayDialogsInPlayback () |
| Returns the display dialogs in playback flag Created in NX3.0.0. More... | |
| NXOpen::Preferences::SessionUserInterfaceUI::DisplayResourceBar | DisplayResourceBarOption () |
| Returns the display resource bar option Created in NX3.0.0. More... | |
| NXString | HomePageURL () |
| Returns the home page URL Created in NX3.0.0. More... | |
| bool | InitialDialogDisplay () |
| Returns the initial dialog display flag Created in NX4.0.0. More... | |
| int | ListingDecimalPlaces () |
| Returns the listing decimal places Created in NX3.0.0. More... | |
| bool | PagesAutomaticallyFlyOut () |
| Returns the pages automatically fly outflag Created in NX3.0.0. More... | |
| int | PauseDuration () |
| Returns the pause duration Created in NX3.0.0. More... | |
| bool | RecordAllTransform () |
| Returns the record all transform flag Created in NX3.0.0. More... | |
| void | ResetDialogBoxSettings () |
| Resets all dialog box settings Created in NX6.0.0. More... | |
| bool | SaveLayoutAtExit () |
| Returns the save layout at exit flag. More... | |
| void | SetConfirmUndo (bool confirmUndo) |
| Sets the confirm undo flag Created in NX3.0.0. More... | |
| void | SetDialogBarDecimalPlaces (int dialogBarDecimalPlaces) |
| Sets the dialog box decimal places Created in NX3.0.0. More... | |
| void | SetDialogBarTracking (bool dialogBarTrackingFlag) |
| Sets the dialog bar tracking flag Created in NX3.0.0. More... | |
| void | SetDisplayAlertsOnInformation (bool displayAlertsOnInformation) |
| Sets the option "Display Alerts on Information" gives choice, whether the user wants the Diagnostic alerts appear when features contain information messages during feature creation, edit, and update. More... | |
| void | SetDisplayAlertsOnWarnings (bool displayAlertsOnWarnings) |
| Sets the option "Display Alerts on Warnings" gives choice, whether the user wants the Diagnostic alerts appear when features contain warnings during feature creation, edit, and update. More... | |
| void | SetDisplayDialogsInPlayback (bool displayDialogInPlaybackFlag) |
| Sets the display dialogs in playback flag Created in NX3.0.0. More... | |
| void | SetDisplayResourceBarOption (NXOpen::Preferences::SessionUserInterfaceUI::DisplayResourceBar displayResourceBar) |
| Sets the display resource bar option Created in NX3.0.0. More... | |
| void | SetHomePageURL (const NXString &homePageUrl) |
| Sets the home page URL Created in NX3.0.0. More... | |
| void | SetHomePageURL (const char *homePageUrl) |
| Sets the home page URL Created in NX3.0.0. More... | |
| void | SetInitialDialogDisplay (bool initialDialogDisplay) |
| Sets the initial dialog display flag Created in NX4.0.0. More... | |
| void | SetListingDecimalPlaces (int listingDecimalPlaces) |
| Sets the listing decimal places Created in NX3.0.0. More... | |
| void | SetPagesAutomaticallyFlyOut (bool pagesAutomaticallyFlyOut) |
| Sets the pages automatically fly outflag Created in NX3.0.0. More... | |
| void | SetPauseDuration (int pauseDuration) |
| Sets the pause duration Created in NX3.0.0. More... | |
| void | SetRecordAllTransform (bool recordAllTransformFlag) |
| Sets the record all transform flag Created in NX3.0.0. More... | |
| void | SetSaveLayoutAtExit (bool saveLayoutFlag) |
| Sets the save layout at exit flag. More... | |
| void | SetUseSystemPrecision (bool useSystemPrecision) |
| Sets the use system precision flag. More... | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
| bool | UseSystemPrecision () |
| Returns the use system precision flag. More... | |
Represents all UI based session user interface preferneces.
Other User Interface settings are available with NXOpen::Preferences::SessionUserInterface for settings applicable to session and with NXOpen::Preferences::PartUserInterface for User Interface Preferences applicable to part
To obtain an instance of this class, refer to NXOpen::UI
Created in NX3.0.0.
| bool NXOpen::Preferences::SessionUserInterfaceUI::ConfirmUndo | ( | ) |
Returns the confirm undo flag
Created in NX3.0.0.
License requirements : None
| int NXOpen::Preferences::SessionUserInterfaceUI::DialogBarDecimalPlaces | ( | ) |
Returns the dialog box decimal places
Created in NX3.0.0.
License requirements : None
| bool NXOpen::Preferences::SessionUserInterfaceUI::DialogBarTracking | ( | ) |
Returns the dialog bar tracking flag
Created in NX3.0.0.
License requirements : None
| bool NXOpen::Preferences::SessionUserInterfaceUI::DisplayAlertsOnInformation | ( | ) |
Returns the option "Display Alerts on Information" gives choice, whether the user wants the Diagnostic alerts appear when features contain information messages during feature creation, edit, and update.
if the option is true then the diagnostic alerts will appear. if the option is false then diagnostic alerts will not appear. Use DisplayAlertsOnWarnings and SetDisplayAlertsOnWarnings for display of alerts on warnings. Alerts are always displayed for errors and display of alerts on errors can not be changed.
Created in NX7.5.0.
License requirements : None
| bool NXOpen::Preferences::SessionUserInterfaceUI::DisplayAlertsOnWarnings | ( | ) |
Returns the option "Display Alerts on Warnings" gives choice, whether the user wants the Diagnostic alerts appear when features contain warnings during feature creation, edit, and update.
if the option is true then the diagnostic alerts will appear. if the option is false then diagnostic alerts will not appear. Use DisplayAlertsOnInformation and SetDisplayAlertsOnInformation for display of alerts on information messages. Alerts are always displayed for errors and display of alerts on errors can not be changed.
Created in NX7.5.0.
License requirements : None
| bool NXOpen::Preferences::SessionUserInterfaceUI::DisplayDialogsInPlayback | ( | ) |
Returns the display dialogs in playback flag
Created in NX3.0.0.
License requirements : None
| NXOpen::Preferences::SessionUserInterfaceUI::DisplayResourceBar NXOpen::Preferences::SessionUserInterfaceUI::DisplayResourceBarOption | ( | ) |
Returns the display resource bar option
Created in NX3.0.0.
License requirements : None
| NXString NXOpen::Preferences::SessionUserInterfaceUI::HomePageURL | ( | ) |
Returns the home page URL
Created in NX3.0.0.
License requirements : None
| bool NXOpen::Preferences::SessionUserInterfaceUI::InitialDialogDisplay | ( | ) |
Returns the initial dialog display flag
Created in NX4.0.0.
License requirements : None
| int NXOpen::Preferences::SessionUserInterfaceUI::ListingDecimalPlaces | ( | ) |
Returns the listing decimal places
Created in NX3.0.0.
License requirements : None
| bool NXOpen::Preferences::SessionUserInterfaceUI::PagesAutomaticallyFlyOut | ( | ) |
Returns the pages automatically fly outflag
Created in NX3.0.0.
License requirements : None
| int NXOpen::Preferences::SessionUserInterfaceUI::PauseDuration | ( | ) |
Returns the pause duration
Created in NX3.0.0.
License requirements : None
| bool NXOpen::Preferences::SessionUserInterfaceUI::RecordAllTransform | ( | ) |
Returns the record all transform flag
Created in NX3.0.0.
License requirements : None
| void NXOpen::Preferences::SessionUserInterfaceUI::ResetDialogBoxSettings | ( | ) |
Resets all dialog box settings
Created in NX6.0.0.
License requirements : None
| bool NXOpen::Preferences::SessionUserInterfaceUI::SaveLayoutAtExit | ( | ) |
Returns the save layout at exit flag.
Created in NX3.0.0.
License requirements : None
| void NXOpen::Preferences::SessionUserInterfaceUI::SetConfirmUndo | ( | bool | confirmUndo | ) |
Sets the confirm undo flag
Created in NX3.0.0.
License requirements : None
| confirmUndo | confirm undo |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetDialogBarDecimalPlaces | ( | int | dialogBarDecimalPlaces | ) |
Sets the dialog box decimal places
Created in NX3.0.0.
License requirements : None
| dialogBarDecimalPlaces | dialog bar decimal places |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetDialogBarTracking | ( | bool | dialogBarTrackingFlag | ) |
Sets the dialog bar tracking flag
Created in NX3.0.0.
License requirements : None
| dialogBarTrackingFlag | dialog bar tracking flag |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetDisplayAlertsOnInformation | ( | bool | displayAlertsOnInformation | ) |
Sets the option "Display Alerts on Information" gives choice, whether the user wants the Diagnostic alerts appear when features contain information messages during feature creation, edit, and update.
if the option is true then the diagnostic alerts will appear. if the option is false then diagnostic alerts will not appear. Use DisplayAlertsOnWarnings and SetDisplayAlertsOnWarnings for display of alerts on warnings. Alerts are always displayed for errors and display of alerts on errors can not be changed.
Created in NX7.5.0.
License requirements : None
| displayAlertsOnInformation | preference to display Diagnostic Alerts on Information Messages |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetDisplayAlertsOnWarnings | ( | bool | displayAlertsOnWarnings | ) |
Sets the option "Display Alerts on Warnings" gives choice, whether the user wants the Diagnostic alerts appear when features contain warnings during feature creation, edit, and update.
if the option is true then the diagnostic alerts will appear. if the option is false then diagnostic alerts will not appear. Use DisplayAlertsOnInformation and SetDisplayAlertsOnInformation for display of alerts on information messages. Alerts are always displayed for errors and display of alerts on errors can not be changed.
Created in NX7.5.0.
License requirements : None
| displayAlertsOnWarnings | preference to display Diagnostic Alerts on Warnings |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetDisplayDialogsInPlayback | ( | bool | displayDialogInPlaybackFlag | ) |
Sets the display dialogs in playback flag
Created in NX3.0.0.
License requirements : None
| displayDialogInPlaybackFlag | display dialog in playback flag |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetDisplayResourceBarOption | ( | NXOpen::Preferences::SessionUserInterfaceUI::DisplayResourceBar | displayResourceBar | ) |
Sets the display resource bar option
Created in NX3.0.0.
License requirements : None
| displayResourceBar | display resource bar |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetHomePageURL | ( | const NXString & | homePageUrl | ) |
Sets the home page URL
Created in NX3.0.0.
License requirements : None
| homePageUrl | home page url |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetHomePageURL | ( | const char * | homePageUrl | ) |
Sets the home page URL
Created in NX3.0.0.
License requirements : None
| homePageUrl | home page url |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetInitialDialogDisplay | ( | bool | initialDialogDisplay | ) |
Sets the initial dialog display flag
Created in NX4.0.0.
License requirements : None
| initialDialogDisplay | initial dialog display |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetListingDecimalPlaces | ( | int | listingDecimalPlaces | ) |
Sets the listing decimal places
Created in NX3.0.0.
License requirements : None
| listingDecimalPlaces | listing decimal places |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetPagesAutomaticallyFlyOut | ( | bool | pagesAutomaticallyFlyOut | ) |
Sets the pages automatically fly outflag
Created in NX3.0.0.
License requirements : None
| pagesAutomaticallyFlyOut | pages automatically fly out |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetPauseDuration | ( | int | pauseDuration | ) |
Sets the pause duration
Created in NX3.0.0.
License requirements : None
| pauseDuration | pause duration |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetRecordAllTransform | ( | bool | recordAllTransformFlag | ) |
Sets the record all transform flag
Created in NX3.0.0.
License requirements : None
| recordAllTransformFlag | record all transform flag |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetSaveLayoutAtExit | ( | bool | saveLayoutFlag | ) |
Sets the save layout at exit flag.
Created in NX3.0.0.
License requirements : None
| saveLayoutFlag | save layout flag |
| void NXOpen::Preferences::SessionUserInterfaceUI::SetUseSystemPrecision | ( | bool | useSystemPrecision | ) |
Sets the use system precision flag.
True uses the system precision
Created in NX3.0.0.
License requirements : None
| useSystemPrecision | use system precision |
| tag_t NXOpen::Preferences::SessionUserInterfaceUI::Tag | ( | ) | const |
Returns the tag of this object.
| bool NXOpen::Preferences::SessionUserInterfaceUI::UseSystemPrecision | ( | ) |
Returns the use system precision flag.
True uses the system precision
Created in NX3.0.0.
License requirements : None