Home » Adobe Manuals » Computer Software » Adobe 38040334 » Manual Viewer

Adobe 38040334 API Reference - Page 90

How source control integration with Dreamweaver works, Adding source control system functionality

UPC - 883919090467

Add to My Manuals
Save this manual to your list of manuals

Page 90 highlights

DREAMWEAVER CS3 85 API Reference How source control integration with Dreamweaver works When a Dreamweaver user selects server connection, file transfer, or Design Notes features, Dreamweaver calls the DLL's version of the corresponding API function (Connect(), Disconnect(), Get(), Put(), Checkin(), Checkout(), Undocheckout(), and Synchronize()). The DLL handles the request, including displaying dialog boxes that gather information or letting the user interact with the DLL. The DLL also displays information or error messages. The source control system can optionally support Design Notes and Check In/Check Out. The Dreamweaver user enables Design Notes in source control systems by selecting the Design Notes tab in the Edit Sites dialog box and checking the box that enables the feature; this process is same to enable Design Notes with FTP and LAN. If the source control system does not support Design Notes and the user wants to use this feature, Dreamweaver transports Design Note (MNO) files to maintain the Design Notes (as it does with FTP and LAN). Check In/Check Out is treated differently than the Design Notes feature; if the source control system supports it, the user cannot override its use from the Design Notes dialog box. If the user tries to override the source control system, an error message appears. Adding source control system functionality You can add source control system functionality to Dreamweaver by writing a GetNewFeatures handler that returns a set of menu items and corresponding C functions. For example, if you write a Sourcesafe library and want to let Dreamweaver users see the history of a file, you can write a GetNewFeatures handler that returns the History menu item and the C function name of history. Then, in Windows, when the user right-clicks a file, the History menu item is one of the items on the menu. If a user selects the History menu item, Dreamweaver calls the corresponding function, passing the selected files to the DLL. The DLL displays the History dialog box so the user can interact with it in the same way as Sourcesafe. The source control integration API required functions The source control integration API has required and optional functions. The functions listed in this section are required. bool SCS_GetAgentInfo() Description This function asks the DLL to return its name and description, which appear in the Edit Sites dialog box. The name appears in the Server Access pop-up menu (for example, sourcesafe, webdav, perforce) and the description below the pop-up menu. Arguments char name[32], char version[32], char description[256], const char *dwAppVersion

Section	Page
Contents	3
Chapter 1: Introduction	6
Background	7
Extending Dreamweaver	7
Additional resources for extension writers	7
New functions in Dreamweaver CS3	7
Removed functions	9
Errata	10
Conventions used in this guide	10
Chapter 2: The file I/O API	11
Accessing configuration folders	11
The file I/O API	11
Chapter 3: The HTTP API	20
How the HTTP API works	20
The HTTP API	21
Chapter 4: The Design Notes API	27
How Design Notes work	27
The Design Notes JavaScript API	28
The Design Notes C API	32
Chapter 5: Fireworks integration	39
The FWLaunch API	39
Chapter 6: Flash integration	46
How Flash elements work	46
Inserting Flash elements	46
The Flash Objects API	47
Chapter 7: The database API	51
How database API functions work	51
Database connection functions	52
Database access functions	64
Chapter 8: The database connectivity API	76
How to develop a new connection type	76
The Connection API	78
The generated include file	80
The definition file for your connection type	82
Chapter 9: The JavaBeans API	84
The JavaBeans API	84
Chapter 10: The source control integration API	89
How source control integration with Dreamweaver works	90
Adding source control system functionality	90
The source control integration API required functions	90
The source control integration API optional functions	96
Enablers	104
Chapter 11: Application	109
External application functions	109
Global application functions	117
Bridge communication functions	122
Chapter 12: Workspace	124
History functions	124
Insert object functions	132
Keyboard functions	135
Menu functions	141
Results window functions	143
Toggle functions	154
Toolbar functions	173
Window functions	178
Code collapse functions	188
Code view toolbar functions	194
Chapter 13: Site	198
Report functions	198
Site functions	199
Chapter 14: Document	232
Conversion functions	232
Command functions	233
File manipulation functions	235
Global document functions	249
Path functions	258
Selection functions	260
String manipulation functions	267
Translation functions	270
XSLT functions	272
Chapter 15: Page content	275
Assets panel functions	275
Behavior functions	285
Clipboard functions	293
Library and template functions	298
Snippets panel functions	303
Spry widget editing functions	306
Inserting Spry widgets functions	308
Browser compatibility check functions	311
Chapter 16: Dynamic documents	319
Server components functions	319
Data source functions	320
Extension Data Manager functions	321
Live data functions	324
Server behavior functions	328
Server model functions	330
Chapter 17: Design	337
CSS layout functions	337
Frame and frameset functions	356
Layer and image map functions	358
Layout environment functions	360
Layout view functions	365
Zoom functions	374
Guide functions and properties	377
Table editing functions	384
Chapter 18: Code	393
Code functions	393
Find and replace functions	397
General editing functions	402
Print function	417
Quick Tag Editor functions	418
Code view functions	420
Tag editor and tag library functions	436
Chapter 19: Enablers	440
Enabler functions	440

Match case Limit results 1 per page

DREAMWEAVER CS3

API Reference

How source control integration with Dreamweaver

works

When a Dreamweaver user selects server connection, file transfer, or Design Notes features, Dreamweaver calls the

DLL’s version of the corresponding API function (

Connect()

Disconnect()

Get()

Put()

Checkin()

Checkout()

Undocheckout()

, and

Synchronize()

). The DLL handles the request, including displaying dialog

boxes that gather information or letting the user interact with the DLL. The DLL also displays information or

error messages.

The source control system can optionally support Design Notes and Check In/Check Out. The Dreamweaver user

enables Design Notes in source control systems by selecting the Design Notes tab in the Edit Sites dialog box and

checking the box that enables the feature; this process is same to enable Design Notes with FTP and LAN. If the

source control system does not support Design Notes and the user wants to use this feature, Dreamweaver transports

Design Note (MNO) files to maintain the Design Notes (as it does with FTP and LAN).

Check In/Check Out is treated differently than the Design Notes feature; if the source control system supports it, the

user cannot override its use from the Design Notes dialog box. If the user tries to override the source control system,

an error message appears.

Adding source control system functionality

You can add source control system functionality to Dreamweaver by writing a

GetNewFeatures

handler that returns

a set of menu items and corresponding C functions. For example, if you write a Sourcesafe library and want to let

Dreamweaver users see the history of a file, you can write a

GetNewFeatures

handler that returns the History menu

item and the C function name of

history

. Then, in Windows, when the user right-clicks a file, the History menu

item is one of the items on the menu. If a user selects the History menu item, Dreamweaver calls the corresponding

function, passing the selected files to the DLL. The DLL displays the History dialog box so the user can interact with

it in the same way as Sourcesafe.

The source control integration API required functions

The source control integration API has required and optional functions. The functions listed in this section are

required.

bool SCS_GetAgentInfo()

Description

This function asks the DLL to return its name and description, which appear in the Edit Sites dialog box. The name

appears in the Server Access pop-up menu (for example, sourcesafe, webdav, perforce) and the description below the

pop-up menu.

Arguments

char name[32], char version[32], char description[256], const char *dwAppVersion