cdrsdk 1.0.0

Rust SDK for CorelDRAW automation via COM IDispatch late binding
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
//! `IvgDocument` —— 文档对象
//!
//! CorelDRAW 类型库中 `IVGDocument` 是**空接口**,所有属性/方法都
//! 通过 `IDispatch` 后期绑定访问。本文件按 CorelDRAW VBA 文档
//! 与常见用法整理。

use wincom::{ComObject, Variant};
use windows::Win32::System::Com::IDispatch;

use crate::curve::IvgCurve;
use crate::document::IvgMetadata;
use crate::layer::{IvgLayer, IvgLayers};
use crate::page::{IvgPage, IvgPages, IvgSpread, IvgSpreads};
use crate::shape::{IvgShape, IvgShapeRange, IvgShapes};
use crate::structs::{
    IvgStructExportOptions, IvgStructPaletteOptions, IvgStructSaveAsOptions,
};

// =============================================================
// IvgDocument
// =============================================================

/// CorelDRAW `IVGDocument` 对象的后期绑定包装(文档)。
///
/// 所有属性与方法通过 `IDispatch::Invoke` 按名称调用,调用失败时一般返回 `None` 或 `false`。
pub struct IvgDocument {
    disp: ComObject,
}

impl IvgDocument {
    /// 由 COM `IDispatch` 构造包装对象。
    pub fn new(disp: IDispatch) -> Self {
        Self {
            disp: ComObject::from_dispatch(disp, crate::types::IID_IDISPATCH),
        }
    }

    /// 从…构造分发。
    pub fn from_dispatch(disp: IDispatch) -> Self {
        Self::new(disp)
    }

    /// 从 COM `IDispatch` 构造包装对象,等价于 `new`。
    pub fn from_disp(disp: IDispatch) -> Self {
        Self::new(disp)
    }

    /// 获取底层 `ComObject` 的引用。
    pub fn raw(&self) -> &ComObject {
        &self.disp
    }

    /// 把底层 COM 对象包装成 `VARIANT`,用于传给其它 COM 调用。
    pub fn as_variant(&self) -> Variant {
        self.disp.as_variant()
    }

    // ---------------------------------------------------------
    // 通用工具
    // ---------------------------------------------------------

    fn prop_string(&self, name: &str) -> Option<String> {
        self.disp.get_property(name).ok()?.to_string().ok()
    }

    fn prop_i64(&self, name: &str) -> Option<i64> {
        self.disp.get_property(name).ok()?.to_i64().ok()
    }

    fn prop_f64(&self, name: &str) -> Option<f64> {
        self.disp.get_property(name).ok()?.to_f64().ok()
    }

    fn prop_bool(&self, name: &str) -> Option<bool> {
        self.disp.get_property(name).ok()?.to_bool().ok()
    }

    fn prop_dispatch(&self, name: &str) -> Option<IDispatch> {
        self.disp.get_property(name).ok()?.to_idispatch().ok()
    }

    fn put_i64(&self, name: &str, v: i64) -> bool {
        self.disp
            .set_property(name, vec![Variant::from_i64(v)])
            .is_ok()
    }

    fn put_f64(&self, name: &str, v: f64) -> bool {
        self.disp
            .set_property(name, vec![Variant::from_f64(v)])
            .is_ok()
    }

    fn put_bool(&self, name: &str, v: bool) -> bool {
        self.disp
            .set_property(name, vec![Variant::from_bool(v)])
            .is_ok()
    }

    // ---------------------------------------------------------
    // 基本信息
    // ---------------------------------------------------------

    /// 文档名(不含路径)。
    pub fn name(&self) -> Option<String> {
        self.prop_string("Name")
    }

    /// 完整文件路径(含文件名)。
    pub fn file_name(&self) -> Option<String> {
        self.prop_string("FileName")
    }

    /// 完整文件路径(含文件名)。
    pub fn full_file_name(&self) -> Option<String> {
        self.prop_string("FullFileName")
    }

    /// 文件路径(不含文件名)。
    pub fn file_path(&self) -> Option<String> {
        self.prop_string("FilePath")
    }

    /// 文档是否已被修改(未保存)。
    pub fn dirty(&self) -> Option<bool> {
        self.prop_bool("Dirty")
    }

    /// 设置 Dirty 标志。
    ///
    /// ⚠️ `Dirty` 在 RIDL 里是**只读**属性;`Application` 层可能支持写,
    /// 失败会返回 `false`。需要"清空未保存标记"时用 `reset_dirty()`。
    pub fn set_dirty(&self, v: bool) -> bool {
        self.put_bool("Dirty", v)
    }

    /// 清空未保存标记(把 `Dirty` 设为 `false`)。
    pub fn reset_dirty(&self) -> bool {
        self.put_bool("Dirty", false)
    }

    /// 是否只读。
    pub fn read_only(&self) -> Option<bool> {
        self.prop_bool("ReadOnly")
    }

    /// 是否已保存过。
    pub fn saved(&self) -> Option<bool> {
        self.prop_bool("Saved")
    }

    /// 文档版本号(保存次数)。
    pub fn version(&self) -> Option<i64> {
        self.prop_i64("Version")
    }

    /// 文档世界坐标系的单位(`cdrUnit`)。
    pub fn unit(&self) -> Option<i64> {
        self.prop_i64("Unit")
    }

    /// 设置单位(`Unit`)。
    pub fn set_unit(&self, unit: i32) -> bool {
        self.put_i64("Unit", unit as i64)
    }

    /// 文档参考点(`cdrReferencePoint`)。
    pub fn reference_point(&self) -> Option<i64> {
        self.prop_i64("ReferencePoint")
    }

    /// 设置参考点(`ReferencePoint`)。
    pub fn set_reference_point(&self, v: i32) -> bool {
        self.put_i64("ReferencePoint", v as i64)
    }

    /// 水平标尺原点(世界坐标)。
    pub fn world_scale(&self) -> Option<f64> {
        self.prop_f64("WorldScale")
    }

    /// 设置世界缩放(`WorldScale`)。
    pub fn set_world_scale(&self, v: f64) -> bool {
        self.put_f64("WorldScale", v)
    }

    // ---------------------------------------------------------
    // 上层对象
    // ---------------------------------------------------------

    /// 读取应用(`Application`)。
    pub fn application(&self) -> Option<crate::app::IvgApplication> {
        self.prop_dispatch("Application")
            .map(crate::app::IvgApplication::from_dispatch)
    }

    // ---------------------------------------------------------
    // 页面
    // ---------------------------------------------------------

    /// 读取页面集(`Pages`)。
    pub fn pages(&self) -> Option<IvgPages> {
        self.prop_dispatch("Pages").map(IvgPages::new)
    }

    /// 读取活动页面(`ActivePage`)。
    pub fn active_page(&self) -> Option<IvgPage> {
        self.prop_dispatch("ActivePage").map(IvgPage::new)
    }

    /// 读取跨页集(`Spreads`)。
    pub fn spreads(&self) -> Option<IvgSpreads> {
        self.prop_dispatch("Spreads").map(IvgSpreads::new)
    }

    /// 读取活动跨页(`ActiveSpread`)。
    pub fn active_spread(&self) -> Option<IvgSpread> {
        self.prop_dispatch("ActiveSpread").map(IvgSpread::new)
    }

    /// 在文档末尾追加一个空白页(默认页面尺寸)。
    ///
    /// `Document` 没有 `CreatePage` 成员;VBA 对应方法是
    /// `AddPages(NumberOfPages)`,返回第一个新增的页面。
    pub fn create_page(&self) -> Option<IvgPage> {
        let args = vec![Variant::from_i64(1)];
        if let Ok(v) = self.disp.invoke_method("AddPages", args) {
            if let Ok(disp) = v.to_idispatch() {
                return Some(IvgPage::new(disp));
            }
        }
        // 兼容旧版 / 非标准实现
        self.disp
            .invoke_method("CreatePage", vec![])
            .ok()?
            .to_idispatch()
            .ok()
            .map(IvgPage::new)
    }

    // ---------------------------------------------------------
    // 图层
    //
    // ⚠️ CorelDRAW 的 `Document` **没有** `Layers` 属性——
    //    `Layers` 挂在 `Page` 上。用 `active_page().layers()`
    //    或下面的便捷方法 `active_page_layers()`。
    // ---------------------------------------------------------

    /// 当前激活图层。
    pub fn active_layer(&self) -> Option<IvgLayer> {
        self.prop_dispatch("ActiveLayer").map(IvgLayer::new)
    }

    /// 当前虚拟层(Master Layer)。
    pub fn active_virtual_layer(&self) -> Option<IvgLayer> {
        self.prop_dispatch("ActiveVirtualLayer").map(IvgLayer::new)
    }

    /// 当前页的所有图层。
    ///
    /// 等价于 `doc.active_page()?.layers()`。
    pub fn active_page_layers(&self) -> Option<IvgLayers> {
        self.active_page()?.layers()
    }

    /// 在当前页新建图层。
    ///
    /// 等价于 `doc.active_page()?.create_layer(name)`。
    pub fn create_layer(&self, name: impl Into<String>) -> Option<IvgLayer> {
        self.active_page()?.create_layer(name)
    }

    // ---------------------------------------------------------
    // 图形
    // ---------------------------------------------------------

    /// 当前页面所有图形(集合)。
    pub fn shapes(&self) -> Option<IvgShapes> {
        self.prop_dispatch("Shapes").map(IvgShapes::new)
    }

    /// 当前选中的图形范围。
    pub fn selection_range(&self) -> Option<IvgShapeRange> {
        self.prop_dispatch("SelectionRange").map(IvgShapeRange::new)
    }

    /// 当前活动图形。
    pub fn active_shape(&self) -> Option<IvgShape> {
        self.prop_dispatch("ActiveShape").map(IvgShape::new)
    }

    /// 清空选择。
    pub fn clear_selection(&self) -> bool {
        self.disp.invoke_method("ClearSelection", vec![]).is_ok()
    }

    /// 通过名称/类型查找图形。
    pub fn find_shape(
        &self,
        name: impl Into<String>,
        shape_type: i32,
        static_id: i32,
        recursive: bool,
    ) -> Option<IvgShape> {
        let args = vec![
            Variant::from_str(&name.into()),
            Variant::from_i64(shape_type as i64),
            Variant::from_i64(static_id as i64),
            Variant::from_bool(recursive),
        ];
        self.disp
            .invoke_method("FindShape", args)
            .ok()?
            .to_idispatch()
            .ok()
            .map(IvgShape::new)
    }

    /// 通过名称/类型查找多个图形。
    pub fn find_shapes(
        &self,
        name: impl Into<String>,
        shape_type: i32,
        recursive: bool,
    ) -> Option<IvgShapeRange> {
        let args = vec![
            Variant::from_str(&name.into()),
            Variant::from_i64(shape_type as i64),
            Variant::from_bool(recursive),
        ];
        self.disp
            .invoke_method("FindShapes", args)
            .ok()?
            .to_idispatch()
            .ok()
            .map(IvgShapeRange::new)
    }

    // ---------------------------------------------------------
    // 曲线工厂
    // ---------------------------------------------------------

    /// 创建曲线(COM 方法 `CreateCurve`)。
    pub fn create_curve(&self) -> Option<IvgCurve> {
        let args = vec![self.as_variant()];
        self.disp
            .invoke_method("CreateCurve", args)
            .ok()?
            .to_idispatch()
            .ok()
            .map(IvgCurve::new)
    }

    // ---------------------------------------------------------
    // 单位转换
    // ---------------------------------------------------------

    /// 单位换算。
    ///
    /// ⚠️ 不走 COM——`Application.ConvertUnits` 通过 `IDispatch` 拿到
    /// 的结果不对(COM 方法有出参)。改用本地纯数学实现
    /// [`crate::geometry::units::convert_by_i32`]。
    pub fn convert_units(&self, value: f64, from: i32, to: i32) -> Option<f64> {
        crate::geometry::units::convert_by_i32(value, from, to)
    }

    // ---------------------------------------------------------
    // 数据字段
    // ---------------------------------------------------------

    /// 读取 COM 属性 `DataFields`。
    pub fn data_fields(&self) -> Option<crate::document::IvgDataFields> {
        self.prop_dispatch("DataFields")
            .map(crate::document::IvgDataFields::new)
    }

    // ---------------------------------------------------------
    // 元数据
    // ---------------------------------------------------------

    /// 读取元数据(`Metadata`)。
    pub fn metadata(&self) -> Option<IvgMetadata> {
        self.prop_dispatch("Metadata").map(IvgMetadata::new)
    }

    // ---------------------------------------------------------
    // 保存 / 另存为 / 关闭
    // ---------------------------------------------------------

    /// 保存文档。
    ///
    /// ⚠️ 若从未保存过,会弹出"另存为"对话框——**自动化场景应避免**。
    /// 未命名文档请改用 [`save_as`](Self::save_as) / [`save_as_ex`](Self::save_as_ex)。
    pub fn save(&self) -> bool {
        self.disp.invoke_method("Save", vec![]).is_ok()
    }

    /// 另存为(自动创建默认 `IVGStructSaveAsOptions`)。
    ///
    /// 类型库中 `Document.SaveAs(FileName, Options)` 的 `Options` 是必需
    /// 参数(不是可选参数),缺省会 `DISP_E_TYPEMISMATCH`。
    pub fn save_as(&self, file_name: impl Into<String>) -> bool {
        let Some(options) = self.application().and_then(|a| a.create_save_as_options()) else {
            return false;
        };
        self.save_as_ex(file_name, &options)
    }

    /// 另存为(带 `IVGStructSaveAsOptions`)。
    pub fn save_as_ex(
        &self,
        file_name: impl Into<String>,
        options: &IvgStructSaveAsOptions,
    ) -> bool {
        let args = vec![
            Variant::from_str(&file_name.into()),
            options.as_variant(),
        ];
        self.disp.invoke_method("SaveAs", args).is_ok()
    }

    /// 关闭文档。
    ///
    /// ⚠️ 若有未保存修改会弹对话框——自动化场景请先用 [`close_without_saving`](Self::close_without_saving)。
    pub fn close(&self) -> bool {
        self.disp.invoke_method("Close", vec![]).is_ok()
    }

    /// 关闭文档并丢弃修改。
    ///
    /// `cdrSaveOptions`: 0 = 保存, 1 = 不保存, 2 = 取消。
    pub fn close_without_saving(&self) -> bool {
        let _ = self.reset_dirty();
        self.disp.invoke_method("Close", vec![]).is_ok()
    }

    // ---------------------------------------------------------
    // 导出 / 打印
    // ---------------------------------------------------------

    /// 导出为指定格式。
    ///
    /// 类型库签名是
    /// `Export(FileName, Filter, Range, Options, PaletteOptions)`——五个
    /// 参数全部必需。这里用默认 ExportOptions / PaletteOptions,
    /// `Range = cdrExportRange::AllPages(0)`。
    pub fn export(&self, file_name: impl Into<String>, filter: i32) -> bool {
        let Some(app) = self.application() else {
            return false;
        };
        let (Some(options), Some(palette)) = (
            app.create_export_options(),
            app.create_palette_options(),
        ) else {
            return false;
        };
        self.export_with(file_name, filter, &options, &palette)
    }

    /// 导出(带 `IVGStructExportOptions`)。
    pub fn export_ex(
        &self,
        file_name: impl Into<String>,
        filter: i32,
        options: &IvgStructExportOptions,
    ) -> bool {
        let Some(palette) = self
            .application()
            .and_then(|a| a.create_palette_options())
        else {
            return false;
        };
        self.export_with(file_name, filter, options, &palette)
    }

    fn export_with(
        &self,
        file_name: impl Into<String>,
        filter: i32,
        options: &IvgStructExportOptions,
        palette: &IvgStructPaletteOptions,
    ) -> bool {
        let args = vec![
            Variant::from_str(&file_name.into()),
            Variant::from_i32(filter),
            Variant::from_i32(0), // cdrExportRange::AllPages
            options.as_variant(),
            palette.as_variant(),
        ];
        self.disp.invoke_method("Export", args).is_ok()
    }

    /// 打印。
    pub fn print_out(&self) -> bool {
        self.disp.invoke_method("PrintOut", vec![]).is_ok()
    }

    /// 取打印任务对象(进一步设置参数)。
    pub fn print_settings(&self) -> Option<crate::print::IvgPrnJob> {
        self.disp
            .invoke_method("PrintSettings", vec![])
            .ok()?
            .to_idispatch()
            .ok()
            .map(crate::print::IvgPrnJob::new)
    }

    // ---------------------------------------------------------
    // PDF 设置
    // ---------------------------------------------------------

    /// PDF 设置集(COM 方法 `PDFSettings`)。
    pub fn pdf_settings(&self) -> Option<crate::print::IvgPdfVbaSettings> {
        self.disp
            .invoke_method("PDFSettings", vec![])
            .ok()?
            .to_idispatch()
            .ok()
            .map(crate::print::IvgPdfVbaSettings::new)
    }

    // ---------------------------------------------------------
    // 撤销 / 重做
    // ---------------------------------------------------------

    /// 开始一个可撤销的命名事务。
    pub fn begin_command_group(&self, name: impl Into<String>) -> bool {
        let args = vec![Variant::from_str(&name.into())];
        self.disp.invoke_method("BeginCommandGroup", args).is_ok()
    }

    /// 结束命名事务。
    pub fn end_command_group(&self) -> bool {
        self.disp.invoke_method("EndCommandGroup", vec![]).is_ok()
    }

    /// 清空撤销栈。
    pub fn clear_undo_stack(&self) -> bool {
        self.disp.invoke_method("ClearUndoStack", vec![]).is_ok()
    }

    // ---------------------------------------------------------
    // 视图 / 窗口
    // ---------------------------------------------------------

    /// 读取视图集(`Views`)。
    pub fn views(&self) -> Option<crate::view::IvgViews> {
        self.prop_dispatch("Views").map(crate::view::IvgViews::new)
    }

    /// 读取窗口集(`Windows`)。
    pub fn windows(&self) -> Option<crate::view::IvgWindows> {
        self.prop_dispatch("Windows")
            .map(crate::view::IvgWindows::new)
    }

    // ---------------------------------------------------------
    // 网格 / 标尺
    // ---------------------------------------------------------

    /// 读取网格(`Grid`)。
    pub fn grid(&self) -> Option<crate::misc::IvgGrid> {
        self.prop_dispatch("Grid").map(crate::misc::IvgGrid::new)
    }

    /// 读取标尺(`Rulers`)。
    pub fn rulers(&self) -> Option<crate::misc::IvgRulers> {
        self.prop_dispatch("Rulers").map(crate::misc::IvgRulers::new)
    }

    // ---------------------------------------------------------
    // 样式
    // ---------------------------------------------------------

    /// 读取 COM 属性 `StyleSheet`。
    pub fn style_sheet(&self) -> Option<crate::style::IvgStyleSheet> {
        self.prop_dispatch("StyleSheet")
            .map(crate::style::IvgStyleSheet::new)
    }

    // ---------------------------------------------------------
    // 对象管理器(Tree)
    // ---------------------------------------------------------

    /// 读取对象树管理器(`ActiveTreeManager`)。
    pub fn tree_manager(&self) -> Option<crate::tree::IvgTreeManager> {
        self.prop_dispatch("ActiveTreeManager")
            .map(crate::tree::IvgTreeManager::new)
    }

    // ---------------------------------------------------------
    // 选择信息
    // ---------------------------------------------------------

    /// 读取选择信息(`SelectionInfo`)。
    pub fn selection_info(&self) -> Option<crate::shape::IvgSelectionInformation> {
        self.prop_dispatch("SelectionInfo")
            .map(crate::shape::IvgSelectionInformation::new)
    }
}