/usr/share/GNUstep/Documentation/Developer/Gui/Reference/NSMenuView.html is in gnustep-gui-doc 0.25.0-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>NSMenuView</title>
</head>
<body>
<font face="serif">
<a href="Gui.html">Up</a>
<br />
<h1><a name="title$NSMenuView">NSMenuView</a></h1>
<h3>Authors</h3>
<dl>
<dt>Fred Kiefer (<a href="mailto:FredKiefer@gmx.de"><code>FredKiefer@gmx.de</code></a>)</dt>
<dd>
</dd>
<dt>David Lazaro Saz (<a href="mailto:khelekir@encomix.es"><code>khelekir@encomix.es</code></a>)</dt>
<dd>
</dd>
<dt>Michael Hanni (<a href="mailto:mhanni@sprintmail.com"><code>mhanni@sprintmail.com</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 1999 Free Software Foundation, Inc.</p>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the NSMenuView class
</a></h1>
<h2><a name="class$NSMenuView">NSMenuView</a> : <a rel="gsdoc" href="NSView.html#class$NSView">NSView</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>AppKit/NSMenuView.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd>NSCoding</dd>
<dd><a rel="gsdoc" href="NSMenu.html#protocol$(NSMenuView)">NSMenuView</a></dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
The NSMenu class uses an object implementing the
NSMenuView protocol to do the actual drawing.
<br /> <br /> Normally there is no good reason to
write your own class implementing this protocol.
However if you want to customize your menus you
should implement this protocol to ensure that it works
nicely together with sub/super menus not using your
custom menu representation. <br /> <br />
<strong>How menus are drawn</strong> <br /> <br />
This class implements several menu look and feels at the
same time. The looks and feels implemented are:
<ul>
<li>
Ordinary vertically stacked menus with the NeXT
submenu positioning behavour.
</li>
<li>
Vertically stacked menus with the WindowMaker
submenu placement. This behaviour is selected by
choosing the
<strong>GSWindowMakerInterfaceStyle</strong>.
</li>
<li>
PopupButtons are actually menus. This class
implements also the behaviour for the
NSPopButtons. See for the the class
NSPopButton.
</li>
</ul>
</div>
<hr width="50%" align="left" />
<a href="#_NSMenuView_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView+menuBarHeight">+menuBarHeight</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-attachSubmenuForItemAtIndex$">-attachSubmenuForItemAtIndex:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-attachedMenu">-attachedMenu</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-attachedMenuView">-attachedMenuView</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-detachSubmenu">-detachSubmenu</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-font">-font</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-highlightedItemIndex">-highlightedItemIndex</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-horizontalEdgePadding">-horizontalEdgePadding</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-imageAndTitleOffset">-imageAndTitleOffset</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-imageAndTitleWidth">-imageAndTitleWidth</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-indexOfItemAtPoint$">-indexOfItemAtPoint:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-initAsTearOff">-initAsTearOff</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-innerRect">-innerRect</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-isAttached">-isAttached</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-isHorizontal">-isHorizontal</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-isTornOff">-isTornOff</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-itemAdded$">-itemAdded:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-itemChanged$">-itemChanged:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-itemRemoved$">-itemRemoved:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-keyEquivalentOffset">-keyEquivalentOffset</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-keyEquivalentWidth">-keyEquivalentWidth</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-locationForSubmenu$">-locationForSubmenu:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-menu">-menu</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-menuItemCellForItemAtIndex$">-menuItemCellForItemAtIndex:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-needsSizing">-needsSizing</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-performActionWithHighlightingForItemAtIndex$">-performActionWithHighlightingForItemAtIndex:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-rectOfItemAtIndex$">-rectOfItemAtIndex:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-setFont$">-setFont:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-setHighlightedItemIndex$">-setHighlightedItemIndex:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-setHorizontal$">-setHorizontal:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-setHorizontalEdgePadding$">-setHorizontalEdgePadding:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-setMenu$">-setMenu:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-setMenuItemCell$forItemAtIndex$">-setMenuItemCell:forItemAtIndex:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-setNeedsDisplayForItemAtIndex$">-setNeedsDisplayForItemAtIndex:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-setNeedsSizing$">-setNeedsSizing:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-setWindowFrameForAttachingToRect$onScreen$preferredEdge$popUpSelectedItem$">-setWindowFrameForAttachingToRect:onScreen:preferredEdge:popUpSelectedItem:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-sizeToFit">-sizeToFit</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-stateImageOffset">-stateImageOffset</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-stateImageWidth">-stateImageWidth</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-trackWithEvent$">-trackWithEvent:</a></li>
<li><a rel="gsdoc" href="NSMenuView.html#method$NSMenuView-update">-update</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSMenuView+menuBarHeight">menuBarHeight </a></h3>
+ (float) <b>menuBarHeight</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the height of the menu bar.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-attachSubmenuForItemAtIndex$">attachSubmenuForItemAtIndex: </a></h3>
- (void) <b>attachSubmenuForItemAtIndex:</b> (NSInteger)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Attach submenu if the item at <var>index</var> is a
submenu. It will figure out if the new submenu
should be transient or not.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-attachedMenu">attachedMenu </a></h3>
- (<a rel="gsdoc" href="NSMenu.html#class$NSMenu">NSMenu</a>*) <b>attachedMenu</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns visible attached submenu.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-attachedMenuView">attachedMenuView </a></h3>
- (<a rel="gsdoc" href="#class$NSMenuView">NSMenuView</a>*) <b>attachedMenuView</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns menu view associated with visible attached
submenu.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-detachSubmenu">detachSubmenu </a></h3>
- (void) <b>detachSubmenu</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Detaches currently visible submenu window from
main menu.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-font">font </a></h3>
- (<a rel="gsdoc" href="NSFont.html#class$NSFont">NSFont</a>*) <b>font</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the default font used to draw the menu
text.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-highlightedItemIndex">highlightedItemIndex </a></h3>
- (NSInteger) <b>highlightedItemIndex</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the index of the highlighted item. Returns
-1 if there is no highlighted item.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-horizontalEdgePadding">horizontalEdgePadding </a></h3>
- (float) <b>horizontalEdgePadding</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns horizontal space used for padding between
menu item elements (state image, title image, title,
key equivalent, submenu arrow image).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-imageAndTitleOffset">imageAndTitleOffset </a></h3>
- (float) <b>imageAndTitleOffset</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the starting horizontal position for
drawing the image and title.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-imageAndTitleWidth">imageAndTitleWidth </a></h3>
- (float) <b>imageAndTitleWidth</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the width of the image and title section.
Tis section contains image and text of menu item.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-indexOfItemAtPoint$">indexOfItemAtPoint: </a></h3>
- (NSInteger) <b>indexOfItemAtPoint:</b> (NSPoint)point;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the index of the item below
<var>point</var>. Returns -1 if mouse is not above a
menu item.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-initAsTearOff">initAsTearOff </a></h3>
- (id) <b>initAsTearOff</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Creates new instance and sets menu to torn off
state with NSMenu's setTornOff:.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-innerRect">innerRect </a></h3>
- (NSRect) <b>innerRect</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns bounds rectangle of the menu view. It is
smaller by 1 pixel in width than menu window (dark
gray border at left).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-isAttached">isAttached </a></h3>
- (BOOL) <b>isAttached</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns <code>YES</code>, if this object is an
visivle attached submenu's view. Returns
<code>NO</code> otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-isHorizontal">isHorizontal </a></h3>
- (BOOL) <b>isHorizontal</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns <code>YES</code> if menu items are
displayed horizontally, <code>NO</code> if
vertically.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-isTornOff">isTornOff </a></h3>
- (BOOL) <b>isTornOff</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns <code>YES</code>, if this object is
associated with torn off menu (menu with a close
button on title bar).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-itemAdded$">itemAdded: </a></h3>
- (void) <b>itemAdded:</b> (NSNotification*)notification;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Creates new item cell for the newly created menu
item, marks cell and menu view as needing to be
resized. This method is invoked when
NSMenuDidAddItemNotification
received. The <var>notification</var> parameter
contains index of changed menu item and can be
accessed with NSMenuItemIndex key.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-itemChanged$">itemChanged: </a></h3>
- (void) <b>itemChanged:</b> (NSNotification*)notification;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Marks menu item cell associated with the menu item
and menu view as needing to be resized. This method is
invoked when NSMenuDidChangeItemNotification
received. The <var>notification</var> parameter
contains index of changed menu item and can be
accessed with NSMenuItemIndex key.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-itemRemoved$">itemRemoved: </a></h3>
- (void) <b>itemRemoved:</b> (NSNotification*)notification;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes cell associated with removed menu item,
removes highlighting if removed menu item was
highlighted, marks cell and menu view as
needing to be resized. This method is invoked when
NSMenuDidRemoveItemNotification
received. The <var>notification</var> parameter
contains index of changed menu item and can be
accessed with NSMenuItemIndex key.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-keyEquivalentOffset">keyEquivalentOffset </a></h3>
- (float) <b>keyEquivalentOffset</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the starting position for drawing the key
equivalent. Key equivalent can be submenu arrow
if menu item has submenu.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-keyEquivalentWidth">keyEquivalentWidth </a></h3>
- (float) <b>keyEquivalentWidth</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the width of key equivalent text. Key
equivalent can be submenu arrow if menu item has
submenu
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-locationForSubmenu$">locationForSubmenu: </a></h3>
- (NSPoint) <b>locationForSubmenu:</b> (<a rel="gsdoc" href="NSMenu.html#class$NSMenu">NSMenu</a>*)aSubmenu;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the correct frame origin for
<var>aSubmenu</var> based on the location of the
receiver. This location may depend on the current
NSInterfaceStyle.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-menu">menu </a></h3>
- (<a rel="gsdoc" href="NSMenu.html#class$NSMenu">NSMenu</a>*) <b>menu</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the NSMenu associated with this menu view.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-menuItemCellForItemAtIndex$">menuItemCellForItemAtIndex: </a></h3>
- (<a rel="gsdoc" href="NSMenuItemCell.html#class$NSMenuItemCell">NSMenuItemCell</a>*) <b>menuItemCellForItemAtIndex:</b> (NSInteger)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns cell associated with item at
<var>index</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-needsSizing">needsSizing </a></h3>
- (BOOL) <b>needsSizing</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Return <code>YES</code> if menu view contents
changed and needs to be resized.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-performActionWithHighlightingForItemAtIndex$">performActionWithHighlightingForItemAtIndex: </a></h3>
- (void) <b>performActionWithHighlightingForItemAtIndex:</b> (NSInteger)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-rectOfItemAtIndex$">rectOfItemAtIndex: </a></h3>
- (NSRect) <b>rectOfItemAtIndex:</b> (NSInteger)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns frame rectangle of menu item cell. It is
smaller by 1 pixel in width than menu window (dark
gray border).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-setFont$">setFont: </a></h3>
- (void) <b>setFont:</b> (<a rel="gsdoc" href="NSFont.html#class$NSFont">NSFont</a>*)font;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sets the default <var>font</var> to use when drawing
the menu text.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-setHighlightedItemIndex$">setHighlightedItemIndex: </a></h3>
- (void) <b>setHighlightedItemIndex:</b> (NSInteger)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Highlights item with at <var>index</var>. If
<var>index</var> is -1 all highlighing is removed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-setHorizontal$">setHorizontal: </a></h3>
- (void) <b>setHorizontal:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sets menu orientation. If <code>YES</code> menu items
are displayed from left to right, if <code>NO</code>
from top to bottom (vertically). By default, menu
items are displayed vertically.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-setHorizontalEdgePadding$">setHorizontalEdgePadding: </a></h3>
- (void) <b>setHorizontalEdgePadding:</b> (float)pad;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sets amount of pixels added between menu item elements
to <var>pad</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-setMenu$">setMenu: </a></h3>
- (void) <b>setMenu:</b> (<a rel="gsdoc" href="NSMenu.html#class$NSMenu">NSMenu</a>*)menu;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sets the <var>menu</var> to be displayed in to
<var>menu</var>. Also this method adds this
<var>menu</var> view to the menu's list of observers,
mark view to force recalculation of layout with
setNeedsSizing:YES, and updates itself
with update method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-setMenuItemCell$forItemAtIndex$">setMenuItemCell: forItemAtIndex: </a></h3>
- (void) <b>setMenuItemCell:</b> (<a rel="gsdoc" href="NSMenuItemCell.html#class$NSMenuItemCell">NSMenuItemCell</a>*)cell<b> forItemAtIndex:</b> (NSInteger)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Replaces item <var>cell</var> at <var>index</var>
with <var>cell</var>. Highlighting of item is
preserved.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-setNeedsDisplayForItemAtIndex$">setNeedsDisplayForItemAtIndex: </a></h3>
- (void) <b>setNeedsDisplayForItemAtIndex:</b> (NSInteger)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Calls setNeedsDisplayInRect: for rectangle occupied
by item at <var>index</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-setNeedsSizing$">setNeedsSizing: </a></h3>
- (void) <b>setNeedsSizing:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sets the <var>flag</var> whether layout needs to be
resized. Set it to <code>YES</code> if menu
contents changed and layout needs to be
recalculated. This method is used internally.
Yout should not invoke it directly from applications.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-setWindowFrameForAttachingToRect$onScreen$preferredEdge$popUpSelectedItem$">setWindowFrameForAttachingToRect: onScreen: preferredEdge: popUpSelectedItem: </a></h3>
- (void) <b>setWindowFrameForAttachingToRect:</b> (NSRect)screenRect<b> onScreen:</b> (<a rel="gsdoc" href="NSScreen.html#class$NSScreen">NSScreen</a>*)screen<b> preferredEdge:</b> (NSRectEdge)edge<b> popUpSelectedItem:</b> (NSInteger)selectedItemIndex;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Resize menu view frame to be appropriate in size to
attach to <var>screenRect</var> at preferredEdge.
For popup's menu, if <var>selectedItemIndex</var> is
other than -1, position view so selected item covers
the NSPopUpButton. <br />
<strong>
NOTE: preffered <var>edge</var> positioning doesn't
implemented yet!
</strong>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-sizeToFit">sizeToFit </a></h3>
- (void) <b>sizeToFit</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-stateImageOffset">stateImageOffset </a></h3>
- (float) <b>stateImageOffset</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the starting horizontal position for
drawing the state image.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-stateImageWidth">stateImageWidth </a></h3>
- (float) <b>stateImageWidth</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the width of the state image.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-trackWithEvent$">trackWithEvent: </a></h3>
- (BOOL) <b>trackWithEvent:</b> (<a rel="gsdoc" href="NSEvent.html#class$NSEvent">NSEvent</a>*)event;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
This method is responsible for tracking the mouse
while this menu is on the screen and the user is busy
navigating the menu or one of it submenus.
Responsible does not mean that this method does
it all. For submenus for example it will call,
indirectly, itself for submenu under
consideration. It will return
<code>YES</code> if user released mouse, not above a
submenu item. <code>NO</code> in all other
circumstances. Implementation detail:
<ul>
<li>
It use periodic events to update the highlight state
and attach / detach submenus.
</li>
<li>
The flag justAttachedNewSubmenu is set to
<code>YES</code> when a new submenu is attached.
The effect is that the highlighting / attaching /
detaching is supressed for this menu. This is
done so the user is given a change to move the
mouse pointer into the newly attached submenu.
Otherwise it would immediately be removed as
the mouse pointer move over another item. The logic
for resetting the flag is rather adhoc.
</li>
<li>
the flag subMenusNeedRemoving means that we will
remove all the submenus after we are done. This
flag is used to clean up the submenus when the
user has opened a submenu by clicking and wants to
close it again by clicking on the hihglighted
item.
</li>
<li>
When the user released the mouse this method will
cleanup all the transient menus. Not only its
own, but also its attached menu and all its
transient super menus.
</li>
<li>
The clean up is done BEFORE the action is executed.
This is needed otherwise `hiding' the application
leaves a dangling menu. If this is not
acceptable, there should be another
mechanism of handling the hiding. BTW besides
the `hiding' the application, model panels are also
a problem when the menu is not cleared before
executing the action.
</li>
</ul>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMenuView-update">update </a></h3>
- (void) <b>update</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Adds title view for application menu and submenus,
removes title view if menu is owned by
NSPopUpButton, adds close button to title
view for torn off menus and removes it for other type
of menu.
</div>
<hr width="25%" align="left" />
</div>
<a name="_NSMenuView_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for NSMenuView Class</h2>
<h3><a name="ivariable$NSMenuView*_cellSize">_cellSize</a></h3>
@protected NSSize <b>_cellSize</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_font">_font</a></h3>
@protected NSFont* <b>_font</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_highlightedItemIndex">_highlightedItemIndex</a></h3>
@protected int <b>_highlightedItemIndex</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_horizontal">_horizontal</a></h3>
@protected BOOL <b>_horizontal</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_horizontalEdgePad">_horizontalEdgePad</a></h3>
@protected float <b>_horizontalEdgePad</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_imageAndTitleOffset">_imageAndTitleOffset</a></h3>
@protected float <b>_imageAndTitleOffset</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_imageAndTitleWidth">_imageAndTitleWidth</a></h3>
@protected float <b>_imageAndTitleWidth</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_itemCells">_itemCells</a></h3>
@protected NSMutableArray* <b>_itemCells</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_keyEqOffset">_keyEqOffset</a></h3>
@protected float <b>_keyEqOffset</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_keyEqWidth">_keyEqWidth</a></h3>
@protected float <b>_keyEqWidth</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_needsSizing">_needsSizing</a></h3>
@protected BOOL <b>_needsSizing</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_pad1">_pad1</a></h3>
@protected char <b>_pad1</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_pad2">_pad2</a></h3>
@protected char <b>_pad2</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_stateImageOffset">_stateImageOffset</a></h3>
@protected float <b>_stateImageOffset</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSMenuView*_stateImageWidth">_stateImageWidth</a></h3>
@protected float <b>_stateImageWidth</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<br />
<a href="Gui.html">Up</a>
</font>
</body>
</html>
|