UIX_CreateObjParams Structure
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
(6 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:UIX_CreateObjParams Structure}} | {{#customTitle:UIX_CreateObjParams Structure}} | ||
+ | {{#parentPage:PXV:UIX_Structures|UIX_CreateObjParams|structure}} | ||
+ | {{ToReview}} | ||
− | Specifies the | + | Specifies the parameters for the [[PXV:IUIX_Obj|IUIX_Obj]] creation. |
== Syntax == | == Syntax == | ||
Line 8: | Line 11: | ||
{ | { | ||
IUIX_Obj* pParent; | IUIX_Obj* pParent; | ||
− | HANDLE_T hWndParent; | + | HANDLE_T hWndParent; |
IUnknown* pImpl; | IUnknown* pImpl; | ||
− | LONG nStdClass; | + | LONG nStdClass; |
− | LONGLONG nObjStyle; | + | LONGLONG nObjStyle; |
− | LONGLONG nCreateFlags; | + | LONGLONG nCreateFlags; |
− | LPWSTR pThemeClassID; | + | LPWSTR pThemeClassID; |
− | RECT rc; | + | RECT rc; |
− | LPSTR pDlgTemplates; | + | LPSTR pDlgTemplates; |
− | LONG cbDlgTemplates; | + | LONG cbDlgTemplates; |
− | LPWSTR pID; | + | LPWSTR pID; |
− | HANDLE_T hWnd; | + | HANDLE_T hWnd; |
− | LONG nInsertBefore; | + | LONG nInsertBefore; |
− | LONG nWndStyle; | + | LONG nWndStyle; |
− | LONG nWndStyleEx; | + | LONG nWndStyleEx; |
− | LPWSTR pWndClassName; | + | LPWSTR pWndClassName; |
}; | }; | ||
</pre> | </pre> | ||
Line 28: | Line 31: | ||
== Members == | == Members == | ||
;pParent | ;pParent | ||
− | : Pointer to [[PXV:IUIX_Obj|IUIX_Obj]] . | + | : Pointer to [[PXV:IUIX_Obj|IUIX_Obj]] containing the parent object or window. Can be used in place of the ''hWndParent'' |
;hWndParent | ;hWndParent | ||
− | : Value of HANDLE_T . | + | : Value of HANDLE_T containing the parent window handle. Can be used in place of the ''pParent'' |
;pImpl | ;pImpl | ||
− | : Pointer to IUnknown* | + | : Pointer to IUnknown* containing the [[PXV:IUIX_ObjImpl|custom event handler]]. |
;nStdClass | ;nStdClass | ||
− | : Value of LONG | + | : Value of LONG containing the [[PXV:UIX_StdClasses|standard class ID]] such as Button, Edit, List etc. |
;nObjStyle | ;nObjStyle | ||
− | : Value of LONGLONG | + | : Value of LONGLONG containing the [[PXV:UIX_ObjStyleFlags|style flags]] of the new object. |
;nCreateFlags | ;nCreateFlags | ||
− | : Value of LONGLONG | + | : Value of LONGLONG special [[PXV:UIX_CreateObjFlags|creation flags]] to create windowed/windowless, child/popup/modal, scrollable, etc. |
;pThemeClassID | ;pThemeClassID | ||
− | : Value of LPWSTR . | + | : Value of LPWSTR containing the ID of the theme class (is optional). Can be of next values: |
+ | * "Dialog", | ||
+ | * "Button", | ||
+ | * "ScrollBar", | ||
+ | * "ScrollContainer", | ||
+ | * "Edit", | ||
+ | * "List", | ||
+ | * "Label", | ||
+ | * "PopupContainer", | ||
+ | * "ComboButton", | ||
+ | * "Combo", | ||
+ | * "Picture", | ||
+ | * "OriginSelector", | ||
+ | * "ControlsLock", | ||
+ | * "Group", | ||
+ | * "Frame", | ||
+ | * "Layout", | ||
+ | * "Spin", | ||
+ | * "Tooltip", | ||
+ | * "CmdBar", | ||
+ | * "CmdPane", | ||
+ | * "Tree", | ||
+ | * "Ruler", | ||
+ | * "Slider", | ||
+ | * "IndexNavigator", | ||
+ | * "ColorPicker", | ||
+ | * "PropSheetPage", | ||
+ | * "PropSheets", | ||
+ | * "CmdColorBtn", | ||
+ | * "Progress", | ||
+ | * "GuideLinesBtn", | ||
+ | * "InfoBtn", | ||
+ | * "PropList", | ||
+ | * "RangesNavigator", | ||
+ | * "IndProgress", | ||
+ | * "ToggleBtn", | ||
;rc | ;rc | ||
− | : Value of RECT | + | : Value of RECT containing the Object's rectangle, relative to parent ('''required'''). |
;pDlgTemplates | ;pDlgTemplates | ||
− | : Value of LPSTR . | + | : Value of LPSTR containing the template of the dialog if the dialog is being created. Required if (nStdClass == UIX_StdClass_Dialog). |
;cbDlgTemplates | ;cbDlgTemplates | ||
− | : Value of LONG | + | : Value of LONG containing the number of bytes pointed by pDlgTemplates. |
;pID | ;pID | ||
− | : Value of LPWSTR . | + | : Value of LPWSTR containing the ID of the dialog. Required if (nStdClass == UIX_StdClass_Dialog) AND pDlgTemplates is collection of dialogs' templates. |
;hWnd | ;hWnd | ||
− | : Value of HANDLE_T . | + | : Value of HANDLE_T used for subclassing of existing window, requires valid pImpl. (Optional) |
;nInsertBefore | ;nInsertBefore | ||
− | : Value of LONG | + | : Value of LONG used if UIX_CreateObj_InsertBefore flag is specified. |
;nWndStyle | ;nWndStyle | ||
− | : Value of LONG . | + | : Value of LONG containing the style flags of the window. Used for new windowed object creation (if the UIX_CreateObj_Windowed is specified). |
;nWndStyleEx | ;nWndStyleEx | ||
− | : Value of LONG . | + | : Value of LONG containing the styleEx flags of the window. Used for new windowed object creation (if the UIX_CreateObj_Windowed is specified). |
;pWndClassName | ;pWndClassName | ||
− | : Value of LPWSTR . | + | : Value of LPWSTR containing window's class name. Used for new windowed object creation (if the UIX_CreateObj_Windowed is specified). |
== See Also == | == See Also == | ||
− | + | [[PXV:IUIX_Inst_CreateObj|IUIX_Inst::CreateObj]], [[PXV:IUIX_Inst_CreateScrollableObj|IUIX_Inst::CreateScrollableObj]] |
Latest revision as of 01:12, 24 April 2017
Specifies the parameters for the IUIX_Obj creation.
Syntax
struct UIX_CreateObjParams { IUIX_Obj* pParent; HANDLE_T hWndParent; IUnknown* pImpl; LONG nStdClass; LONGLONG nObjStyle; LONGLONG nCreateFlags; LPWSTR pThemeClassID; RECT rc; LPSTR pDlgTemplates; LONG cbDlgTemplates; LPWSTR pID; HANDLE_T hWnd; LONG nInsertBefore; LONG nWndStyle; LONG nWndStyleEx; LPWSTR pWndClassName; };
Members
- pParent
- Pointer to IUIX_Obj containing the parent object or window. Can be used in place of the hWndParent
- hWndParent
- Value of HANDLE_T containing the parent window handle. Can be used in place of the pParent
- pImpl
- Pointer to IUnknown* containing the custom event handler.
- nStdClass
- Value of LONG containing the standard class ID such as Button, Edit, List etc.
- nObjStyle
- Value of LONGLONG containing the style flags of the new object.
- nCreateFlags
- Value of LONGLONG special creation flags to create windowed/windowless, child/popup/modal, scrollable, etc.
- pThemeClassID
- Value of LPWSTR containing the ID of the theme class (is optional). Can be of next values:
- "Dialog",
- "Button",
- "ScrollBar",
- "ScrollContainer",
- "Edit",
- "List",
- "Label",
- "PopupContainer",
- "ComboButton",
- "Combo",
- "Picture",
- "OriginSelector",
- "ControlsLock",
- "Group",
- "Frame",
- "Layout",
- "Spin",
- "Tooltip",
- "CmdBar",
- "CmdPane",
- "Tree",
- "Ruler",
- "Slider",
- "IndexNavigator",
- "ColorPicker",
- "PropSheetPage",
- "PropSheets",
- "CmdColorBtn",
- "Progress",
- "GuideLinesBtn",
- "InfoBtn",
- "PropList",
- "RangesNavigator",
- "IndProgress",
- "ToggleBtn",
- rc
- Value of RECT containing the Object's rectangle, relative to parent (required).
- pDlgTemplates
- Value of LPSTR containing the template of the dialog if the dialog is being created. Required if (nStdClass == UIX_StdClass_Dialog).
- cbDlgTemplates
- Value of LONG containing the number of bytes pointed by pDlgTemplates.
- pID
- Value of LPWSTR containing the ID of the dialog. Required if (nStdClass == UIX_StdClass_Dialog) AND pDlgTemplates is collection of dialogs' templates.
- hWnd
- Value of HANDLE_T used for subclassing of existing window, requires valid pImpl. (Optional)
- nInsertBefore
- Value of LONG used if UIX_CreateObj_InsertBefore flag is specified.
- nWndStyle
- Value of LONG containing the style flags of the window. Used for new windowed object creation (if the UIX_CreateObj_Windowed is specified).
- nWndStyleEx
- Value of LONG containing the styleEx flags of the window. Used for new windowed object creation (if the UIX_CreateObj_Windowed is specified).
- pWndClassName
- Value of LPWSTR containing window's class name. Used for new windowed object creation (if the UIX_CreateObj_Windowed is specified).