#include <gre/uiformview.h>

| typedef fastdelegate::FastDelegate<void(UI::VIEW_CANVAS*) GRE::UI::FORM_VIEW::DELEGATE_ADDTOOLS) |
Flags for form creation.
| CREATEFLAG_None | |
| CREATEFLAG_3D |
View is 3D. |
| CREATEFLAG_NoCallCreateCB |
Don't call callback list when object created. |
| CREATEFLAG_NoRenderSeparate |
Don't render to separate memory buffers. |
| CREATEFLAG_DisableDraw |
Start with drawing initially disabled. |
| CREATEFLAG_IsLocator |
Create as "locator" view. |
| CREATEFLAG_AllowGPS |
Allow gps without making menu. Not needed for a SHELL_VIEW. |
| CREATEFLAG_NoDftViewButtons |
Don't put default "view" buttons on toolar. |
| CREATEFLAG_NoDftAddButtons |
Don't put default "add" button(s) on toolbar. |
| CREATEFLAG_NoDftMarkButtons |
Don't put default "mark" buttons on toolar. |
| CREATEFLAG_NoDftTools |
Don't add default tools. |
| CREATEFLAG_NoDft3dButtons |
Don't put default "3D" buttons on toolar (for 3D group view). |
| CREATEFLAG_NoToolScripts |
Don't add ToolScripts. |
| CREATEFLAG_NoDftButtons |
Don't add any default buttons to toolbar. |
| CREATEFLAG_NoSidebar |
Don't create sidebar pane. |
| CREATEFLAG_NoLegend |
Don't create legend pane. |
| CREATEFLAG_NoLocator |
Don't create locator pane. |
| CREATEFLAG_NoStatusBar |
Don't create statusbar pane. |
| CREATEFLAG_NoToolBar |
Don't create toolbar. |
| CREATEFLAG_No3dToolBar |
Don't create 3D toolbar (for 3D group view). |
| CREATEFLAG_NoMagnifier |
Don't create magnifier pane. |
| CREATEFLAG_AddLayerMgrButton |
Include "layer manager" button on toolbar (group view only), cannot use with CREATEFLAG_NoDftAddButtons. |
| CREATEFLAG_NoPlaces |
Don't create places pane. |
| CREATEFLAG_NoScalebarGadget |
Don't include scalebar gadget. |
| CREATEFLAG_NoZoomPane |
Don't create zoom pane. |
| CREATEFLAG_NoReadSettingsIni |
Don't read settings from Ini file when not provided. |
| CREATEFLAG_AllowGeoLock |
Allow GeoLocking. |
Buttons for "View" actions.
| GRE::UI::FORM_VIEW::FORM_VIEW | ( | GRE::VIEWABLE * | viewable | ) | [explicit] |
Constructor.
| virtual GRE::UI::FORM_VIEW::~FORM_VIEW | ( | ) | [virtual] |
Destructor.
| void GRE::UI::FORM_VIEW::ClearMessage | ( | ) |
Clear message line.
| void GRE::UI::FORM_VIEW::ClearPreviousViewList | ( | ) |
Clear previous view list.
| ERRVALUE GRE::UI::FORM_VIEW::Create | ( | MGUI::LAYOUT_PANE_BASE & | PaneParent, | |
| INT32 | CanvasWidth, | |||
| INT32 | CanvasHeight, | |||
| const char * | IniFieldBase = 0, |
|||
| CREATEFLAGS | CreateFlags = CREATEFLAG_None, |
|||
| MGUI::LAYOUT_SIZEALIGN | sizealign = MGUI::LAYOUT_SIZEALIGN_Expand, |
|||
| const SETTINGS * | pSettings = 0 | |||
| ) |
Create the form.
| IniFieldBase | Field from .ini for auto-savable settings, 0 for none |
| void GRE::UI::FORM_VIEW::Create3dToolBar | ( | MGUI::LAYOUT_PANE & | PaneParent | ) |
Create 3D toolbar.
Used if want to create in nonstandard position.
| PaneParent | Parent pane |
| void GRE::UI::FORM_VIEW::CreatePaneToolBar | ( | MGUI::LAYOUT_PANE & | PaneParent | ) |
Create pane for toolbar.
Used if want to create in nonstandard position.
| PaneParent | Parent pane |
| void GRE::UI::FORM_VIEW::CreateStatusBar | ( | MGUI::LAYOUT_PANE & | PaneParent, | |
| const SETTINGS * | pSettings = 0 | |||
| ) |
Create statusbar.
Used if want to create in nonstandard position.
| void GRE::UI::FORM_VIEW::DisableDraw | ( | ) |
Disable drawing for this view.
| void GRE::UI::FORM_VIEW::DlgCustomizeAddMenuItems | ( | MGUI::DLG_CUSTOMIZE & | dlg | ) |
Add predefined menu items to customization dialog.
| void GRE::UI::FORM_VIEW::DlgCustomizeAddToolBarItems | ( | MGUI::DLG_CUSTOMIZE & | dlg | ) |
Add predefined toolbar items to customization dialog.
| int GRE::UI::FORM_VIEW::DlgEditColors | ( | ) |
Edit background, highlight, active colors for view.
| void GRE::UI::FORM_VIEW::DlgEditCustomization | ( | ) |
Edit interface customization settings for views of this type.
| ERRVALUE GRE::UI::FORM_VIEW::Draw | ( | ) |
Draw view.
| ERRVALUE GRE::UI::FORM_VIEW::DrawIfAutoUpdate | ( | ) |
Draw view if auto-update is on.
| int GRE::UI::FORM_VIEW::DrawIfNeeded | ( | ) |
Draw if changed since last redraw.
| void GRE::UI::FORM_VIEW::EnableDraw | ( | ) |
Enable drawing for this view.
| MGUI::CTRL_MAGNIFIER* GRE::UI::FORM_VIEW::GetCanvasMagnifier | ( | ) | const |
Get "magnifier" managed by form.
| MGUI::LAYOUT_PANE& GRE::UI::FORM_VIEW::GetPaneToolBar | ( | ) |
Get LAYOUT_PANE for toolbar.
| bool GRE::UI::FORM_VIEW::GetRedrawOnAnyChange | ( | ) | const |
Determine if should redraw views on any change.
| const SETTINGS& GRE::UI::FORM_VIEW::GetSettingsToSave | ( | ) |
Get settings to save.
This will update settings from current form and view canvas, so should not be used to access individual values.
| MGUI::CTRL_STATUSBAR& GRE::UI::FORM_VIEW::GetStatusBar | ( | ) |
Get StatusBar control.
| GRE::VIEWABLE* GRE::UI::FORM_VIEW::GetViewable | ( | ) | const |
Get attached viewable.
| UI::VIEW_CANVAS* GRE::UI::FORM_VIEW::GetViewCanvas | ( | ) | const |
Get VIEW_CANVAS managed by form.
| UI::VIEW_CANVAS* GRE::UI::FORM_VIEW::GetViewLocator | ( | ) | const |
Get VIEW_CANVAS for "locator" managed by form.
| void GRE::UI::FORM_VIEW::LegendEnableRedraw | ( | bool | enable | ) |
Enable or disable redraw of LegendView.
| bool GRE::UI::FORM_VIEW::LegendIsVisible | ( | bool | CheckSidebar = true |
) | const |
Determine if legend is visible.
| CheckSidebar | Check sidebar also |
| void GRE::UI::FORM_VIEW::LegendRedraw | ( | ) |
Redraw the legend if visible.
| void GRE::UI::FORM_VIEW::LegendSetVisible | ( | bool | visible | ) |
Set whether legend is visible.
| INT16 GRE::UI::FORM_VIEW::LocatorGetHeight | ( | ) | const |
Get current locator height.
| bool GRE::UI::FORM_VIEW::LocatorIsVisible | ( | bool | CheckSidebar = true |
) | const |
Determine if locator is visible.
| CheckSidebar | Check sidebar also |
| void GRE::UI::FORM_VIEW::LocatorSetHeight | ( | INT16 | height | ) |
Set locator height.
| height | Height in pixels |
| void GRE::UI::FORM_VIEW::LocatorSetVisible | ( | bool | visible | ) |
Set whether locator is visible.
Note: Legend must also be visible for locator to be.
| INT16 GRE::UI::FORM_VIEW::MagnifierGetHeight | ( | ) | const |
Get current magnifier height.
| INT16 GRE::UI::FORM_VIEW::MagnifierGetZoom | ( | ) | const |
Get current magnifier zoom.
| bool GRE::UI::FORM_VIEW::MagnifierIsVisible | ( | bool | CheckSidebar = true |
) | const |
Determine if magnifier is visible.
| CheckSidebar | Check sidebar also |
| void GRE::UI::FORM_VIEW::MagnifierSetHeight | ( | INT16 | height | ) |
Set magnifier height.
| height | Height in pixels |
| void GRE::UI::FORM_VIEW::MagnifierSetVisible | ( | bool | visible | ) |
Set whether magnifier is visible.
Note: Legend must also be visible for magnifier to be.
| void GRE::UI::FORM_VIEW::MagnifierSetZoom | ( | INT16 | zoom | ) |
Set magnifier zoom.
| zoom | Zoom (2x, 4x, 8x, 16x) |
| void GRE::UI::FORM_VIEW::MenuAddItemsHotKeys | ( | MGUI::MENU & | submenu | ) |
Add items for "HotKeys".
| submenu | SubMenu to add items to |
| void GRE::UI::FORM_VIEW::MenuAddItemsView | ( | MGUI::MENU & | submenu | ) |
Add items for "View".
| submenu | SubMenu to add items to |
| void GRE::UI::FORM_VIEW::MenuAddSubMenuGPS | ( | MGUI::MENU & | menu | ) |
Add submenu for "GPS".
| menu | Menu to add to (usually a menu bar) |
| void GRE::UI::FORM_VIEW::MenuAddSubMenuHotKeys | ( | MGUI::MENU & | menu | ) |
Add submenu for "HotKeys".
| menu | Menu to add to (usually a menu bar) |
| void GRE::UI::FORM_VIEW::MenuAddSubMenuMacros | ( | MGUI::MENU & | menu | ) |
Add submenu for "Macros".
| menu | Menu to add to (usually a menu bar) |
| void GRE::UI::FORM_VIEW::MenuAddSubMenuOptions | ( | MGUI::MENU & | menu | ) |
Add submenu for "Options".
| menu | Menu to add to (usually a menu bar) |
| void GRE::UI::FORM_VIEW::MenuAddSubMenuTools | ( | MGUI::MENU & | menu | ) |
Add submenu for "Tools" to specified menu.
| menu | Menu to add to (usually a menu bar) |
| void GRE::UI::FORM_VIEW::MenuAddSubMenuView | ( | MGUI::MENU & | menu | ) |
Add submenu for "View".
| menu | Menu to add to (usually a menu bar) |
| void GRE::UI::FORM_VIEW::MenuBarAddSubMenus | ( | MGUI::MENU & | MenuBar, | |
| SUBMENUS | submenus | |||
| ) |
Add submenus to menubar.
| MenuBar | Menu bar | |
| submenus | Which submenus to add |
| void GRE::UI::FORM_VIEW::MenuBarCreate | ( | MGUI::SHELL & | shell, | |
| SUBMENUS | submenus = SUBMENUS_All, |
|||
| bool | AddSeparator = true | |||
| ) |
Create menubar with specified submenus.
| shell | Shell to attach menubar to | |
| submenus | Which submenus to add | |
| AddSeparator | Add separator line below menubar |
| MGUI::MENU& GRE::UI::FORM_VIEW::MenuGetOptions | ( | ) |
Get MGUI::MENU for "Options", creating if necessary.
May be used befor MenuBarCreate/MenuAddSubMenuOptions to add items to top of submenu, or afterward to add items to bottom of submenu.
| INT16 GRE::UI::FORM_VIEW::PlacesGetHeight | ( | ) | const |
Get current Places height.
| bool GRE::UI::FORM_VIEW::PlacesIsVisible | ( | bool | CheckSidebar = true |
) | const |
Determine if Places is visible.
| CheckSidebar | Check sidebar also |
| void GRE::UI::FORM_VIEW::PlacesSetHeight | ( | INT16 | height | ) |
Set Places height.
| height | Height in pixels |
| void GRE::UI::FORM_VIEW::PlacesSetVisible | ( | bool | visible | ) |
Set whether Places is visible.
Note: Legend must also be visible for Places to be.
| ERRVALUE GRE::UI::FORM_VIEW::SaveSnapshotQuick | ( | ) | const |
Save "quick snapshot" of current view contents.
| ERRVALUE GRE::UI::FORM_VIEW::SaveSnapshotToRaster | ( | ) | const |
Save "snapshot" of current view contents to raster.
| void GRE::UI::FORM_VIEW::SetDelegateAddTools | ( | DELEGATE_ADDTOOLS | DelegateAddTools | ) |
Set delegate to call to add extra tools.
| void GRE::UI::FORM_VIEW::SetDrawWireframe3D | ( | bool | DrawWireframe3D | ) |
Set whether to draw wireframe in 3D.
| void GRE::UI::FORM_VIEW::SetLayerListPos | ( | GRE::LISTPOS | ListPos | ) |
Set LISTPOS when use add layer.
| void GRE::UI::FORM_VIEW::SetPreviousView | ( | ) |
Set to previous view position.
| void GRE::UI::FORM_VIEW::SetRedrawOnAnyChange | ( | bool | RedrawOnAnyChange, | |
| bool | redraw = true | |||
| ) |
Set option to redraw view on any change.
| redraw | Redraw if changed and setting turned on |
| void GRE::UI::FORM_VIEW::SetViewBtnsToCreate | ( | VIEWBTNS | viewbtns | ) |
Set which "view" buttons will be created.
If used, must be done before Create().
| viewbtns | Buttons to be created |
| INT16 GRE::UI::FORM_VIEW::SidebarGetWidth | ( | ) | const |
Get current sidebar width.
| bool GRE::UI::FORM_VIEW::SidebarIsVisible | ( | ) | const |
Determine if sidebar is visible.
| void GRE::UI::FORM_VIEW::SidebarSetVisible | ( | bool | visible | ) |
Set whether sidebar is visible.
| void GRE::UI::FORM_VIEW::SidebarSetWidth | ( | INT16 | width | ) |
Set new sidebar width.
| width | Width in pixels |
| void GRE::UI::FORM_VIEW::StatusClearCoord | ( | COORDSOURCE | CoordSource = COORDSOURCE_None |
) |
Clear coordinate display in scale/position report.
| void GRE::UI::FORM_VIEW::StatusDisplayCoord | ( | COORDSOURCE | CoordSource, | |
| const DPOINT3D & | point, | |||
| const SPATREF::COORDREFSYS & | PointCRS, | |||
| const DPOINT3D * | pPtConfidence, | |||
| STATUSDISPLAY | StatusDisplay, | |||
| const UOM::UNIT * | pUnitZ = 0 | |||
| ) |
Display coordinates in status.
| CoordSource | Source for coordinates | |
| point | Point for coordinates | |
| PointCRS | CRS of point | |
| pPtConfidence | Point for determining confidence, typically one "pixel" away from specified point | |
| StatusDisplay | Display flags | |
| pUnitZ | Optional Z unit, if not set will check PointCRS or assume meters |
| COORDSOURCE GRE::UI::FORM_VIEW::StatusGetCoordSource | ( | ) | const |
| bool GRE::UI::FORM_VIEW::StatusIsPosVisible | ( | int | idx = -1 |
) | const |
Determine if position indicator is visible.
| void GRE::UI::FORM_VIEW::StatusSetCoordRefSys | ( | unsigned | idx, | |
| const SPATREF::COORDREFSYS & | CoordRefSys | |||
| ) |
Set CRS for coordinate indicator on statusbar.
| void GRE::UI::FORM_VIEW::StatusSetCoordSource | ( | COORDSOURCE | CoordSource | ) |
Set coordinate "source" indicator for statusbar.
| void GRE::UI::FORM_VIEW::StatusSetLatLonFormat | ( | unsigned | idx, | |
| DMSTYPE | LatLonFormat | |||
| ) |
Set format for geographic coordinate display.
| void GRE::UI::FORM_VIEW::StatusSetPosVisible | ( | unsigned | idx, | |
| bool | visible | |||
| ) |
Set whether statusbar position indicator is visible.
| void GRE::UI::FORM_VIEW::StatusSetVisible | ( | bool | visible | ) |
Set whether statusbar is visible.
| bool GRE::UI::FORM_VIEW::StereoIsViewIndicatorVisible | ( | ) | const |
Determine if stereo view indicators are visible when in stereo mode.
| void GRE::UI::FORM_VIEW::StereoSetViewIndicatorVisible | ( | bool | visible | ) |
Set whether stereo view indicators are visible.
| visible | Visible or not |
| void GRE::UI::FORM_VIEW::ToolBarAdd3dButtons | ( | ) |
Add 3D view control buttons to toolbar.
| void GRE::UI::FORM_VIEW::ToolBarAddAddButtons | ( | ) |
Add "add layer/group" buttons to toolbar.
| void GRE::UI::FORM_VIEW::ToolBarAddMacroScriptButtons | ( | ) |
Add MacroScript buttons to toolbar.
| void GRE::UI::FORM_VIEW::ToolBarAddMarkButtons | ( | ) |
Add "mark" buttons to toolbar.
| void GRE::UI::FORM_VIEW::ToolBarAddToolButtons | ( | ) |
Add "tool" togglebuttons to toolbar for all defined tools.
| void GRE::UI::FORM_VIEW::ToolBarAddViewButtons | ( | VIEWBTNS | buttons = VIEWBTN_Default |
) |
Add "view" buttons (previous, zoom in, zoom out, zoom 1X, etc) to toolbar.
| buttons | Which button to add |
| void GRE::UI::FORM_VIEW::UpdateMessage | ( | const MISTRING & | string | ) | const |
Update text on message line.
| INT16 GRE::UI::FORM_VIEW::ZoomGetHeight | ( | ) | const |
Get current zoom pane height.
| bool GRE::UI::FORM_VIEW::ZoomIsVisible | ( | bool | CheckSidebar = true |
) | const |
Determine if zoom pane is visible.
| CheckSidebar | Check sidebar also |
| void GRE::UI::FORM_VIEW::ZoomSetHeight | ( | INT16 | height | ) |
Set zoom pane height.
| height | Height in pixels |
| void GRE::UI::FORM_VIEW::ZoomSetVisible | ( | bool | visible | ) |
Set whether zoom pane is visible.
Note: Legend must also be visible for zoom pane to be.
1.6.1