FPDoc Onlineexperiment

TLazarusFileDialogForm class

In unit LazDialogs

Implements the form displayed for TLazOpenDialog descendants.

Declaration

pascal

TLazarusFileDialogForm = class(TForm)

Inheritance

Description

TLazarusFileDialogForm is a TForm descendant which implements the form displayed for dialogs which are not wrappers for native dialogs on a given platform. The form includes private members that are used to store input or output values for the dialog, like:

FileName
Filter
Title

It includes public user interface elements needed for the dialog form. The active UI elements are determined by the TLazFileDialogKind value passed as an argument when a dialog calls the Initialize method for the form. The UI elements include:

ShellTreeView (TShellTreeView)
ShellListView (TShellListView)
SaveEdit (TEdit)
FilterComboBox (TFilterComboBox)
ButtonPanel (TButtonPanel)

TLazarusFileDialogForm includes methods that implement routines assigned to event handlers in the various UI elements. The routines perform actions like setting the ModalResult value when a button is clicked, updating FileName from selected nodes in the shell controls, and enabling / disabling controls as needed.

TLazarusFileDialogForm is used to implement the private form member in the TLazOpenDialog component.

See also

Methods

`CreateNew`	public	Alternate constructor for the class instance.
`Initialize`	public	Creates and positions child controls on the Lazarus dialog form.
`HandleOkClick`	public	Event handler signalled when the OK button is clicked.
`HandleCancelClick`	public	Event handler signalled when the Cancel button is clicked.
`HandleCloseQuery`	public	Event handler for an OnCloseQuery event notification.
`HandleEditChange`	public	Event handler for changes to the value in the SaveEdit control.
`HandleSelectItem`	public	Event handler for changes to the selected item in ShellListView.
`HandleTreeViewSelectionChanged`	public	Event handler signalled when the selected item in ShellTreeView is changed.

Fields

`ButtonPanel`	public	Button panel for the Lazarus dialog form.
`ShellTreeView`	public	Shell tree view control for the Lazarus dialog form.
`ShellListView`	public	Shell list view control for the Lazarus dialog form.
`SaveEdit`	public	Edit control used for a FileName on the dialog form.
`FilterComboBox`	public	Combo box control used for the file mask filter in the Lazarus dialog form.

Inherited

From TForm (106)

Action ActiveControl Align AllowDropFiles AlphaBlend AlphaBlendValue Anchors ArrangeIcons AutoScroll AutoSize BiDiMode BorderIcons BorderStyle BorderWidth Caption Cascade ChildSizing ClientHandle ClientHeight ClientWidth Color Constraints Create CreateWnd DefaultMonitor DesignTimePPI DockManager DockSite DoubleBuffered DragKind DragMode Enabled Font FormStyle HelpFile Icon KeyPreview LCLVersion Loaded Menu Next OnActivate OnChangeBounds OnClick OnClose OnCloseQuery OnConstrainedResize OnContextPopup OnCreate OnDblClick OnDeactivate OnDestroy OnDockDrop OnDockOver OnDragDrop OnDragOver OnDropFiles OnEndDock OnGetSiteInfo OnHelp OnHide OnKeyDown OnKeyPress OnKeyUp OnMouseDown OnMouseEnter OnMouseLeave OnMouseMove OnMouseUp OnMouseWheel OnMouseWheelDown OnMouseWheelHorz OnMouseWheelLeft OnMouseWheelRight OnMouseWheelUp OnPaint OnResize OnShortCut OnShow OnShowHint OnStartDock OnUnDock OnUTF8KeyPress OnWindowStateChange ParentBiDiMode ParentDoubleBuffered ParentFont PixelsPerInch PopupMenu PopupMode PopupParent Position Previous Scaled ScreenSnap SessionProperties ShowHint ShowInTaskBar SnapBuffer SnapOptions Tile TileMode UseDockManager Visible WindowState WSRegisterClass

From TCustomForm (134)

Activate Active ActiveChanged ActiveDefaultControl ActiveMDIChild AddHandlerClose AddHandlerCreate AddHandlerFirstShow AdjustClientRect AfterConstruction AllAutoSized AutoScale AutoSizeDelayedHandle BeforeDestruction BeginAutoDrag BeginFormUpdate BigIconHandle CalculatePreferredSize CancelControl CanFocus ChildHandlesCreated Close CloseQuery CMActionExecute CMActionUpdate CMActivate CMAppShowBtnGlyphChanged CMAppShowMenuGlyphChanged CMBiDiModeChanged CMDeactivate CMIconChanged CMParentBiDiModeChanged CMRelease CMShowingChanged ColorIsStored ConstrainedResize CreateParams Deactivate DefaultControl DefocusControl Designer Destroy DestroyWnd DoAddActionList DoAutoSize Dock DoClose DoCreate DoDestroy DoDock DoExecuteAction DoFirstShow DoHide DoOnChangeBounds DoOnResize DoRemoveActionList DoShow DoShowWindow DoUpdateAction EffectiveShowInTaskBar EndFormUpdate EnsureVisible FocusControl FormIsUpdating FormState GetChildren GetControlClassDefaultSize GetDefaultDockCaption GetFloating GetFormImage GetMDIChildren GetPreferredSize GetRealPopupParent GetRolesForControl HandleCreateException HandleDestroyException HandleShowHideException Hide InitializeWnd IntfDropFiles IntfHelp IsShortcut LastActiveControl MakeFullyVisible MDIChildCount MDIChildren ModalResult Monitor MoveToDefaultPosition Notification OnShowModalFinished PaintWindow ProcessResource Release RemoveAllHandlersOfObject RemoveHandlerClose RemoveHandlerCreate RemoveHandlerFirstShow RequestAlign Resizing RestoredHeight RestoredLeft RestoredTop RestoredWidth SetAutoScroll SetAutoSize SetFocus SetFocusedControl SetParent SetRestoredBounds SetScaled SetVisible SetZOrder Show ShowModal ShowOnTop SmallIconHandle UpdateActions UpdateDockCaption UpdateShowing UpdateWindowState VisibleChanged VisibleChanging VisibleIsStored WantChildKey WMActivate WMCloseQuery WMDPIChanged WMHelp WMShowWindow WMSize WMWindowPosChanged WMWindowPosChanging WndProc

From TCustomDesignControl (2)

AutoAdjustLayout DoAutoAdjustLayout

From TScrollingWinControl (16)

AlignControls AutoScrollEnabled CalculateAutoRanges ClientToScreen ComputeScrollbars GetClientScrollOffset GetLogicalClientRect GetPreferredSizeClientFrame HorzScrollBar ScreenToClient ScrollBy ScrollInView UpdateScrollbars VertScrollBar WMHScroll WMVScroll

From TCustomControl (5)

Canvas FontChanged Paint SetColor WMPaint

From TWinControl (197)

AddControl AutoSizeDelayed AutoSizeDelayedReport AutoSizePhases BeginUpdateBounds BoundsLockCount BroadCast Brush BrushCreated CachedClientHeight CachedClientWidth CanSetFocus CanTab ChangeScale ChildClassAllowed ChildKey ClientRectNeedsInterfaceUpdate CMBorderChanged CMDoubleBufferedChanged CMEnabledChanged CMEnter CMExit CMParentDoubleBufferedChanged CMShowHintChanged CMVisibleChanged CNChar CNKeyDown CNKeyUp CNSysKeyDown CNSysKeyUp ContainsControl ControlAtPos ControlCount ControlKeyDown ControlKeyUp Controls ControlsAligned CreateBrush CreateDockManager CreateHandle CreateParented CreateParentedControl CreateSubClass CustomAlignInsertBefore CustomAlignPosition DefaultHandler DefWndProc DesignerDeleting DestroyHandle DialogChar DisableAlign DoAddDockClient DoAdjustClientRectChange DoAlignChildControls DoAllAutoSize DoChildSizingChange DockClientCount DockClients DockDrop DockOver DoConstraintsChange DoDockClientMsg DoDockOver DoDragMsg DoEnter DoExit DoFlipChildren DoFloatMsg DoGetDockCaption DoKeyDownBeforeInterface DoKeyPress DoKeyUpBeforeInterface DoRemainingKeyDown DoRemainingKeyUp DoRemoveDockClient DoSendBoundsToInterface DoSendShowHideToInterface DoSetBounds DoUnDock DoUndockClientMsg DoUTF8KeyPress EnableAlign EndUpdateBounds EraseBackground FinalizeWnd FindChildControl FindNextControl FixDesignFontsPPIWithChildren FixupTabList FlipChildren Focused FormEndUpdated GetAdjustedLogicalClientRect GetBorderStyle GetChildrenRect GetClientOrigin GetClientRect GetControlIndex GetControlOrigin GetDeviceContext GetDockCaption GetEnumeratorControls GetEnumeratorControlsReverse GetMouseCapture GetParentHandle GetSiteInfo GetTabOrderList GetTextLen GetTopParentHandle Handle HandleAllocated HandleNeeded InsertControl IntfGetDropFilesTarget IntfUTF8KeyPress Invalidate InvalidateBoundsRealized InvalidateClientRectCache InvalidatePreferredChildSizes IsClientHeightStored IsClientWidthStored IsControlMouseMsg IsFlipped IsResizing IsSpecialSubControl KeyDown KeyDownAfterInterface KeyDownBeforeInterface KeyPress KeyUp KeyUpAfterInterface KeyUpBeforeInterface LockRealizeBounds MainWndProc NotifyControls OnAlignInsertBefore OnAlignPosition OnEnter OnExit OnGetDockCaption PaintControls PaintHandler PaintTo ParentFormHandleInitialized ParentHandlesAllocated ParentWindow PerformTab RealGetText ReAlign RealizeBounds RealizeBoundsRecursive RealSetText ReloadDockedControl RemoveControl RemoveFocus Repaint ScaleBy ScaleControls ScrollBy_WS SelectFirst SelectNext SendDialogChar SendMoveSizeMessages SetBorderStyle SetBounds SetChildZPosition SetControlIndex SetDockManager SetShape SetTempCursor ShowControl Showing TabOrder TabStop UnlockRealizeBounds Update UpdateControlState UTF8KeyPress VisibleDockClientCount WindowHandle WMChar WMContextMenu WMDestroy WMEnter WMEraseBkgnd WMExit WMKeyDown WMKeyUp WMKillFocus WMMove WMNotify WMSetFocus WMSysChar WMSysKeyDown WMSysKeyUp WriteLayoutDebugReport WSSetText

From TControl (295)

AccessibleDescription AccessibleName AccessibleRole AccessibleValue ActionChange ActionLink ActiveDefaultControlChanged AddHandler AddHandlerOnBeforeDestruction AddHandlerOnChangeBounds AddHandlerOnEnabledChanged AddHandlerOnEnabledChanging AddHandlerOnKeyDown AddHandlerOnMouseWheel AddHandlerOnResize AddHandlerOnVisibleChanged AddHandlerOnVisibleChanging AdjustSize AnchorAsAlign AnchorClient AnchoredControlCount AnchoredControls AnchorHorizontalCenterTo AnchorParallel AnchorSame AnchorSide AnchorSideBottom AnchorSideChanged AnchorSideLeft AnchorSideRight AnchorSideTop AnchorToCompanion AnchorToNeighbour AnchorVerticalCenterTo AssignTo AutoSizing AutoSizingAll AutoSizingLockCount BaseBounds BaseParentClientSize BeforeDragStart BeginAutoSizing BeginDrag BorderSpacing BoundsChanged BoundsRect BoundsRectForNewParent BringToFront CalculateDockSizes CanAutoSize CaptureChanged CaptureMouseButtons ChangeBounds Changed CheckChildClassAllowed CheckNewParent CheckOnChangeBounds Click ClientOrigin ClientRect ClientToParent CMChanged CMCursorChanged CMHintShow CMHitTest CMMouseEnter CMMouseLeave CMParentColorChanged CMParentFontChanged CMParentShowHintChanged CMSysFontChanged CMTextChanged CNPreferredSizeChanged ControlFontClass ControlOrigin ControlState ControlStyle ControlToScreen CreateAccessibleObject CreateControlBorderSpacing CreateFloatingDockSite Cursor DblClick DefineProperties DesktopFont DisableAutoSizing DoBorderSpacingChange DoCallKeyEventHandler DoCallMouseWheelEventHandler DoCallNotifyHandler Docked DockOrientation DockTrackNoTarget DoContextPopup DoEndDock DoEndDrag DoFixDesignFontPPI DoMouseDown DoMouseUp DoMouseWheel DoMouseWheelDown DoMouseWheelHorz DoMouseWheelLeft DoMouseWheelRight DoMouseWheelUp DoOnParentHandleDestruction DoOnShowHint DoScaleFontPPI DoStartDock DoStartDrag DragCanceled DragCursor DragDrop Dragging DragOver EditingDone EnableAutoSizing EnabledChanged EnabledChanging EndAutoSizing EndDrag ExecuteCancelAction ExecuteDefaultAction FindSubComponent FixDesignFontsPPI Floating FloatingDockSiteClass ForeignAnchorSideChanged GetAccessibleObject GetAction GetActionLinkClass GetAnchorsDependingOnParent GetCachedText GetCanvasScaleFactor GetChildAccessibleObjectAtPos GetColorResolvingParent GetCursor GetDefaultColor GetDefaultHeight GetDefaultWidth GetDockEdge GetDragImages GetEnabled GetFloatingDockSiteClass GetMousePosFromMessage GetPalette GetParentBackground GetParentComponent GetPopupMenu GetRGBColorResolvingParent GetScrolledClientRect GetSelectedChildAccessibleObject GetSidePosition GetTextBuf GetTopParent HandleObjectShouldBeVisible HasHelp HasParent Height HeightIsAnchored HelpContext HelpKeyword HelpType Hint HostDockSite InitiateAction InvalidateControl InvalidatePreferredSize IsAParentAligning IsBorderSpacingInnerBorderStored IsCaptionStored IsControl IsControlVisible IsEnabled IsParentColor IsParentFont IsParentOf IsProcessingPaintMsg IsRightToLeft IsVisible Left LMCaptureChanged LoadedAll LRDockWidth ManualDock ManualFloat MouseCapture MouseDown MouseEnter MouseInClient MouseLeave MouseMove MouseUp OnEditingDone OnEndDrag OnQuadClick OnStartDrag OnTripleClick Parent ParentBackground ParentColor ParentDestroyingHandle ParentFontChanged ParentShowHint ParentToClient Perform PositionDockRect QuadClick ReadBounds ReadState Refresh RemoveHandler RemoveHandlerOnBeforeDestruction RemoveHandlerOnChangeBounds RemoveHandlerOnEnabledChanged RemoveHandlerOnEnabledChanging RemoveHandlerOnKeyDown RemoveHandlerOnMouseWheel RemoveHandlerOnResize RemoveHandlerOnVisibleChanged RemoveHandlerOnVisibleChanging ReplaceDockedControl Resize Scale96ToFont Scale96ToForm Scale96ToScreen ScaleConstraints ScaleDesignToForm ScaleFontsPPI ScaleFontTo96 ScaleFontToScreen ScaleFormTo96 ScaleFormToDesign ScaleScreenTo96 ScaleScreenToFont ScreenToControl SendToBack SetAction SetAlign SetAnchors SetBiDiMode SetBoundsKeepBase SetCursor SetDragMode SetEnabled SetHint SetInitialBounds SetName SetParentBackground SetParentBiDiMode SetParentComponent SetTextBuf ShouldAutoAdjust ShowHelp TBDockHeight Text TextChanged Top TripleClick UndockHeight UndockWidth UpdateAnchorRules UpdateBaseBounds UpdateMouseCursor UpdateRolesForForm UseRightToLeftAlignment UseRightToLeftReading UseRightToLeftScrollBar Width WidthIsAnchored WindowProc WMCancelMode WMLButtonDBLCLK WMLButtonDown WMLButtonQuadCLK WMLButtonTripleCLK WMLButtonUp WMMButtonDBLCLK WMMButtonDown WMMButtonQuadCLK WMMButtonTripleCLK WMMButtonUp WMMouseHWheel WMMouseMove WMMouseWheel WMRButtonDBLCLK WMRButtonDown WMRButtonQuadCLK WMRButtonTripleCLK WMRButtonUp WMXButtonDBLCLK WMXButtonDown WMXButtonQuadCLK WMXButtonTripleCLK WMXButtonUp

From TLCLComponent (6)

DecLCLRefCount GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance WidgetSetClass

From TComponent (64)

_AddRef _Release CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetTypeInfo GetTypeInfoCount iicrGetComponent InsertComponent Invoke IsImplementorOf Loading Name ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (4)

Assign FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (34)

CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.