WebSVN – vanilla-wow-addons – Blame – Rev 1 – /s/SimpleCombatLog/DewdropLib/API.html

1

office

1

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html>

<head>

<title>DewdropLib API Documentation</title>

6

<style type="text/css">

7

dl {margin-top:0;margin-bottom:0}

8

dd.example {font-family:monospace}

9

dd {margin-bottom:1em}

10

dl.level-1 dt {font-size:17pt}

11

dl.level-1 dd {font-size:16pt}

12

dl.level-1 dd dt {font-size:16pt}

13

dl.level-1 dd dd {font-size:15pt}

14

dl.level-1 dd dd dt {font-size:15pt}

15

dl.level-1 dd dd dd {font-size:14pt}

16

dl.level-1 dd dd dd dt {font-size:14pt}

17

dl.level-1 dd dd dd dd {font-size:13pt}

18

dl.level-1 dd dd dd dd dt {font-size:13pt}

19

dl.level-1 dd dd dd dd dd {font-size:12pt}

</style>

</head>

<body>

<dl class="level-1">

25

<dt>Embed Methods:</dt>

26

<dd>

27

<a href="#DewdropLib_GetInstance">DewdropLib:GetInstance("version")</a> 

28

</dd>

29

<dt>Library Functions:</dt>

30

<dd>

31

<a href="#Register">Register(parent, ...)</a> 

32

<a href="#Unregister">Unregister(parent)</a> 

33

<a href="#Open">Open(parent, ...)</a> 

34

<a href="#Close">Close([level])</a> 

35

<a href="#Refresh">Refresh([level])</a> 

36

<a href="#AddLine">AddLine(...)</a> 

37

<a href="#IsOpen">IsOpen(parent)</a> 

38

<a href="#IsRegistered">IsRegistered(parent)</a> 

39

</dd>

40

<dt>Register/Open arguments;</dt>

41

<dd>

42

<a href="#children">children</a>

43

<a href="#point">point</a>

44

<a href="#relativePoint">relativePoint</a>

45

<a href="#cursorX">cursorX</a>

46

<a href="#cursorY">cursorY</a>

47

<a href="#dontHook">dontHook Register only</a>

48

</dd>

49

<dt>AddLine arguments:</dt>

50

<dd>

51

<a href="#text">text</a> 

52

<a href="#level">level</a> 

53

<a href="#disabled">disabled</a> 

54

<a href="#isTitle">isTitle</a> 

55

<a href="#notClickable">notClickable</a> 

56

<a href="#textRGB">textR, textG, textB</a> 

57

<a href="#notCheckable">notCheckable</a> 

58

<a href="#isRadio">isRadio</a> 

59

<a href="#checked">checked</a> 

60

<a href="#checkIcon">checkIcon</a> 

61

<a href="#func">func</a> 

62

<a href="#arg123">arg1, arg2, arg3</a> 

63

<a href="#hasColorSwatch">hasColorSwatch</a> 

64

<a href="#rgb">r, g, b</a> 

65

<a href="#swatchFunc">swatchFunc</a> 

66

<a href="#hasOpacity">hasOpacity</a> 

67

<a href="#opacityFunc">opacityFunc</a> 

68

<a href="#opacity">opacity</a> 

69

<a href="#cancelFunc">cancelFunc</a> 

70

<a href="#hasArrow">hasArrow</a> 

71

<a href="#value">value</a> 

72

<a href="#hasSlider">hasSlider</a> 

73

<a href="#sliderTop">sliderTop</a> 

74

<a href="#sliderBottom">sliderBottom</a> 

75

<a href="#sliderFunc">sliderFunc</a> 

76

<a href="#sliderValue">sliderValue</a> 

77

<a href="#textHeight">textHeight</a> 

78

<a href="#justifyH">justifyH</a> 

79

<a href="#tooltipTitle">tooltipTitle</a> 

80

<a href="#tooltipText">tooltipText</a> 

81

<a href="#closeWhenClicked">closeWhenClicked</a> 

</dd>

</dl>

<dl class="level-1">

87

<dt>Embed Methods:</dt>

88

<dd>

89

<dl>

90

<dt id="DewdropLib_GetInstance">DewdropLib:GetInstance("version")</dt>

91

<dd>

92

<dl>

93

		<dt>Returns an instance of DewdropLib with the specified version. If the version cannot be found, an error occurs.</dt>

94

<dd></dd>

95

<dt>Arguments:</dt>

96

<dd>

97

<dl>

98

<dt>("version")</dt>

99

<dd></dd>

100

<dt>"version":</dt>

101

<dd>String - the major version of the library, currently "1.0"</dd>

</dl>

</dd>

<dt>Returns:</dt>

<dd>An instance of DewdropLib with the specified version</dd>

106

<dt>Example:</dt>

107

<dd>local dewdrop = DewdropLib:GetInstance("1.0")</dd>

</dl>

</dd>

</dl>

</dd>

<dt>Library Functions:</dt>

113

<dd>

114

<dl>

115

<dt id="Register">Register(parent, ...)</dt>

116

<dd>

117

<dl>

118

<dt>Registers a given parent with DewdropLib. Settings are initialized from the other arguments given.</dt>

<dd>

</dd>

<dt>Arguments:</dt>

123

<dd>

124

<dl>

125

<dt>(parent, ...)</dt>

126

<dd></dd>

127

<dt>parent:</dt>

128

<dd>Frame - parent frame to register.</dd>

129

<dt>...</dt>

130

<dd><a href="#Register_arguments">Register/Open arguments</a></dd>

</dl>

</dd>

<dt>Returns:</dt>

<dd>

nil

</dd>

<dt>Remarks:</dt>

<dd>

This automatically registers the right-click with with the parent frame. 

140

Unregistering will cause this not to happen.

141

</dd>

142

<dt>Example:</dt>

143

<dd>dewdrop:Register(Minimap, 

144

    'children', function() 

145

        dewdrop:AddLine('text', "Text") 

    end 

)</dd>

</dl>

</dd>

<dt id="Unregister">Unregister(parent)</dt>

151

<dd>

152

<dl>

153

<dt>Unregisters a given parent from TabletLib.</dt>

<dd>

</dd>

<dt>Arguments:</dt>

<dd>

<dl>

<dt>(parent)</dt>

<dd></dd>

<dt>parent:</dt>

<dd>Frame - registered parent frame.</dd>

</dl>

</dd>

<dt>Returns:</dt>

<dd>

nil

</dd>

<dt>Example:</dt>

<dd>tablet:Unregister(Minimap)</dd>

172

</dl>

173

</dd>

174

<dt id="Open">Open(parent, ... or parent, otherParent)</dt>

175

<dd>

176

<dl>

177

		<dt>Opens the menu on the given parent, the innards are initialized either with data from Register(parent, ...) or from the given arguments.</dt>

<dd>

</dd>

<dt>Arguments:</dt>

182

<dd>

183

<dl>

184

<dt>(parent, ...) or (parent, otherParent)</dt>

185

<dd></dd>

186

<dt>parent:</dt>

187

<dd>Frame - parent frame to open.</dd>

188

<dt>...</dt>

189

<dd><a href="#Register_arguments">Register/Open arguments</a></dd>

190

<dt>otherParent:</dt>

191

<dd>Frame - parent frame to get information on.</dd>

</dl>

</dd>

<dt>Returns:</dt>

<dd>

nil

</dd>

<dt>Remarks:</dt>

<dd>

			If you called Register(parent, ...) on the same parent, you do not need to give extra arguments, but if you do, they will take precedent.<br />

</dd>

<dt>Example:</dt>

<dd>dewdrop:Open(Minimap) -- assuming data from the registry</dd>

205

</dl>

206

</dd>

207

<dt id="Close">Close([level])</dt>

208

<dd>

209

<dl>

210

<dt>Closes the given level.</dt>

<dd>

</dd>

<dt>Arguments:</dt>

<dd>

<dl>

<dt>([level])</dt>

<dd></dd>

<dt>level:</dt>

<dd>Integer - Number of the level [1, inf). Assume 1 if not given.</dd>

</dl>

</dd>

<dt>Returns:</dt>

<dd>

nil

</dd>

<dt>Example:</dt>

<dd>dewdrop:Close(2) -- closes 2nd levels and any sublevels</dd>

229

</dl>

230

</dd>

231

<dt id="Refresh">Refresh([level])</dt>

232

<dd>

233

<dl>

234

<dt>Refreshes the contents of a given level</dt>

<dd>

</dd>

<dt>Arguments:</dt>

<dd>

<dl>

<dt>([level])</dt>

<dd></dd>

<dt>level:</dt>

<dd>Integer - Number of the level [1, inf). Assume 1 if not given.</dd>

</dl>

</dd>

<dt>Returns:</dt>

<dd>

nil

</dd>

<dt>Example:</dt>

<dd>dewdrop:Refresh(1) -- refreshes the first level.</dd>

253

</dl>

254

</dd>

255

<dt id="AddLine">AddLine(...)</dt>

256

<dd>

257

<dl>

258

<dt>Adds a line to the dropdown menu.</dt>

<dd>

</dd>

<dt>Arguments:</dt>

<dd>

<dl>

<dt>(...)</dt>

<dd></dd>

<dt>A list of key-value pairs to represent information.</dt>

</dl>

</dd>

<dt>Returns:</dt>

<dd>

nil

</dd>

<dt>Remarks:</dt>

<dd>

This should only be called inside the init function of Open(frame, func).

277

</dd>

278

<dt>Example:</dt>

279

<dd>dewdrop:AddLine( 

280

    'text', "Hello, World!" 

) 

</dd>

</dl>

</dd>

<dt id="IsOpen">IsOpen(parent)</dt>

286

<dd>

287

<dl>

288

<dt>Returns whether the given parent frame has an open dropdown menu on it.</dt>

289

<dd></dd>

290

<dt>Arguments:</dt>

<dd>

<dl>

<dt>(parent)</dt>

<dd></dd>

<dt>parent:</dt>

<dd>Frame - parent frame to check.</dd>

</dl>

</dd>

<dt>Returns:</dt>

<dd>

Boolean - whether the given parent frame has an open dropdown menu.

302

</dd>

303

<dt>Example:</dt>

304

<dd>local open = dewdrop:IsOpen(Minimap)</dd>

305

</dl>

306

</dd>

307

<dt id="IsRegistered">IsRegistered(parent)</dt>

308

<dd>

309

<dl>

310

<dt>Returns whether the given parent frame has been registered with Dewdrop.</dt>

311

<dd></dd>

312

<dt>Arguments:</dt>

<dd>

<dl>

<dt>(parent)</dt>

<dd></dd>

<dt>parent:</dt>

<dd>Frame - parent frame to check.</dd>

</dl>

</dd>

<dt>Returns:</dt>

<dd>

Boolean - whether the given parent frame has been registered with Dewdrop.

324

</dd>

325

<dt>Example:</dt>

326

<dd>local registered = dewdrop:IsRegistered(Minimap)</dd>

</dl>

</dd>

</dl>

</dd>

<dt>Register/Open arguments;</dt>

332

<dd>

333

<dl>

334

<dt id="children">children</dt>

335

<dd>

336

<dl>

337

		<dt>function(level, value, valueN_1, valueN_2, valueN_3, valueN_4) - function to describe the innards of the menu.</dt>

<dd>

</dd>

<dt>Remarks:<dt>

<dd>

value is the value of the menu just opened, where the level number is N. 

344

valueN_1 is the value of level N-1, and so forth onto valueN_4, which is the value of level N-4.

345

</dd>

346

<dt>Example:</dt>

347

<dd>dewdrop:Register(Minimap, 

348

    'children', function(level, value) 

349

        dewdrop:AddLine('text', "Text") 

    end 

) 

</dd>

</dl>

</dd>

<dt id="point">point</dt>

356

<dd>

357

<dl>

358

<dt>String - the main attach point of the menu.</dt>

359

		<dt>Function - a function which returns the main attach point of the menu and, optionally, the relative attach point.</dt>

360

<dd></dd>

361

<dt>Example:</dt>

362

<dd>dewdrop:Register(Minimap, 

363

    'point', function(parent) 

364

        return "TOPRIGHT", "TOPLEFT" 

    end 

)</dd>

</dl>

</dd>

<dt id="relativePoint">relativePoint</dt>

370

<dd>

371

<dl>

372

<dt>String - the relative attach point of the menu.</dt>

373

<dt>Function - a function which returns the relative attach point of the menu.</dt>

374

<dd></dd>

375

<dt>Example:</dt>

376

<dd>dewdrop:Register(Minimap, 

377

    'point', function(parent) 

378

        return "TOPRIGHT" 

379

    end, 

380

    'relativePoint', function(parent) 

381

        return "TOPLEFT" 

    end 

)</dd>

</dl>

</dd>

<dt id="cursorX">cursorX</dt>

387

<dd>

388

<dl>

389

<dt>Boolean - Whether the menu follows the cursor on the x-axis</dt>

390

<dd></dd>

391

<dt>Remarks:</dt>

392

<dd>In this case, point should be "BOTTOM" or "TOP", and relativePoint should be the opposite.</dd>

393

<dt>Example:</dt>

394

<dd>dewdrop:Register(Minimap, 

395

    'point', "TOP", 

396

    'relativePoint', "BOTTOM", 

397

    'cursorX', true 

)</dd>

</dl>

</dd>

<dt id="cursorY">cursorY</dt>

402

<dd>

403

<dl>

404

<dt>Boolean - Whether the menu follows the cursor on the y-axis</dt>

405

<dd></dd>

406

<dt>Remarks:</dt>

407

<dd>In this case, point should be "LEFT" or "RIGHT", and relativePoint should be the opposite.</dd>

408

<dt>Example:</dt>

409

<dd>dewdrop:Register(Minimap, 

410

    'point', "LEFT", 

411

    'relativePoint', "RIGHT", 

412

    'cursorY', true 

)</dd>

</dl>

</dd>

<dt id="dontHook">dontHook Register only</dt>

417

<dd>

418

<dl>

419

		<dt>Boolean - whether the mouse click scripts will be hooked to open/close the menu. You will need to manually call Open() if you do this.</dt>

420

<dd></dd>

421

<dt>Example:</dt>

422

<dd>dewdrop:Register(Minimap, 

423

    'point', "LEFT", 

424

    'dontHook', true 

)</dd>

</dl>

</dd>

</dl>

</dd>

<dt>AddLine arguments:</dt>

431

<dd>

432

<dl>

433

<dt id="text">text</dt>

434

<dd>

435

<dl>

436

<dt>String - the text on the button.</dt>

<dd>

</dd>

<dt>Example:</dt>

<dd>dewdrop:AddLine( 

442

    'text', "Hello, World!", 

) 

</dd>

</dl>

</dd>

<dt id="level">level</dt>

448

<dd>

449

<dl>

450

<dt>Integer - the level the line should be added at.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

In most cases, you won't need this, as the level is inferred automatically.

457

</dd>

458

<dt>Example:</dt>

459

<dd>dewdrop:AddLine( 

460

    'text', "Hello, World!", 

    'level', 2 

) 

</dd>

</dl>

</dd>

<dt id="disabled">disabled</dt>

467

<dd>

468

<dl>

469

<dt>Boolean - whether the button is disabled.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

Disabling causes the button to be unclickable and makes the text gray.

476

</dd>

477

<dt>Example:</dt>

478

<dd>dewdrop:AddLine( 

479

    'text', "Hello, World!", 

480

    'disabled', true 

) 

</dd>

</dl>

</dd>

<dt id="isTitle">isTitle</dt>

486

<dd>

487

<dl>

488

<dt>Boolean - whether the button is a title.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

Being a title causes the button to be disabled, but have the standard yellow color.

495

</dd>

496

<dt>Example:</dt>

497

<dd>dewdrop:AddLine( 

498

    'text', "I am a title", 

499

    'isTitle', true 

) 

</dd>

</dl>

</dd>

<dt id="notClickable">notClickable</dt>

505

<dd>

506

<dl>

507

<dt>Boolean - whether the button is clickable or not.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

			Being unclickable causes the button to be disabled, but have the standard white color, so it would look like other buttons.

514

</dd>

515

<dt>Example:</dt>

516

<dd>dewdrop:AddLine( 

517

    'text', "Hello, world!", 

518

    'notClickable', true 

) 

</dd>

</dl>

</dd>

<dt id="textRGB">textR, textG, textB</dt>

<dd>

<dl>

<dt>textR</dt>

<dd>Number - The red value. [0, 1]</dd>

528

<dt>textG</dt>

529

<dd>Number - The green value. [0, 1]</dd>

530

<dt>textB</dt>

531

<dd>Number - The blue value. [0, 1]</dd>

532

<dt>Remarks:</dt>

533

<dd>

534

Sets the text color of the button, overriding disabled, isTitle, or notClickable's colors. 

535

This only works if all three colors are set.

536

</dd>

537

<dt>Example:</dt>

538

<dd>dewdrop:AddLine( 

539

    'text', "Hello, world!", 

    'textR', 1, 

    'textG', 1, 

    'textB', 1 

) 

</dd>

</dl>

</dd>

<dt id="notCheckable">notCheckable</dt>

548

<dd>

549

<dl>

550

<dt>Boolean - whether the button is checkable or not.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

Really, this being set just causes the blank space that would be normally for a checkbox to not be there.

557

</dd>

558

<dt>Example:</dt>

559

<dd>dewdrop:AddLine( 

560

    'text', "Hello, world!", 

561

    'notCheckable', true 

) 

</dd>

</dl>

</dd>

<dt id="isRadio">isRadio</dt>

567

<dd>

568

<dl>

569

<dt>Boolean - whether the button is a radio button.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

			If set to true, it uses a texture similar to "Interface\Buttons\UI-RadioButton", which is 4 buttons side-by-side, unchecked, checked, highlight, and blank.

576

</dd>

577

<dt>Example:</dt>

578

<dd>dewdrop:AddLine( 

579

    'text', "Hello, world!", 

580

    'isRadio', true, 

) 

</dd>

</dl>

</dd>

<dt id="checked">checked</dt>

586

<dd>

587

<dl>

588

<dt>Boolean - whether the button is checked or not.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

If set to true, it sets the check's alpha to fully visible, otherwise makes it invisible.

595

</dd>

596

<dt>Example:</dt>

597

<dd>dewdrop:AddLine( 

598

    'text', "Hello, world!", 

599

    'checked', math.random() < 0.5 

) 

</dd>

</dl>

</dd>

<dt id="checkIcon">checkIcon</dt>

605

<dd>

606

<dl>

607

<dt>String - path to the check texture.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

If not set, assume "Interface\\Buttons\\UI-CheckBox-Check"

614

</dd>

615

<dt>Example:</dt>

616

<dd>dewdrop:AddLine( 

617

    'text', "Hello, world!", 

618

    'checkIcon', "Interface\\Buttons\\UI-CheckBox-Check" 

) 

</dd>

</dl>

</dd>

<dt id="func">func</dt>

624

<dd>

625

<dl>

626

<dt>function(arg1, arg2, arg3) - function to call when button is clicked.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

The args fed in are the ones given by arg1, arg2, and arg3. 

633

After being called, the menu level is refreshed, so any checks or whatnot are updated.

634

</dd>

635

<dt>Example:</dt>

636

<dd>dewdrop:AddLine( 

637

    'text', "Hello, world!", 

638

    'func', function() 

639

        print("Click!") 

    end 

) 

</dd>

</dl>

</dd>

<dt id="arg123">arg1, arg2, arg3</dt>

<dd>

<dl>

<dt>arg1</dt>

<dd>Value - First value fed into the given func</dd>

650

<dt>arg2</dt>

651

<dd>Value - Second value fed into the given func</dd>

652

<dt>arg3</dt>

653

<dd>Value - Third value fed into the given func</dd>

654

<dt>Remarks:</dt>

655

<dd>

656

You don't need all 3 to work, you may only specify if needed.

657

</dd>

658

<dt>Example:</dt>

659

<dd>dewdrop:AddLine( 

660

    'text', "Hello, world!", 

661

    'func', function(val) 

662

        print("Click! " .. val) 

663

    end, 

664

    'arg1', math.random() 

) 

</dd>

</dl>

</dd>

<dt id="hasColorSwatch">hasColorSwatch</dt>

670

<dd>

671

<dl>

672

<dt>Boolean - whether the button has a color swatch.</dt>

<dd>

</dd>

<dt>Remarks:</dt>

<dd>

If hasColorSwatch is true, then func has no purpose, since clicking opens up a color picker.

679

</dd>

680

<dt>Example:</dt>

681

<dd>dewdrop:AddLine( 

682

    'text', "Hello, world!", 

683

    'hasColorSwatch', true 

) 

</dd>

</dl>

</dd>

<dt id="rgb">r, g, b</dt>

<dd>

<dl>

<dt>r</dt>

<dd>Number - The red value. [0, 1]</dd>

693

<dt>g</dt>

694

<dd>Number - The green value. [0, 1]</dd>

695

<dt>b</dt>

696

<dd>Number - The blue value. [0, 1]</dd>

697

<dt>Remarks:</dt>

698

<dd>

699

Sets the color of the color swatch, and conseqently, the color picker. 

700

This only works if all three colors are set.

701

</dd>

702

<dt>Example:</dt>

703

<dd>dewdrop:AddLine( 

704

    'text', "Hello, world!", 

705

    'hasColorSwatch', true, 

    'r', 1, 

    'g', 1, 

    'b', 1 

) 

</dd>

</dl>

</dd>

<dt id="swatchFunc">swatchFunc</dt>

714

<dd>

715

<dl>

716

<dt>function(r, g, b) - function called when the color changes.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasColorSwatch is true.

721

</dd>

722

<dt>Example:</dt>

723

<dd>dewdrop:AddLine( 

724

    'text', "Hello, world!", 

725

    'hasColorSwatch', true, 

726

    'swatchFunc', function(r, g, b) 

727

        print("New color: " .. r .. "-" .. g .. "-" .. b)

    end 

) 

</dd>

</dl>

</dd>

<dt id="hasOpacity">hasOpacity</dt>

734

<dd>

735

<dl>

736

<dt>Boolean - whether the color picker includes opacity.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasColorSwatch is true.

741

</dd>

742

<dt>Example:</dt>

743

<dd>dewdrop:AddLine( 

744

    'text', "Hello, world!", 

745

    'hasColorSwatch', true, 

746

    'hasOpacity', true 

) 

</dd>

</dl>

</dd>

<dt id="opacityFunc">opacityFunc</dt>

752

<dd>

753

<dl>

754

<dt>function(value) - function called when the opacity changes.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasColorSwatch and hasOpacity are true.

759

</dd>

760

<dt>Example:</dt>

761

<dd>dewdrop:AddLine( 

762

    'text', "Hello, world!", 

763

    'hasColorSwatch', true, 

764

    'hasOpacity', true 

765

    'opacityFunc', function(value) 

766

        print("New alpha: " .. value) 

    end 

) 

</dd>

</dl>

</dd>

<dt id="opacity">opacity</dt>

773

<dd>

774

<dl>

775

<dt>Number - current opacity level. [0, 1]</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasColorSwatch and hasOpacity are true.

780

</dd>

781

<dt>Example:</dt>

782

<dd>dewdrop:AddLine( 

783

    'text', "Hello, world!", 

784

    'hasColorSwatch', true, 

785

    'hasOpacity', true 

786

    'opacity', math.random() 

) 

</dd>

</dl>

</dd>

<dt id="cancelFunc">cancelFunc</dt>

792

<dd>

793

<dl>

794

<dt>function(r, g, b, a) - function called when cancel is pushed. Arguments are the previous values.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasColorSwatch and hasOpacity are true.

799

</dd>

800

<dt>Example:</dt>

801

<dd>dewdrop:AddLine( 

802

    'text', "Hello, world!", 

803

    'hasColorSwatch', true, 

804

    'hasOpacity', true 

    'r', 0, 

    'g', 0.5, 

    'b', 1, 

    'opacity', 1 

    'cancelFunc', function(r, g, b, a) 

810

        assert(r == 0 and g == 0.5 and b == 1 and a == 1)

    end

) 

</dd>

</dl>

</dd>

<dt id="hasArrow">hasArrow</dt>

817

<dd>

818

<dl>

819

<dt>Boolean - whether button has an arrow.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that either value is not nil or hasSlider is true.

824

</dd>

825

<dt>Example:</dt>

826

<dd>dewdrop:AddLine( 

827

    'text', "Hello, world!", 

828

    'hasArrow', true, 

829

    'value', "hello" 

) 

</dd>

</dl>

</dd>

<dt id="value">value</dt>

835

<dd>

836

<dl>

837

<dt>Value - any unique, identifiable value.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasArrow is true. 

842

The same value will be fed in to the initalizer function when the sublevel is opened.

843

</dd>

844

<dt>Example:</dt>

845

<dd>if level == 1 then

846

    dewdrop:AddLine( 

847

        'text', "Hello,", 

848

        'hasArrow', true, 

849

        'value', "hello" 

850

    ) 

851

elseif level == 2 

852

    if value == "hello" then

853

        dewdrop:AddLine( 

854

            'text', "World!" 

        ) 

    end 

end 

</dd>

</dl>

</dd>

<dt id="hasSlider">hasSlider</dt>

862

<dd>

863

<dl>

864

<dt>Boolean - whether the sublevel is a slider.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasArrow is true.

869

</dd>

870

<dt>Example:</dt>

871

<dd>dewdrop:AddLine( 

872

    'text', "Hello, world!", 

873

    'hasArrow', true, 

874

    'hasSlider', true 

) 

</dd>

</dl>

</dd>

<dt id="sliderTop">sliderTop</dt>

880

<dd>

881

<dl>

882

<dt>String - the text representing the high value</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasArrow and hasSlider are true. 

887

If not given, "100%" is assumed.

888

</dd>

889

<dt>Example:</dt>

890

<dd>dewdrop:AddLine( 

891

    'text', "Hello, world!", 

892

    'hasArrow', true, 

893

    'hasSlider', true 

894

    'sliderTop', '100%' 

) 

</dd>

</dl>

</dd>

<dt id="sliderBottom">sliderBottom</dt>

900

<dd>

901

<dl>

902

<dt>String - the text representing the high value</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasArrow and hasSlider are true. 

907

If not given, "0%" is assumed.

908

</dd>

909

<dt>Example:</dt>

910

<dd>dewdrop:AddLine( 

911

    'text', "Hello, world!", 

912

    'hasArrow', true, 

913

    'hasSlider', true 

914

    'sliderBottom', '0%' 

) 

</dd>

</dl>

</dd>

<dt id="sliderValue">sliderValue</dt>

920

<dd>

921

<dl>

922

<dt>Number - the current value of the slider. [0, 1]</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasArrow and hasSlider are true. 

927

If not given, 0.5 is assumed.

928

</dd>

929

<dt>Example:</dt>

930

<dd>dewdrop:AddLine( 

931

    'text', "Hello, world!", 

932

    'hasArrow', true, 

933

    'hasSlider', true 

934

    'sliderValue', 0.5 

) 

</dd>

</dl>

</dd>

<dt id="sliderFunc">sliderFunc</dt>

940

<dd>

941

<dl>

942

<dt>function(value) - function to call when the value changed.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires that hasArrow and hasSlider are true. 

947

If sliderFunc(value) returns a string, then that is used to set the current value string on the slider. 

948

value will always be within [0, 1]. 

949

</dd>

950

<dt>Example:</dt>

951

<dd>dewdrop:AddLine( 

952

    'text', "Hello, world!", 

953

    'hasArrow', true, 

954

    'hasSlider', true 

955

    'sliderFunc', function(value) 

956

        print("New value: " .. value) 

957

        return format("%.0f%%", value) 

    end 

) 

</dd>

</dl>

</dd>

<dt id="textHeight">textHeight</dt>

964

<dd>

965

<dl>

966

<dt>Number - height of the text.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

If not provided, 10 is assumed. 

971

</dd>

972

<dt>Example:</dt>

973

<dd>dewdrop:AddLine( 

974

    'text', "Hello, world!", 

975

    'textHeight', 10 

) 

</dd>

</dl>

</dd>

<dt id="justifyH">justifyH</dt>

981

<dd>

982

<dl>

983

<dt>String - horizontal justification of the text.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Must be either "LEFT", "RIGHT", or "CENTER" 

988

If not provided, "LEFT" is assumed. 

989

</dd>

990

<dt>Example:</dt>

991

<dd>dewdrop:AddLine( 

992

    'text', "Hello, world!", 

993

    'justifyH', "CENTER" 

) 

</dd>

</dl>

</dd>

<dt id="tooltipTitle">tooltipTitle</dt>

999

<dd>

1000

<dl>

1001

<dt>String - title of the newbie tooltip.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

If not provided, the tooltip won't show up. 

1006

</dd>

1007

<dt>Example:</dt>

1008

<dd>dewdrop:AddLine( 

1009

    'text', "Hello, world!", 

1010

    'tooltipTitle', "Hello" 

) 

</dd>

</dl>

</dd>

<dt id="tooltipText">tooltipText</dt>

1016

<dd>

1017

<dl>

1018

<dt>String - text of the newbie tooltip.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

Requires tooltipTitle to be set. 

1023

</dd>

1024

<dt>Example:</dt>

1025

<dd>dewdrop:AddLine( 

1026

    'text', "Hello, world!", 

1027

    'tooltipTitle', "Hello", 

1028

    'tooltipText', "world!" 

) 

</dd>

</dl>

</dd>

<dt id="closeWhenClicked">closeWhenClicked</dt>

1034

<dd>

1035

<dl>

1036

<dt>Boolean - whether to close menu when clicked.</dt>

<dd></dd>

<dt>Remarks:</dt>

<dd>

This closes the whole menu, not just the one level.

1041

</dd>

1042

<dt>Example:</dt>

1043

<dd>dewdrop:AddLine( 

1044

    'text', "Hello, world!", 

1045

    'closeWhenClicked', true 

) 

</dd>

</dl>

</dd>

</dl>

</dd>

</dl>

vanilla-wow-addons – Blame information for rev 1