/* 
    P/P   *  Method: com.dmdirc.ui.interfaces.MainWindow__static_init
          */
     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.ui.interfaces;
    24  
    25  import javax.swing.ImageIcon;
    26  
    27  /**
    28   * Main window interface.
    29   */
    30  public interface MainWindow {
    31          
    32      /**
    33       * Retrieves the application icon.
    34       *
    35       * @return The application icon
    36       */
    37      ImageIcon getIcon();
    38      
    39      /**
    40       * Quits the client.
    41       */
    42      void quit();
    43      
    44      /**
    45       * Sets whether or not the internal frame state is currently maximised.
    46       * 
    47       * @param max whether the frame is maxomised
    48       */
    49      void setMaximised(final boolean max);
    50      
    51      /**
    52       * Gets whether or not the internal frame state is currently maximised.
    53       * 
    54       * @return True iff frames should be maximised, false otherwise
    55       */
    56      boolean getMaximised();
    57      
    58      /**
    59       * Returns a prefix for use in the titlebar. Includes the version number
    60       * if the config option is set.
    61       * 
    62       * @return Titlebar prefix
    63       */
    64      String getTitlePrefix();
    65      
    66      /**
    67       * Shows or hides the main window.
    68       *
    69       * @param visible The new visibility of the main window
    70       */
    71      void setVisible(final boolean visible);
    72      
    73      /**
    74       * Returns whether the window is visible.
    75       *
    76       * @return Whether the main window is visible
    77       */
    78      boolean isVisible();
    79      
    80  }