The FreeCAD Graphical interface layer. More...

Namespaces
namespace	DAG

namespace	Dialog
	The namespace of the FreeCAD dialogs.

namespace	DockWnd
	The namespace of the dockable windows of FreeCAD.

namespace	Inventor

namespace	PropertyEditor
	The namespace of the property editor for FreeCAD.

namespace	TaskView

namespace	Ui

Classes
class	AbstractMouseSelection
	The mouse selection base class In derived classes you must implement the methods initialize() and terminate() For all drawing stuff you just have to reimplement the draw() method. More...

class	AbstractSplitView
	The SplitView3DInventor class allows to create a window with two or more Inventor views. More...

class	AbstractSplitViewPy

class	AbstractUi
	The AbstractUi class Abstract base class the defines the class interface. More...

class	AccelLineEdit
	The AccelLineEdit class provides a lineedit to specify shortcuts. More...

class	Action
	The Action class is the link between Qt's QAction class and FreeCAD's command classes (Command). More...

class	ActionFunction

class	ActionFunctionPrivate

class	ActionGroup
	The ActionGroup class is the link between Qt's QActionGroup class and FreeCAD's command classes (Command). More...

class	ActionSelector

class	ActionStyleEvent
	This is a helper class needed when a style sheet is restored or cleared. More...

class	ActiveObjectList
	List of active or special objects This class holds a list of objects with a special name. More...

class	AlignmentGroup
	The AlignemntGroup class is the base for fixed and movable groups. More...

class	AlignmentView

class	Application
	The Application main class This is the central class of the GUI. More...

class	ApplicationIndex

struct	ApplicationP

class	Assistant

class	AutoSaveProperty

class	AutoSaver

class	AxisOrigin
	A class to create a Coin3D node representation of an coordinate system. More...

class	BaseMouseSelection
	The standard mouse selection class. More...

class	BaseView
	Base class of all windows belonging to a document there are two ways of belonging to a document. More...

class	BitmapFactoryInst

class	BitmapFactoryInstP

class	BlankWorkbench
	The BlankWorkbench class defines a complete empty workbench. More...

class	BlenderNavigationStyle

class	BoxZoomSelection
	The box zoom mouse model class Draws a rectangle for box zooming. More...

class	Breakpoint

class	ButtonGroup
	The ButtonGroup class Unlike Qt's QButtonGroup this class allows it that in exclusive mode all buttons can be unchecked. More...

class	CADNavigationStyle

class	CallTip

class	CallTipsList

class	Camera

class	CameraAnimation

class	CheckListDialog
	The CheckListDialog class provides a dialog with a QListView with checkable items inside. More...

class	ClearLineEdit
	The ClearLineEdit class adds a clear button at the right side. More...

class	CoinPtr
	Convenience smart pointer to wrap coin node. More...

class	ColorButton
	Implementation of a color button. More...

struct	ColorButtonP

class	Command
	The Command class. More...

class	CommandBase
	The CommandBase class This lightweight class is the base class of all commands in FreeCAD. More...

class	CommandIconView
	This class allows to drag one or more items which correspond to a Command object. More...

class	CommandManager
	The CommandManager class This class manage all available commands in FreeCAD. More...

class	CompletionList
	The CompletionList class provides a list box that pops up in a text edit if the user has pressed an accelerator to complete the current word they are typing in. More...

class	ConsoleErrorTask

class	ConsoleHistory
	This class implements the history for the Python console. More...

class	ConsoleLogTask

class	ConsoleMessageTask

class	ConsoleWarningTask

class	ContainerDialog
	The ContainerDialog class acts as a container to embed any kinds of widgets that do not inherit from QDialog. More...

class	ControlSingleton
	The control class. More...

class	CustomMessageEvent
	The CustomMessageEvent class is used to send messages as events in the methods Error(), Warning() and Message() of the StatusBarObserver class to the main window to display them on the status bar instead of printing them directly to the status bar. More...

class	CustomPageProducer
	The CustomPageProducer class is a value-based template class that provides the ability to create custom pages dynamically. More...

class	DialogOptions
	The DialogOptions class Helper class to control whether to use native or Qt dialogs. More...

class	DlgObjectSelection
	Dialog for object dependency selection. More...

class	DockWidgetAction
	Special action to show all dockable views – except of toolbars – in an own popup menu. More...

class	DockWindow
	Base class of all dockable windows belonging to a document there are two ways of belonging to a document. More...

struct	DockWindowItem

class	DockWindowItems

class	DockWindowManager
	Class that manages the widgets inside a QDockWidget. More...

struct	DockWindowManagerP

class	Document
	The Gui Document This is the document on GUI level. More...

class	DocumentIndex

class	DocumentItem
	The link between the tree and a document. More...

class	DocumentModel

class	DocumentModelIndex

struct	DocumentModelP

class	DocumentObjectData

class	DocumentObjectItem
	The link between the tree and a document object. More...

class	DocumentObserver
	The DocumentObserver class simplifies the step to write classes that listen to what happens inside a document. More...

class	DocumentObserverPython
	The DocumentObserverPython class is used to notify registered Python instances whenever something happens to a document, like creation, destruction, adding or removing viewproviders or when viewprovider property changes. More...

struct	DocumentP

class	DocumentT
	The DocumentT class is a helper class to store the name of a document. More...

class	DocumentWeakPtrT
	The DocumentWeakPtrT class. More...

class	DoubleSpinBox
	The DoubleSpinBox class does exactly the same as Qt's QDoubleSpinBox but has expression support. More...

class	EditorView
	A special view class which sends the messages from the application to the editor and embeds it in a window. More...

class	EditorViewP

class	ElementColors

class	ExpLineEdit
	The ExpLineEdit class provides a lineedit that support expressing binding. More...

class	ExpressionBinding

class	ExpressionBindingPy

class	ExpressionCompleter
	The ExpressionCompleter class extends the QCompleter class to provide a completer model of documentobject names and properties. More...

class	ExpressionLineEdit

class	ExpressionParameter

class	ExpressionSpinBox

class	ExpressionTextEdit

class	FileChooser
	The FileChooser class provides a lineedit with a button on the right side to specify a file or directory. More...

class	FileDialog
	The FileDialog class provides dialogs that allow users to select files or directories. More...

class	FileIconProvider
	The FileIconProvider class provides icons for FileDialog to use. More...

class	FileOptionsDialog
	The FileOptionsDialog class provides an extensible file dialog with an additional widget either at the right or at the bottom, that can be shown or hidden with the 'Extended' button. More...

class	FixedGroup
	The FixedGroup class can be used for a fixed group of views. More...

class	Flag

class	FlagLayout

class	FormatString

class	FreehandSelection
	The freehand selection class. More...

class	GestureNavigationStyle

class	GLFlagWindow

class	GLGraphicsItem

class	GLOverlayWidget

class	GLPainter

class	GraphicsScene

class	GraphicsView

class	GraphicsView3D

class	GraphvizGraphicsView

class	GraphvizView

class	GraphvizWorker
	The GraphvizWorker class. More...

class	GroupCommand
	Class to help implement a group command. More...

class	GuiAbstractNativeEvent

class	GUIApplication
	Override QCoreApplication::notify() to fetch exceptions in Qt widgets properly that are not handled in the event handler or slot. More...

class	GUIApplicationNativeEventAware

class	GUIConsole
	The console window class This class opens a console window when instantiated and redirects the stdio streams to it as long it exists. More...

class	GuiNativeEvent

class	GUISingleApplication

class	HistoryList

class	HttpServer
	The HttpServer class implements a simple HTTP server. More...

class	InputField
	The InputField class The input field widget handles all around user input of Quantities. More...

class	InputValidator

class	InteractiveInterpreter
	This class implements an interactive Python interpreter. More...

struct	InteractiveInterpreterP

class	IntSpinBox
	The IntSpinBox class does exactly the same as Qt's QSpinBox but has expression support. More...

class	InventorNavigationStyle

class	ItemViewSelection

class	KeyboardFilter

class	LabelButton
	The LabelButton class provides a label with a button on the right side. More...

class	LabelEditor

class	LineMarker

class	LinkInfo

class	LinkOwner

class	LinkView

class	LocationDialog
	This is the abstract base dialog class that defines the interface for specifying a direction vector by the user. More...

class	LocationDialogImp
	This template class is a subclass of LocationDialog using LocationUi and implements the pure virtual methods of its base class. More...

class	LocationDialogUi
	This is the template class that implements the interface of LocationDialog. More...

class	LocationDialogUiImp
	This is a subclass of LocationDialog using AbstractUi that implements the pure virtual methods of its base class. More...

class	LocationImpUi
	This is the template class that implements the interface of AbstractUi. More...

class	LocationUi
	This template class does basically the same as LocationDialogUi unless that it doesn inherit from a widget but only from the UI_-generated class. More...

class	LocationWidget

class	MacroCommand
	The script command class This is a special type of command class. More...

class	MacroManager
	Macro recording and play back management The purpos of this class is to handle record function calls from a command and save it in a macro file (so far). More...

class	MainWindow
	The MainWindow class provides a main window with menu bar, toolbars, dockable windows, a status bar and mainly a workspace for the MDI windows. More...

struct	MainWindowP

class	MainWindowPy

class	ManualAlignment

class	MayaGestureNavigationStyle

class	MDITabbar

class	MDIView
	Base class of all windows belonging to a document. More...

class	MDIViewPy

class	MenuItem

class	MenuManager
	The MenuManager class is responsible for the creation of menus and context menus and appending them to the main window. More...

class	MergeDocuments

class	ModifierLineEdit
	The ModifierLineEdit class provides a lineedit to specify modifiers. More...

class	MovableGroup
	The FixedGroup class can be used for a fixed group of views. More...

class	MovableGroupModel
	The MovableGroupModel class keeps an array of movable groups. More...

class	NavigationStyle
	The navigation style base class. More...

class	NavigationStyleEvent

struct	NavigationStyleP

class	NetworkRetriever
	The NetworkRetriever class encapsulates the GNU tool wget. More...

struct	NetworkRetrieverP

struct	Node_Block

struct	Node_Object

struct	Node_Slice

class	NoneWorkbench
	The NoneWorkbench class defines a slim workbench. More...

class	OpenCascadeNavigationStyle

class	OpenGLBuffer

class	OpenGLMultiBuffer

class	OpenSCADNavigationStyle

class	OutputStderr
	Python class for redirection of stderr to FreeCAD's output console window. More...

class	OutputStdout
	Python class for redirection of stdout to FreeCAD's output console window. More...

class	PickedPoint

class	PointMarker

class	PolyClipSelection
	The poly clip mouse model class Create a polygon. More...

class	Polyline

class	PolyPickerSelection
	The poly picker mouse selection class Create a polygon. More...

class	PrefCheckBox
	The PrefCheckBox class. More...

class	PrefColorButton
	The PrefColorButton class. More...

class	PrefComboBox
	The PrefComboBox class. More...

class	PrefDoubleSpinBox
	The PrefDoubleSpinBox class. More...

class	PreferencePack
	of user preferences stored in files on disk More...

class	PreferencePackManager
	and loadable collections of user preferences More...

class	PrefFileChooser
	The PrefFileChooser class. More...

class	PrefFontBox
	The PrefFontBox class. More...

class	PrefLineEdit
	The PrefLineEdit class. More...

class	PrefPageProducer
	The PrefPageProducer class is a value-based template class that provides the ability to create preference pages dynamically. More...

class	PrefPagePyProducer
	The PrefPagePyProducer class provides the ability to create preference pages dynamically from a Python class. More...

class	PrefPageUiProducer
	The PrefPageUiProducer class provides the ability to create preference pages dynamically from an external UI file. More...

class	PrefQuantitySpinBox
	The PrefQuantitySpinBox class. More...

class	PrefQuantitySpinBoxPrivate

class	PrefRadioButton
	The PrefRadioButton class. More...

class	PrefSlider
	The PrefSlider class. More...

class	PrefSpinBox
	The PrefSpinBox class. More...

class	PrefTextEdit
	The PrefLineEdit class. More...

class	PrefUnitSpinBox
	The PrefUnitSpinBox class. More...

class	PrefWidget
	The preference widget class. More...

class	ProgressBar

struct	ProgressBarPrivate

class	ProgressDialog

class	ProjectWidget
	Tree view that allows drag & drop of document objects. More...

class	PropertyListEditor

class	PropertyView
	The property view class. More...

class	PyResource
	The PyResource class provides an interface to create widgets or to load .ui files from Python. More...

class	PySideUicModule

class	PythonBaseWorkbench
	The PythonBaseWorkbench class allows the manipulation of the workbench from Python. More...

class	PythonBlankWorkbench

class	PythonCommand
	The Python command class This is a special type of command class. More...

class	PythonConsole

class	PythonConsoleHighlighter
	Syntax highlighter for Python console. More...

struct	PythonConsoleP

class	PythonDebugExcept

class	PythonDebugger

struct	PythonDebuggerP

class	PythonDebuggerPy

class	PythonDebugModule

class	PythonDebugStderr

class	PythonDebugStdout

class	PythonEditor
	Python text editor with syntax highlighting. More...

struct	PythonEditorP

class	PythonEditorView

class	PythonGroupCommand
	The Python group command class. More...

class	PythonOnlineHelp
	Returns the content of an HTML page which gets sent to the client to be displayed. More...

class	PythonRedirector

class	PythonStderr
	Python class for redirection of stderr to FreeCAD's Python console window. More...

class	PythonStdin
	Python class for redirection of stdin to an input dialog of Qt. More...

class	PythonStdout
	Python class for redirection of stdout to FreeCAD's Python console window. More...

class	PythonSyntaxHighlighter
	Syntax highlighter for Python. More...

class	PythonSyntaxHighlighterP

class	PythonWorkbench
	The PythonWorkbench class allows the manipulation of the workbench from Python. More...

class	PythonWrapper

class	QtTools
	The QtTools class Helper class to reduce adding a lot of extra QT_VERSION checks to client code. More...

class	QuantitySpinBox

class	QuantitySpinBoxPrivate

class	RawInputEventFilter

class	RDragger
	Rotation Dragger. More...

class	RecentFilesAction
	The RecentFilesAction class holds a menu listed with the recent files. More...

class	RecentMacrosAction
	The RecentMacrosAction class holds a menu listed with the recent macros that were executed, edited, or created. More...

class	RecoveryRunnable

class	RecoveryWriter

class	RectangleSelection
	The selection mouse model class Draws a rectangle for selection. More...

class	RedoAction
	The RedoAction class reimplements a special behaviour to make a menu appearing when the button with the arrow is clicked. More...

class	ReportOutputParameter

class	RevitNavigationStyle

class	Rubberband

class	RubberbandSelection
	The selection mouse model class Draws a rectangle for selection. More...

class	RunningState

class	SceneEventFilter

class	SearchBar

class	SelectionChanges
	Transport the changes of the Selection This class transports closer information what was changed in the selection. More...

class	SelectionFilter
	Selection filter definition This class builds up a type/count tree out of a string to test very fast a selection or object/subelement type against it. More...

class	SelectionFilterGate
	Filter object for the SelectionSengleton This object is a link between the selection filter class and the selection singleton. More...

class	SelectionFilterGatePython
	A Python wrapper around SelectionFilterPy to implement the SelectionGate interface. More...

class	SelectionFilterPy
	Python binding for SelectionFilter class. More...

class	SelectionGate
	SelectionGate The selection gate allows or disallows selection of certain types. More...

class	SelectionGateFilterExternal
	SelectionGateFilterExternal The selection gate disallows any external object. More...

class	SelectionGatePython
	A wrapper around a Python class that implements the SelectionGate interface. More...

class	SelectionLogDisabler
	Helper class to disable logging selection action to MacroManager. More...

class	SelectionObject
	The Selection object class. More...

class	SelectionObserver
	The SelectionObserver class simplifies the step to write classes that listen to what happens to the selection. More...

class	SelectionObserverPython
	The SelectionObserverPython class implements a mechanism to register a Python class instance implementing the required interface in order to be notified on selection changes. More...

class	SelectionSingleton
	The Selection class The selection singleton keeps track of the selection state of the whole application. More...

class	SelectModule
	The SelectModule class provides a list of radio buttons to choose the module that should handle a certain file type. More...

class	SequencerBar
	FreeCAD's progress bar for long operations To see how to use the progress bar have a look at the following examples: More...

struct	SequencerBarPrivate

class	SequencerDialog

struct	SequencerDialogPrivate

class	SignalConnect
	The SignalConnect class provides the abitlity to make a connection between the callback function of a Python object and the slot onExecute(). More...

class	SoAutoZoomTranslation

class	SoAxisCrossKit

class	SoBoxSelectionRenderAction
	The SoBoxSelectionRenderAction class renders the scene with highlighted boxes around selections. More...

class	SoBoxSelectionRenderActionP

class	SoColorBarLabel
	A text label for the color bar. More...

class	SoFCBackgroundGradient

class	SoFCBoundingBox
	A subclass of SoShape used to create an axis aligned wire frame box based on the minBounds and maxBounds fields. More...

class	SoFCColorBar
	The color bar class that redirects all calls to its handled color bars. More...

class	SoFCColorBarBase
	The abstract color bar base class to get most important information on how to convert a scalar to an RGB color. More...

class	SoFCColorBarProxyObject

class	SoFCColorGradient

class	SoFCColorLegend

class	SoFCCSysDragger
	Coordinate System Dragger. More...

class	SoFCDB
	The FreeCAD database class to initialize all our own Inventor nodes. More...

class	SoFCDocumentAction
	The SoFCDocumentAction class is used to inform an SoFCSelection node when a document has been renamed. More...

class	SoFCDocumentObjectAction
	The SoFCDocumentObjectAction class is used to get the name of the document, object and component at a certain position of an SoFCSelection node. More...

class	SoFCEnableHighlightAction
	The SoFCEnableHighlightAction class is used to inform an SoFCSelection node whether preselection is enabled or disabled. More...

class	SoFCEnableSelectionAction
	The SoFCEnableSelectionAction class is used to inform an SoFCSelection node whether selection is enabled or disabled. More...

class	SoFCHighlightAction
	The SoFCHighlightAction class is used to inform an SoFCSelection node whether an object gets highlighted. More...

class	SoFCHighlightColorAction
	The SoFCHighlightColorAction class is used to inform an SoFCSelection node which preselection color is used. More...

class	SoFCInteractiveElement

class	SoFCOffscreenRenderer
	The SoFCOffscreenRenderer class is used for rendering scenes in offscreen buffers. More...

class	SoFCPathAnnotation

class	SoFCSelection
	Selection node This node does the complete highlighting and selection together with the viewer. More...

class	SoFCSelectionAction
	The SoFCSelectionAction class is used to inform an SoFCSelection node whether an object gets selected. More...

class	SoFCSelectionColorAction
	The SoFCSelectionColorAction class is used to inform an SoFCSelection node which selection color is used. More...

struct	SoFCSelectionContext

struct	SoFCSelectionContextBase

struct	SoFCSelectionContextEx

class	SoFCSelectionCounter

class	SoFCSelectionRoot

class	SoFCSeparator

class	SoFCUnifiedSelection
	Unified Selection node This is the new selection node for the 3D Viewer which will gradually remove all the low level selection nodes in the view provider. More...

class	SoFCVectorizeSVGAction

class	SoFCVectorizeSVGActionP

class	SoFCVectorizeU3DAction

class	SoFCVectorizeU3DActionP

class	SoFrameLabel

class	SoGLRenderActionElement

class	SoGLSelectAction
	The SoGLSelectAction class is used to get all data under a selected area. More...

class	SoGLVBOActivatedElement

class	SoGLWidgetElement

class	SoGLWidgetNode

class	SoHighlightElementAction

class	SoQtOffscreenRenderer

class	SoQtOffscreenRendererPy

class	SoRegPoint

class	SoSelectionElementAction

class	SoShapeScale

class	SoSkipBoundingGroup
	This is a special group node which must be defined to ignore bounding box actions. More...

class	SoStringLabel

class	SoSVGVectorOutput

class	SoTextLabel
	A text label with a background color. More...

class	SoU3DVectorOutput

class	SoUpdateVBOAction
	Helper class no notify nodes to update VBO. More...

class	SoVisibleFaceAction

class	SoVRMLAction

class	SplashObserver
	Displays all messages at startup inside the splash screen. More...

class	SplashScreen
	This widget provides a splash screen that can be shown during application startup. More...

class	SplitView3DInventor
	The SplitView3DInventor class allows to create a window with two or more Inventor views. More...

class	StatefulLabel
	A text label whose appearance can change based on a specified state. More...

class	StatusBarObserver
	The status bar observer displays the text on the status bar of the main window in an appropriate color. More...

class	StatusWidget

class	StdCmdDescription

class	StdCmdDownloadOnlineHelp

class	StdCmdPythonHelp

class	StdWorkbench
	The StdWorkbench class defines the standard menus, toolbars, commandbars etc. More...

class	SyntaxHighlighter
	Abstract Syntax highlighter. More...

class	SyntaxHighlighterP

class	TaskBoxAngle

class	TaskBoxPosition

class	TaskCSysDragger

class	TaskDlgRelocation

class	TaskElementColors

class	TDragger
	Translation Dragger. More...

class	Tessellator

class	TestConsoleObserver

class	TestWorkbench

struct	TextBlockData

class	TextDocumentEditorView

class	TextEdit

class	TextEditor

struct	TextEditorP

class	Thumbnail

class	TimerFunction

class	TimerFunctionPrivate

class	TinkerCADNavigationStyle

class	ToolBarAction
	Special action to show all toolbars in an own popup menu. More...

class	ToolBarItem

class	ToolBarManager
	The ToolBarManager class is responsible for the creation of toolbars and appending them to the main window. More...

class	ToolBoxManager
	The ToolBoxManager class is responsible for the creation of command bars and appending them to the toolbox window. More...

class	ToolTip
	Qt's tooltip does not work as expected with some classes, e.g. More...

class	TouchpadNavigationStyle

class	TransactionViewProvider

class	TranslateManip

class	Translator

class	TranslatorP

class	TreeDockWidget
	The dock window containing the tree view. More...

class	TreePanel

class	TreeParams
	Helper class to read/write tree view options. More...

class	TreeView

class	TreeWidget
	Tree view that allows drag & drop of document objects. More...

class	TreeWidgetEditDelegate
	TreeWidget item delegate for editing. More...

class	Ui_DlgObjectSelection

class	Ui_DlgTreeWidget

class	Ui_TaskElementColors

class	Ui_VectorListEditor

class	UiLoader
	The UiLoader class provides the abitlity to use the widget factory framework of FreeCAD within the framework provided by Qt. More...

class	UiLoaderPy

class	UIntSpinBox
	The UIntSpinBox class does basically the same as Qt's QSpinBox unless that it works with unsigned int's instead. More...

class	UIntSpinBoxPrivate

class	UndoAction
	The UndoAction class reimplements a special behaviour to make a menu appearing when the button with the arrow is clicked. More...

class	UnsignedValidator
	A validator that allows only input of unsigned int values in the range from 0 to UINT_MAX. More...

class	UrlHandler

class	UrlLabel
	A text label where a url can specified. More...

class	UserNavigationStyle
	Sub-classes of this class appear in the preference dialog where users can choose their favorite navigation style. More...

class	VectorListEditor

class	VectorTableDelegate

class	VectorTableModel

class	View3DInventor
	The 3D view window It consists out of the 3D view. More...

class	View3DInventorPy

class	View3DInventorViewer
	GUI view into a 3D scene provided by View3DInventor. More...

class	View3DInventorViewerPy
	Python interface for View3DInventorViewer. More...

class	ViewerEventFilter

class	ViewParams
	Convenient class to obtain view provider related parameters. More...

class	ViewProvider
	General interface for all visual stuff in FreeCAD This class is used to generate and handle all around visualizing and presenting objects from the FreeCAD App layer to the user. More...

class	ViewProviderAnnotation

class	ViewProviderAnnotationLabel
	This is a different implementation of an annotation object which uses an SoImage node instead of an SoText2 or SoAsciiText node. More...

class	ViewProviderBuilder

class	ViewProviderColorBuilder

class	ViewProviderDocumentObject

class	ViewProviderDocumentObjectGroup

class	ViewProviderDragger
	The base class for all view providers modifying the placement of a geometric feature. More...

class	ViewProviderExtension
	Extension with special viewprovider calls. More...

class	ViewProviderExtensionPythonT
	Generic Python extension class which allows to behave every extension derived class as Python extension – simply by subclassing. More...

class	ViewProviderExtern

class	ViewProviderFeature

class	ViewProviderGeoFeatureGroup

class	ViewProviderGeoFeatureGroupExtension

class	ViewProviderGeometryObject
	The base class for all view providers that display geometric data, like mesh, point clouds and shapes. More...

class	ViewProviderGroupExtension

class	ViewProviderIndex

class	ViewProviderInventorObject

class	ViewProviderLine

class	ViewProviderLink

class	ViewProviderLinkObserver

class	ViewProviderMap

class	ViewProviderMaterialObject

class	ViewProviderMeasureDistance

class	ViewProviderOrigin

class	ViewProviderOriginFeature
	View provider associated with an App::OriginFeature. More...

class	ViewProviderOriginGroup

class	ViewProviderOriginGroupExtension

class	ViewProviderPart

class	ViewProviderPlacement

class	ViewProviderPlane

class	ViewProviderPointMarker

class	ViewProviderPythonFeatureImp

class	ViewProviderPythonFeatureT

class	ViewProviderT
	The ViewProviderT class is a helper class to store the names of a view provider and its document. More...

class	ViewProviderTextDocument

class	ViewProviderVRMLObject

class	ViewProviderWeakPtrT
	The ViewProviderWeakPtrT class. More...

class	ViewVolumeProjection

class	WaitCursor
	This class sets a waitcursor automatically while a slow operation is running. More...

class	WaitCursorP

class	WeakPtrT
	The WeakPtrT class. More...

class	WheelEventFilter

class	WidgetFactoryInst
	The widget factory provides methods for the dynamic creation of widgets. More...

class	WidgetFactorySupplier
	The widget factory supplier class registers all kinds of preference pages and widgets. More...

class	WidgetProducer
	The WidgetProducer class is a value-based template class that provides the ability to create widgets dynamically. More...

class	WindowAction

class	WindowParameter
	Adapter class to the parameter of FreeCAD for all windows Retrieve the parameter group of the specific window by the windowname. More...

class	Workbench
	This is the base class for the workbench facility. More...

class	WorkbenchActionEvent
	The WorkbenchActionEvent class is used to send an event of which workbench must be activated. More...

class	WorkbenchComboBox

class	WorkbenchFactoryInst
	The workbench factory provides methods for the dynamic creation of special workbenches for each module. More...

class	WorkbenchGroup
	The WorkbenchGroup class represents a list of workbenches. More...

class	WorkbenchManager
	The WorkbenchManager class manages all workbench objects. More...

class	WorkbenchProducer
	The WorkbenchProducer template class allows the registration and the creation of workbench classes. More...

class	XMLMergeReader

Typedefs
typedef QPair< QString, bool >	CheckListItem

typedef std::shared_ptr< DocumentObjectData >	DocumentObjectDataPtr

typedef boost::graph_traits< Graph >::edge_descriptor	Edge

typedef boost::adjacency_list< boost::vecS, boost::vecS, boost::directedS, boost::no_property, boost::no_property, boost::no_property, boost::listS >	Graph

typedef boost::intrusive_ptr< LinkInfo >	LinkInfoPtr

typedef std::shared_ptr< Node_Object >	Node_ObjectPtr

typedef std::shared_ptr< SoFCSelectionContextBase >	SoFCSelectionContextBasePtr

typedef std::shared_ptr< SoFCSelectionContextEx >	SoFCSelectionContextExPtr

typedef std::shared_ptr< SoFCSelectionContext >	SoFCSelectionContextPtr

typedef std::list< std::string >	TStringList

typedef std::map< std::string, std::string >	TStringMap

typedef boost::graph_traits< Graph >::vertex_descriptor	Vertex

typedef ViewProviderPythonFeatureT< ViewProviderDocumentObjectGroup >	ViewProviderDocumentObjectGroupPython

typedef ViewProviderExtensionPythonT< Gui::ViewProviderExtension >	ViewProviderExtensionPython

typedef ViewProviderExtensionPythonT< Gui::ViewProviderGeoFeatureGroupExtension >	ViewProviderGeoFeatureGroupExtensionPython

typedef ViewProviderPythonFeatureT< ViewProviderGeoFeatureGroup >	ViewProviderGeoFeatureGroupPython

typedef ViewProviderExtensionPythonT< Gui::ViewProviderGroupExtension >	ViewProviderGroupExtensionPython

typedef ViewProviderPythonFeatureT< ViewProviderLink >	ViewProviderLinkPython

typedef ViewProviderPythonFeatureT< ViewProviderMaterialObject >	ViewProviderMaterialObjectPython

typedef ViewProviderExtensionPythonT< Gui::ViewProviderOriginGroupExtension >	ViewProviderOriginGroupExtensionPython

typedef ViewProviderPythonFeatureT< ViewProviderPart >	ViewProviderPartPython

typedef ViewProviderPythonFeatureT< ViewProviderPlacement >	ViewProviderPlacementPython

typedef ViewProviderPythonFeatureT< ViewProviderDocumentObject >	ViewProviderPythonFeature

typedef ViewProviderPythonFeatureT< ViewProviderGeometryObject >	ViewProviderPythonGeometry

Enumerations
enum class	HighlightMode { Underlined , Italic , Overlined , Bold , Blue , LightBlue , UserDefined }
	highlight modes for the tree items More...

enum class	ResolveMode { NoResolve , OldStyleElement , NewStyleElement , FollowLink }

enum	SelectionRole { }

enum class	TreeItemMode { ExpandItem , ExpandPath , CollapseItem , ToggleItem }
	highlight modes for the tree items More...

enum	ViewStatus { UpdateData = 0 , Detach = 1 , isRestoring = 2 , UpdatingView = 3 , TouchDocument = 4 }

Functions
void	addNodes (Graph &graph, std::map< SoNode , Vertex > &vertexNodeMap, SoNode node)

BitmapFactoryInst &	BitmapFactory (void)
	Get the global instance. More...

template<typename T >
void	cmdAppDocument (const App::Document *doc, T &&cmd)
	Runs a command for accessing App.Document attribute or method This function is an alternative to FCMD_DOC_CMD. More...

template<typename T >
void	cmdAppDocument (const App::DocumentObject *obj, T &&cmd)
	Runs a command for accessing an object's App::Document attribute or method This function is an alternative to FCMD_OBJ_DOC_CMD. More...

template<typename T >
void	cmdAppDocument (const std::string &doc, T &&cmd)
	Runs a command for accessing App.Document attribute or method This function is an alternative to FCMD_DOC_CMD. More...

template<typename... Args>
void	cmdAppDocumentArgs (const App::Document *doc, const std::string &cmd, Args &&... args)
	Runs a command for accessing a document's attribute or method. More...

template<typename T >
void	cmdAppObject (const App::DocumentObject *obj, T &&cmd)
	Runs a command for accessing an document object's attribute or method This function is an alternative to FCMD_OBJ_CMD. More...

template<typename... Args>
void	cmdAppObjectArgs (const App::DocumentObject *obj, const std::string &cmd, Args &&... args)
	Runs a command for accessing a document object's attribute or method This function is an alternative to FCMD_OBJ_CMD2. More...

void	cmdAppObjectHide (const App::DocumentObject *obj)
	Hides an object. More...

void	cmdAppObjectShow (const App::DocumentObject *obj)
	Shows an object. More...

template<typename T >
void	cmdGuiDocument (const App::Document *doc, T &&cmd)
	Runs a command for accessing App.Document attribute or method. More...

template<typename T >
void	cmdGuiDocument (const App::DocumentObject *obj, T &&cmd)
	Runs a command for accessing an object's Gui::Document attribute or method This function is an alternative to FCMD_VOBJ_DOC_CMD. More...

template<typename T >
void	cmdGuiDocument (const std::string &doc, T &&cmd)
	Runs a command for accessing App.Document attribute or method. More...

template<typename T >
void	cmdGuiObject (const App::DocumentObject *obj, T &&cmd)
	Runs a command for accessing an view object's attribute or method This function is an alternative to FCMD_VOBJ_CMD. More...

template<typename... Args>
void	cmdGuiObjectArgs (const App::DocumentObject *obj, const std::string &cmd, Args &&... args)
	Runs a command for accessing a view object's attribute or method This function is an alternative to FCMD_VOBJ_CMD2. More...

void	cmdSetEdit (const App::DocumentObject *obj, int mod=0)
	Runs a command to start editing a give object This function is an alternative to FCMD_SET_EDIT. More...

void	coinRemoveAllChildren (SoGroup *node)
	Helper function to deal with bug in SoNode::removeAllChildren() More...

ControlSingleton &	Control (void)
	Get the global instance. More...

template<typename... Args>
void	copyVisualT (Args &&... args)
	Copy visual attributes from a source to a target object. More...

void	CreateDocCommands (void)

void	CreateFeatCommands (void)

void	CreateLinkCommands (void)

void	CreateMacroCommands (void)

void	CreateStdCommands (void)

void	CreateStructureCommands (void)

void	CreateTestCommands (void)

void	CreateViewStdCommands (void)

void	CreateWindowStdCommands (void)

bool	cursorBeyond (const QTextCursor &cursor, const QTextCursor &limit, int shift=0)
	cursorBeyond checks if cursor is at a valid position to accept keyEvents. More...

template<typename... Args>
void	doCommandT (Gui::Command::DoCmd_Type cmdType, const std::string &cmd, Args &&... args)
	Runs a command. More...

static PyObject *	FreeCADGui_exportSubgraph (PyObject , PyObject args)

static PyObject *	FreeCADGui_getSoDBVersion (PyObject , PyObject args)

static PyObject *	FreeCADGui_subgraphFromObject (PyObject , PyObject args)

MainWindow *	getMainWindow ()

template<typename qttype >
PyTypeObject *	getPyTypeObjectForTypeName ()

WidgetFactorySupplier &	GetWidgetFactorySupplier ()

bool	OpenURLInBrowser (const char *URL)
	opens a URL in the system Browser More...

static const QChar	promptEnd (QLatin1Char(' '))

int	promptLength (const QString &lineStr)

	PROPERTY_SOURCE_TEMPLATE (PartDesignGui::ViewProviderSubShapeBinderPython, PartDesignGui::ViewProviderSubShapeBinder) template class ViewProviderPythonFeatureT< ViewProviderSubShapeBinder >

void *	qt_getCppPointer (const Py::Object &pyobject, const char shiboken, const char unwrap)

const char *	qt_identifyType (QObject ptr, const char pyside)

template<typename qttype >
Py::Object	qt_wrapInstance (qttype object, const char className, const char shiboken, const char pyside, const char wrap)

std::array< std::pair< double, std::string >, 3 >	schemaTranslatePoint (double x, double y, double z, double precision)

SelectionSingleton &	Selection (void)
	Get the global instance. More...

QString	stripPromptFrom (const QString &lineStr)

bool	validateInput (QWidget *parent, const QString &input)

WidgetFactoryInst &	WidgetFactory ()

WorkbenchFactoryInst &	WorkbenchFactory ()

Variables
struct PyMethodDef	FreeCADGui_methods []

template class SpreadsheetGuiExport	ViewProviderPythonFeatureT< ViewProviderSheet >

static const unsigned char	XPM_pixel_data [21 27 4+1]

static const unsigned char	YPM_pixel_data [21 27 4+1]

static const unsigned char	ZPM_pixel_data [21 27 4+1]

Detailed Description

The FreeCAD Graphical interface layer.

This namespace includes the grafical interface of FreeCAD like:

The main window
3D View
Tree

and so on......

Typedef Documentation

◆ CheckListItem

typedef QPair<QString, bool> Gui::CheckListItem

◆ DocumentObjectDataPtr

typedef std::shared_ptr<DocumentObjectData> Gui::DocumentObjectDataPtr

◆ Edge

typedef boost::graph_traits<Graph>::edge_descriptor Gui::Edge

◆ Graph

typedef boost::adjacency_list< boost::vecS, boost::vecS, boost::directedS, boost::no_property, boost::no_property, boost::no_property, boost::listS > Gui::Graph

◆ LinkInfoPtr

typedef boost::intrusive_ptr<LinkInfo> Gui::LinkInfoPtr

◆ Node_ObjectPtr

typedef std::shared_ptr<Node_Object> Gui::Node_ObjectPtr

◆ SoFCSelectionContextBasePtr

typedef std::shared_ptr<SoFCSelectionContextBase> Gui::SoFCSelectionContextBasePtr

◆ SoFCSelectionContextExPtr

typedef std::shared_ptr<SoFCSelectionContextEx> Gui::SoFCSelectionContextExPtr

◆ SoFCSelectionContextPtr

typedef std::shared_ptr<SoFCSelectionContext> Gui::SoFCSelectionContextPtr

◆ TStringList

typedef std::list<std::string> Gui::TStringList

◆ TStringMap

typedef std::map<std::string, std::string> Gui::TStringMap

◆ Vertex

typedef boost::graph_traits<Graph>::vertex_descriptor Gui::Vertex

◆ ViewProviderDocumentObjectGroupPython

typedef ViewProviderPythonFeatureT<ViewProviderDocumentObjectGroup> Gui::ViewProviderDocumentObjectGroupPython

◆ ViewProviderExtensionPython

typedef ViewProviderExtensionPythonT<Gui::ViewProviderExtension> Gui::ViewProviderExtensionPython

◆ ViewProviderGeoFeatureGroupExtensionPython

typedef ViewProviderExtensionPythonT<Gui::ViewProviderGeoFeatureGroupExtension> Gui::ViewProviderGeoFeatureGroupExtensionPython

◆ ViewProviderGeoFeatureGroupPython

typedef ViewProviderPythonFeatureT<ViewProviderGeoFeatureGroup> Gui::ViewProviderGeoFeatureGroupPython

◆ ViewProviderGroupExtensionPython

typedef ViewProviderExtensionPythonT<Gui::ViewProviderGroupExtension> Gui::ViewProviderGroupExtensionPython

◆ ViewProviderLinkPython

typedef ViewProviderPythonFeatureT<ViewProviderLink> Gui::ViewProviderLinkPython

◆ ViewProviderMaterialObjectPython

typedef ViewProviderPythonFeatureT<ViewProviderMaterialObject> Gui::ViewProviderMaterialObjectPython

◆ ViewProviderOriginGroupExtensionPython

typedef ViewProviderExtensionPythonT<Gui::ViewProviderOriginGroupExtension> Gui::ViewProviderOriginGroupExtensionPython

◆ ViewProviderPartPython

typedef ViewProviderPythonFeatureT<ViewProviderPart> Gui::ViewProviderPartPython

◆ ViewProviderPlacementPython

typedef ViewProviderPythonFeatureT<ViewProviderPlacement> Gui::ViewProviderPlacementPython

◆ ViewProviderPythonFeature

typedef ViewProviderPythonFeatureT<ViewProviderDocumentObject> Gui::ViewProviderPythonFeature

◆ ViewProviderPythonGeometry

typedef ViewProviderPythonFeatureT<ViewProviderGeometryObject> Gui::ViewProviderPythonGeometry

Enumeration Type Documentation

◆ HighlightMode

enum class Gui::HighlightMode

strong

highlight modes for the tree items

Enumerator
Underlined
Italic
Overlined
Bold
Blue
LightBlue
UserDefined

◆ ResolveMode

enum class Gui::ResolveMode

strong

Enumerator
NoResolve
OldStyleElement
NewStyleElement
FollowLink

◆ SelectionRole

enum Gui::SelectionRole

Enumerator
Inner
Outer
Split
Custom0
Custom1
Custom2

◆ TreeItemMode

enum class Gui::TreeItemMode

strong

highlight modes for the tree items

Enumerator
ExpandItem
ExpandPath
CollapseItem
ToggleItem

◆ ViewStatus

enum Gui::ViewStatus

Enumerator
UpdateData
Detach
isRestoring
UpdatingView
TouchDocument

Function Documentation

◆ addNodes()

void Gui::addNodes	(	Graph &	graph,
		std::map< SoNode *, Vertex > &	vertexNodeMap,
		SoNode *	node
	)

References addNodes().

Referenced by addNodes(), and Gui::ViewProvider::checkRecursion().

◆ BitmapFactory()

BitmapFactoryInst & Gui::BitmapFactory ( void )

Get the global instance.

References Gui::BitmapFactoryInst::instance().

◆ cmdAppDocument() [1/3]

template<typename T >

void Gui::cmdAppDocument	(	const App::Document *	doc,
		T &&	cmd
	)

Runs a command for accessing App.Document attribute or method This function is an alternative to FCMD_DOC_CMD.

Parameters

doc	pointer to a document
cmd	command string, streamable

See also: _cmdDocument()

Example:

cmdAppDocument(doc, std::stringstream() << "getObject('" << objName << "')");

Translates to command (assuming doc's name is 'DocName', and and objName contains value 'ObjName'):

App.getDocument('DocName').getObject('ObjName')

References Gui::Command::Doc.

Referenced by PartDesignGui::TaskDlgFeatureParameters::accept(), PartDesignGui::TaskPipeParameters::accept(), PartDesignGui::TaskDlgShapeBinder::accept(), CmdTestCmdFuncs::activated(), SpreadsheetGui::SheetView::confirmAliasChanged(), PartDesignGui::TaskDlgFeatureParameters::reject(), and PartDesignGui::TaskDlgShapeBinder::reject().

◆ cmdAppDocument() [2/3]

template<typename T >

void Gui::cmdAppDocument	(	const App::DocumentObject *	obj,
		T &&	cmd
	)

Runs a command for accessing an object's App::Document attribute or method This function is an alternative to FCMD_OBJ_DOC_CMD.

Parameters

obj	pointer to a DocumentObject
cmd	command string, streamable

References Gui::Command::Doc.

◆ cmdAppDocument() [3/3]

template<typename T >

void Gui::cmdAppDocument	(	const std::string &	doc,
		T &&	cmd
	)

Runs a command for accessing App.Document attribute or method This function is an alternative to FCMD_DOC_CMD.

Parameters

doc	document name
cmd	command string, streamable

See also: _cmdDocument()

Example:

cmdAppDocument(doc, std::stringstream() << "getObject('" << objName << "')");

Translates to command (assuming doc's name is 'DocName', and and objName contains value 'ObjName'):

App.getDocument('DocName').getObject('ObjName')

References Gui::Command::Doc.

◆ cmdAppDocumentArgs()

template<typename... Args>

void Gui::cmdAppDocumentArgs	(	const App::Document *	doc,
		const std::string &	cmd,
		Args &&...	args
	)

Runs a command for accessing a document's attribute or method.

Parameters

doc	pointer to a Document
cmd	command string, supporting printf like formatter

Example:

cmdAppDocumentArgs(obj, "addObject('%s')", "Part::Feature");

Translates to command (assuming obj's document name is 'DocName':

App.getDocument('DocName').addObject('Part::Feature')

References Base::Console(), Gui::Command::Doc, Base::ConsoleSingleton::Error(), and Gui::FormatString::toStr().

◆ cmdAppObject()

template<typename T >

void Gui::cmdAppObject	(	const App::DocumentObject *	obj,
		T &&	cmd
	)

Runs a command for accessing an document object's attribute or method This function is an alternative to FCMD_OBJ_CMD.

Parameters

obj	pointer to a DocumentObject
cmd	command string, streamable

See also: _cmdObject()

References Gui::Command::Doc.

Referenced by PartGui::TaskDlgAttacher::accept(), CmdTestCmdFuncs::activated(), cmdAppObjectHide(), and cmdAppObjectShow().

◆ cmdAppObjectArgs()

template<typename... Args>

void Gui::cmdAppObjectArgs	(	const App::DocumentObject *	obj,
		const std::string &	cmd,
		Args &&...	args
	)

Runs a command for accessing a document object's attribute or method This function is an alternative to FCMD_OBJ_CMD2.

Parameters

cmd	command string, supporting printf like formatter
obj	pointer to a DocumentObject

Example:

cmdAppObjectArgs(obj, "Visibility = %s", visible ? "True" : "False");

Translates to command (assuming obj's document name is 'DocName', obj's name is 'ObjName', and visible is true):

App.getDocument('DocName').getObject('ObjName').Visibility = True

References Base::Console(), Gui::Command::Doc, Base::ConsoleSingleton::Error(), and Gui::FormatString::toStr().

◆ cmdAppObjectHide()

void Gui::cmdAppObjectHide ( const App::DocumentObject * obj )

Hides an object.

References cmdAppObject().

Referenced by PartDesignGui::TaskDlgFeatureParameters::accept(), PartDesignGui::TaskDlgLoftParameters::accept(), PartDesignGui::TaskDlgSketchBasedParameters::accept(), and CmdTestCmdFuncs::activated().

◆ cmdAppObjectShow()

void Gui::cmdAppObjectShow ( const App::DocumentObject * obj )

Shows an object.

References cmdAppObject().

Referenced by CmdTestCmdFuncs::activated().

◆ cmdGuiDocument() [1/3]

template<typename T >

void Gui::cmdGuiDocument	(	const App::Document *	doc,
		T &&	cmd
	)

Runs a command for accessing App.Document attribute or method.

Parameters

doc	pointer to a document
cmd	command string, streamable

See also: _cmdDocument()

Example:

cmdGuiDocument(doc, std::stringstream() << "getObject('" << objName << "')");

Translates to command (assuming doc's name is 'DocName', and and objName contains value 'ObjName'):

Gui.getDocument('DocName').getObject('ObjName')

References Gui::Command::Gui.

Referenced by FemGui::TaskDlgPost::accept(), PartGui::TaskDlgAttacher::accept(), PartDesignGui::TaskDlgFeatureParameters::accept(), PartDesignGui::TaskPipeParameters::accept(), PartDesignGui::TaskDlgShapeBinder::accept(), CmdTestCmdFuncs::activated(), FemGui::TaskDlgPost::reject(), PartDesignGui::TaskDlgFeatureParameters::reject(), PartDesignGui::TaskDlgShapeBinder::reject(), and PartDesignGui::setEdit().

◆ cmdGuiDocument() [2/3]

template<typename T >

void Gui::cmdGuiDocument	(	const App::DocumentObject *	obj,
		T &&	cmd
	)

Runs a command for accessing an object's Gui::Document attribute or method This function is an alternative to FCMD_VOBJ_DOC_CMD.

Parameters

obj	pointer to a DocumentObject
cmd	command string, streamable

References Gui::Command::Gui.

◆ cmdGuiDocument() [3/3]

template<typename T >

void Gui::cmdGuiDocument	(	const std::string &	doc,
		T &&	cmd
	)

Runs a command for accessing App.Document attribute or method.

Parameters

doc	document name
cmd	command string, streamable

See also: _cmdDocument()

Example:

cmdGuiDocument(doc, std::stringstream() << "getObject('" << objName << "')");

Translates to command (assuming doc's name is 'DocName', and and objName contains value 'ObjName'):

Gui.getDocument('DocName').getObject('ObjName')

References Gui::Command::Gui.

◆ cmdGuiObject()

template<typename T >

void Gui::cmdGuiObject	(	const App::DocumentObject *	obj,
		T &&	cmd
	)

Runs a command for accessing an view object's attribute or method This function is an alternative to FCMD_VOBJ_CMD.

Parameters

obj	pointer to a DocumentObject
cmd	command string, streamable

See also: _cmdObject()

References Gui::Command::Gui.

Referenced by CmdTestCmdFuncs::activated(), and PartDesignGui::TaskPipeParameters::~TaskPipeParameters().

◆ cmdGuiObjectArgs()

template<typename... Args>

void Gui::cmdGuiObjectArgs	(	const App::DocumentObject *	obj,
		const std::string &	cmd,
		Args &&...	args
	)

Runs a command for accessing a view object's attribute or method This function is an alternative to FCMD_VOBJ_CMD2.

Parameters

cmd	command string, supporting printf like formatter
obj	pointer to a DocumentObject

See also: cmdAppObjectArgs()

References Base::Console(), Base::ConsoleSingleton::Error(), Gui::Command::Gui, and Gui::FormatString::toStr().

Referenced by CmdTestCmdFuncs::activated().

◆ cmdSetEdit()

void Gui::cmdSetEdit	(	const App::DocumentObject *	obj,
		int	mod = `0`
	)

Runs a command to start editing a give object This function is an alternative to FCMD_SET_EDIT.

Parameters

obj	pointer to a DocumentObject

Unlike other helper functions, this one editing the object using the current active document, instead of the object's owner document. This allows in-place editing an object, which may be brought in through linking to an external group.

References Gui::Command::Gui.

Referenced by CmdTestCmdFuncs::activated().

◆ coinRemoveAllChildren()

void Gui::coinRemoveAllChildren ( SoGroup * node )

Helper function to deal with bug in SoNode::removeAllChildren()

See also: https://bitbucket.org/Coin3D/coin/pull-requests/119/fix-sochildlist-auditing/diff

References coinRemoveAllChildren().

◆ Control()

ControlSingleton & Gui::Control ( void )

Get the global instance.

References Gui::ControlSingleton::instance().

◆ copyVisualT()

template<typename... Args>

void Gui::copyVisualT ( Args &&... args )

Copy visual attributes from a source to a target object.

Referenced by CmdTestCmdFuncs::activated().

◆ CreateDocCommands()

void Gui::CreateDocCommands ( void )

References Gui::CommandManager::addCommand(), Gui::Application::commandManager(), and Gui::Application::Instance.

Referenced by Gui::Application::createStandardOperations().

◆ CreateFeatCommands()

void Gui::CreateFeatCommands ( void )

References Gui::CommandManager::addCommand(), Gui::Application::commandManager(), and Gui::Application::Instance.

Referenced by Gui::Application::createStandardOperations().

◆ CreateLinkCommands()

void Gui::CreateLinkCommands ( void )

References Gui::CommandManager::addCommand(), Gui::Application::commandManager(), and Gui::Application::Instance.

Referenced by Gui::Application::createStandardOperations().

◆ CreateMacroCommands()

void Gui::CreateMacroCommands ( void )

References Gui::CommandManager::addCommand(), Gui::Application::commandManager(), and Gui::Application::Instance.

Referenced by Gui::Application::createStandardOperations().

◆ CreateStdCommands()

void Gui::CreateStdCommands ( void )

References Gui::CommandManager::addCommand(), Gui::Application::commandManager(), and Gui::Application::Instance.

Referenced by Gui::Application::createStandardOperations().

◆ CreateStructureCommands()

void Gui::CreateStructureCommands ( void )

References Gui::CommandManager::addCommand(), Gui::Application::commandManager(), and Gui::Application::Instance.

Referenced by Gui::Application::createStandardOperations().

◆ CreateTestCommands()

void Gui::CreateTestCommands ( void )

References Gui::CommandManager::addCommand(), Gui::Application::commandManager(), and Gui::Application::Instance.

Referenced by Gui::Application::createStandardOperations().

◆ CreateViewStdCommands()

void Gui::CreateViewStdCommands ( void )

References Gui::CommandManager::addCommand(), Gui::Application::commandManager(), App::GetApplication(), App::Application::GetParameterGroupByPath(), Gui::Application::Instance, and ParameterGrp::SetASCII().

Referenced by Gui::Application::createStandardOperations().

◆ CreateWindowStdCommands()

void Gui::CreateWindowStdCommands ( void )

References Gui::CommandManager::addCommand(), Gui::Application::commandManager(), and Gui::Application::Instance.

Referenced by Gui::Application::createStandardOperations().

◆ cursorBeyond()

bool Gui::cursorBeyond	(	const QTextCursor &	cursor,
		const QTextCursor &	limit,
		int	shift = `0`
	)

cursorBeyond checks if cursor is at a valid position to accept keyEvents.

Parameters

cursor	- cursor to check
limit	- cursor that marks the begin of the input region
shift	- offset for shifting the limit for non-selection cursors [default: 0]

Returns: true if a keyEvent is ok at cursor's position, false otherwise

Referenced by Gui::PythonConsole::contextMenuEvent(), and Gui::PythonConsole::keyPressEvent().

◆ doCommandT()

template<typename... Args>

void Gui::doCommandT	(	Gui::Command::DoCmd_Type	cmdType,
		const std::string &	cmd,
		Args &&...	args
	)

Runs a command.

Parameters

cmdType	command type
cmd	command string, supporting printf like formatter

Example:

doCommandT(Gui::Command::Gui, "Gui.getDocument(%s).getObject(%s).Visibility = %s", "DocName", "ObjName", visible?"True":"False");

Translates to command (assuming obj's document name is 'DocName', obj's name is 'ObjName', and visible is true):

Gui.getDocument('DocName').getObject('ObjName').Visibility = True

References Base::Console(), Base::ConsoleSingleton::Error(), and Gui::FormatString::toStr().

Referenced by CmdTestCmdFuncs::activated().

◆ FreeCADGui_exportSubgraph()

static PyObject * Gui::FreeCADGui_exportSubgraph	(	PyObject *	,
		PyObject *	args
	)

static

References Base::InterpreterSingleton::convertSWIGPointerObj(), Base::Interpreter(), Gui::SoFCDB::writeNodesToString(), and Gui::SoFCDB::writeToVRML().

◆ FreeCADGui_getSoDBVersion()

static PyObject * Gui::FreeCADGui_getSoDBVersion	(	PyObject *	,
		PyObject *	args
	)

static

◆ FreeCADGui_subgraphFromObject()

static PyObject * Gui::FreeCADGui_subgraphFromObject	(	PyObject *	,
		PyObject *	args
	)

static

References Base::Type::createInstanceByName(), Base::InterpreterSingleton::createSWIGPointerObj(), Base::Persistence::getClassTypeId(), Base::Persistence::getTypeId(), App::DocumentObject::getViewProviderName(), and Base::Interpreter().

◆ getMainWindow()

MainWindow * Gui::getMainWindow ( )

References Gui::MainWindow::getInstance().

◆ getPyTypeObjectForTypeName()

template<typename qttype >

PyTypeObject * Gui::getPyTypeObjectForTypeName ( )

◆ GetWidgetFactorySupplier()

WidgetFactorySupplier & Gui::GetWidgetFactorySupplier ( )

Referenced by Gui::Application::Application(), and Gui::Dialog::DlgCustomizeImp::DlgCustomizeImp().

◆ OpenURLInBrowser()

bool Gui::OpenURLInBrowser ( const char * URL )

opens a URL in the system Browser

References getMainWindow().

Referenced by StdCmdOnlineHelpWebsite::activated(), StdCmdFreeCADDonation::activated(), StdCmdFreeCADWebsite::activated(), StdCmdFreeCADUserHub::activated(), StdCmdFreeCADPowerUserHub::activated(), StdCmdFreeCADForum::activated(), StdCmdFreeCADFAQ::activated(), StdCmdPythonWebsite::activated(), and StdCmdReportBug::activated().

◆ promptEnd()

static const QChar Gui::promptEnd ( QLatin1Char(' ') )

static

Referenced by promptLength().

◆ promptLength()

int Gui::promptLength ( const QString & lineStr )

References promptEnd().

Referenced by Gui::PythonConsole::inputBegin(), and stripPromptFrom().

◆ PROPERTY_SOURCE_TEMPLATE()

Gui::PROPERTY_SOURCE_TEMPLATE	(	PartDesignGui::ViewProviderSubShapeBinderPython	,
		PartDesignGui::ViewProviderSubShapeBinder
	)

◆ qt_getCppPointer()

void * Gui::qt_getCppPointer	(	const Py::Object &	pyobject,
		const char *	shiboken,
		const char *	unwrap
	)

Referenced by Gui::PythonWrapper::toQGraphicsItem(), Gui::PythonWrapper::toQGraphicsObject(), and Gui::PythonWrapper::toQObject().

◆ qt_identifyType()

const char * Gui::qt_identifyType	(	QObject *	ptr,
		const char *	pyside
	)

Referenced by Gui::PythonWrapper::createChildrenNameAttributes().

◆ qt_wrapInstance()

template<typename qttype >

Py::Object Gui::qt_wrapInstance	(	qttype	object,
		const char *	className,
		const char *	shiboken,
		const char *	pyside,
		const char *	wrap
	)

◆ schemaTranslatePoint()

std::array< std::pair< double, std::string >, 3 > Gui::schemaTranslatePoint	(	double	x,
		double	y,
		double	z,
		double	precision
	)

References Base::Quantity::MilliMetre, Base::UnitsApi::schemaTranslate(), and Base::Quantity::setValue().

Referenced by Gui::SoFCSelection::handleEvent(), and Gui::SelectionSingleton::setPreselectCoord().

◆ Selection()

SelectionSingleton & Gui::Selection ( void )

Get the global instance.

References Selection().

◆ stripPromptFrom()

QString Gui::stripPromptFrom ( const QString & lineStr )

References promptLength().

Referenced by Gui::PythonConsole::createMimeDataFromSelection(), and Gui::PythonConsole::keyPressEvent().

◆ validateInput()

bool Gui::validateInput	(	QWidget *	parent,
		const QString &	input
	)

Referenced by Gui::Dialog::ParameterValue::onCreateBoolItem(), Gui::Dialog::ParameterValue::onCreateFloatItem(), Gui::Dialog::ParameterValue::onCreateIntItem(), Gui::Dialog::ParameterGroup::onCreateSubgroup(), Gui::Dialog::ParameterValue::onCreateTextItem(), Gui::Dialog::ParameterValue::onCreateUIntItem(), Gui::Dialog::ParameterGroupItem::setData(), Gui::Dialog::ParameterValueItem::setData(), and Gui::QuantitySpinBoxPrivate::validate().

◆ WidgetFactory()

WidgetFactoryInst & Gui::WidgetFactory ( )

References Gui::WidgetFactoryInst::instance().

Referenced by Gui::Dialog::DlgCustomizeImp::DlgCustomizeImp().

◆ WorkbenchFactory()

WorkbenchFactoryInst & Gui::WorkbenchFactory ( )

References Gui::WorkbenchFactoryInst::instance().

Variable Documentation

◆ FreeCADGui_methods

struct PyMethodDef Gui::FreeCADGui_methods[]

Initial value:

= {
    {"subgraphFromObject",FreeCADGui_subgraphFromObject,METH_VARARGS,
     "subgraphFromObject(object) -> Node\n\n"
     "Return the Inventor subgraph to an object"},
    {"exportSubgraph",FreeCADGui_exportSubgraph,METH_VARARGS,
     "exportSubgraph(Node, File or Buffer, [Format='VRML']) -> None\n\n"
     "Exports the sub-graph in the requested format"
     "The format string can be VRML or IV"},
    {"getSoDBVersion",FreeCADGui_getSoDBVersion,METH_VARARGS,
     "getSoDBVersion() -> String\n\n"
     "Return a text string containing the name\n"
     "of the Coin library and version information"},
    {nullptr, nullptr, 0, nullptr}  
}

Referenced by Gui::Application::Application().

◆ ViewProviderPythonFeatureT< ViewProviderSheet >

template class SpreadsheetGuiExport Gui::ViewProviderPythonFeatureT< ViewProviderSheet >

◆ XPM_pixel_data

const unsigned char Gui::XPM_pixel_data[21 *27 *4+1]

static

◆ YPM_pixel_data

const unsigned char Gui::YPM_pixel_data[21 *27 *4+1]

static

◆ ZPM_pixel_data

const unsigned char Gui::ZPM_pixel_data[21 *27 *4+1]

static

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ CheckListItem

◆ DocumentObjectDataPtr

◆ Edge

◆ Graph

◆ LinkInfoPtr

◆ Node_ObjectPtr

◆ SoFCSelectionContextBasePtr

◆ SoFCSelectionContextExPtr

◆ SoFCSelectionContextPtr

◆ TStringList

◆ TStringMap

◆ Vertex

◆ ViewProviderDocumentObjectGroupPython

◆ ViewProviderExtensionPython

◆ ViewProviderGeoFeatureGroupExtensionPython

◆ ViewProviderGeoFeatureGroupPython

◆ ViewProviderGroupExtensionPython

◆ ViewProviderLinkPython

◆ ViewProviderMaterialObjectPython

◆ ViewProviderOriginGroupExtensionPython

◆ ViewProviderPartPython

◆ ViewProviderPlacementPython

◆ ViewProviderPythonFeature

◆ ViewProviderPythonGeometry

Enumeration Type Documentation

◆ HighlightMode

◆ ResolveMode

◆ SelectionRole

◆ TreeItemMode

◆ ViewStatus

Function Documentation

◆ addNodes()

◆ BitmapFactory()

◆ cmdAppDocument() [1/3]

◆ cmdAppDocument() [2/3]

◆ cmdAppDocument() [3/3]

◆ cmdAppDocumentArgs()

◆ cmdAppObject()

◆ cmdAppObjectArgs()

◆ cmdAppObjectHide()

◆ cmdAppObjectShow()

◆ cmdGuiDocument() [1/3]

◆ cmdGuiDocument() [2/3]

◆ cmdGuiDocument() [3/3]

◆ cmdGuiObject()

◆ cmdGuiObjectArgs()

◆ cmdSetEdit()

◆ coinRemoveAllChildren()

◆ Control()

◆ copyVisualT()

◆ CreateDocCommands()

◆ CreateFeatCommands()

◆ CreateLinkCommands()

◆ CreateMacroCommands()

◆ CreateStdCommands()

◆ CreateStructureCommands()

◆ CreateTestCommands()

◆ CreateViewStdCommands()

◆ CreateWindowStdCommands()

◆ cursorBeyond()

◆ doCommandT()

◆ FreeCADGui_exportSubgraph()

◆ FreeCADGui_getSoDBVersion()

◆ FreeCADGui_subgraphFromObject()

◆ getMainWindow()

◆ getPyTypeObjectForTypeName()

◆ GetWidgetFactorySupplier()

◆ OpenURLInBrowser()

◆ promptEnd()

◆ promptLength()

◆ PROPERTY_SOURCE_TEMPLATE()

◆ qt_getCppPointer()