1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.commandparser;
    24  
    25  /**
    26   * An enumeration of the types of popup menu which are supported by the
    27   * PopupManager.
    28   * 
    29   * @author chris
    30   */
         /* 
    P/P   *  Method: void com.dmdirc.commandparser.PopupType(String, int)
          */
    31  public enum PopupType {
    32      
    33      /**
    34       * The menu that appears when right clicking in a channel window.
    35       * 
    36       * Expected arguments: none.
    37       */
             /* 
    P/P       *  Method: com.dmdirc.commandparser.PopupType__static_init
              * 
              *  Postconditions:
              *    $VALUES == &new PopupType[](PopupType__static_init#13)
              *    CHAN_CHANNEL == &new PopupType(PopupType__static_init#3)
              *    $VALUES[2] == &new PopupType(PopupType__static_init#3)
              *    CHAN_HYPERLINK == &new PopupType(PopupType__static_init#4)
              *    $VALUES[3] == &new PopupType(PopupType__static_init#4)
              *    CHAN_NICK == &new PopupType(PopupType__static_init#2)
              *    $VALUES[1] == &new PopupType(PopupType__static_init#2)
              *    CHAN_NORMAL == &new PopupType(PopupType__static_init#1)
              *    $VALUES[0] == &new PopupType(PopupType__static_init#1)
              *    QUERY_CHANNEL == &new PopupType(PopupType__static_init#7)
              *    ...
              */
    38      CHAN_NORMAL,
    39      
    40      /**
    41       * The menu that appears when right clicking in a nickname in a channel window.
    42       * 
    43       * Expected arguments: the nickname of the user who was clicked on.
    44       */
    45      CHAN_NICK,
    46      
    47      /**
    48       * The menu that appears when right clicking in a channel in a channel window.
    49       * 
    50       * Expected arguments: the nickname of the user who was clicked on.
    51       */
    52      CHAN_CHANNEL,
    53      
    54      /**
    55       * The menu that appears when right clicking in a hyperlink in a channel window.
    56       * 
    57       * Expected arguments: the hyperlink clicked.
    58       */
    59      CHAN_HYPERLINK,
    60      
    61      /**
    62       * The menu that appears when right clicking in a query window.
    63       * 
    64       * Expected arguments: the nickname of the user who the query is with.
    65       */
    66      QUERY_NORMAL,
    67      
    68      /**
    69       * The menu that appears when right clicking in a nickname in a query window.
    70       * 
    71       * Expected arguments: the nickname of the user who the query is with.
    72       */
    73      QUERY_NICK,
    74      
    75      /**
    76       * The menu that appears when right clicking in a channel in a query window.
    77       * 
    78       * Expected arguments: the nickname of the user who the query is with.
    79       */
    80      QUERY_CHANNEL,
    81      
    82      /**
    83       * The menu that appears when right clicking in a hyperlink in a query window.
    84       * 
    85       * Expected arguments: the hyperlink clicked.
    86       */
    87      QUERY_HYPERLINK,
    88      
    89      /**
    90       * The menu that appears when right clicking in a server window.
    91       * 
    92       * Expected arguments: the nickname of the user who the query is with.
    93       */
    94      SERVER_NORMAL,
    95      
    96      /**
    97       * The menu that appears when right clicking in a nickname in a server window.
    98       * 
    99       * Expected arguments: the nickname of the user who the query is with.
   100       */
   101      SERVER_NICK,
   102      
   103      /**
   104       * The menu that appears when right clicking in a channel in a server window.
   105       * 
   106       * Expected arguments: the nickname of the user who the query is with.
   107       */
   108      SERVER_CHANNEL,
   109      
   110      /**
   111       * The menu that appears when right clicking in a hyperlink in a server window.
   112       * 
   113       * Expected arguments: the hyperlink clicked.
   114       */
   115      SERVER_HYPERLINK;
   116         
   117  }