Git Product home page Git Product logo

menumaker's Introduction

MenuMaker

Menumaker is a library that can be used to create menus for programs. It has an easy to use way of adding entries for menu items and displaying them on the terminal.
This library is currently only supported on Linux

Features

  • Easy to use method along with wizard.
  • Use of arrow keys for navigation and enter for selection.
  • Centered menu listing
  • Terminal resize support
  • Highlighted menu entries.
  • Dynamically updated description for highlighted option
  • Optional return value or default values assignment.

Example Screenshots

Calculator Screenshot

Method

  • Place the files mmaker.h and func.h from the src directory into your working directory.
  • Include the header file "mmaker.h"
    #include "mmaker.h"
  • Make an object of class menu where the menu has to be created.
    Example: menu obj;
  • The name of the menu can be added by the menu_head(string) method.
    Example: obj.menu_head("Menu Name");
  • Add entries to the menu class using the function add(string, int, string). The default values for return value is assigned serial wise and the default description is NULL.
    Example: obj.add("Entry Name", return_value, "Description");
  • The return value and description are optional. Entries can also be added as:
    obj.add("Entry Name", return_value); or obj.add("Entry Name");
  • After adding all the menu entries call the function display, which returns an integer value corresponding to the menu entry number which can then be used to call the appropriate function.
    Example: int x = obj.display();

menumaker's People

Contributors

arnav127 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

menumaker's Issues

Cross Platform Support

Currently the library only works on Linux and there is no support for Windows and MinGW as it uses unix dependent code.
This can be replaced by cross platform code making it compatible with Windows also.

Currently I have thought of two ways:

  • Finding similar functions in Windows libraries and implementing them based on the os it is being used.
  • Generating a binary made uses curses that can be called directly with a file containing the details of the menu it has to display. This will require major changes to the codebase and also changes in the current implementation, so it is being kept as the last option.

Any other ideas are welcome.

No support for Menu name with space

The library does not support entering the menu entries with whitespaces between them., neither their description supports whitespaces. This should be implemented as the these details generally contain whitespaces and without them, the usability of the function is reduced to a great extent.

New Example Programs

New example programs will make it easier to understand and implement the use of the library. New sample programs can be contributed which use the menu library is some way.

  • The program being added should be well documented and easy to understand.
  • Program should be added in a seperate folder on the name of the program placed in the examples/ directory.
  • Adding a Makefile for the program is desired.
  • Adding a screenshot of the program to the images/ folder is desired and including it in the README will be appreciated.

Screen Flickering

Screen Flickering is observed in some terminals when going through the menu, each time the screen refreshes, it causes a flicker.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.